net.sf.click.control
Class Label

java.lang.Object
  extended bynet.sf.click.control.AbstractControl
      extended bynet.sf.click.control.Field
          extended bynet.sf.click.control.Label
All Implemented Interfaces:
Control, Serializable

public class Label
extends Field

Provides a Label display control. The Label control performs no server side processing, and is used primarily to add descriptive labels or horizontal rules to auto rendered forms.

Label Example

A Label example:
 Form form = new Form("form");
 ..

 form.add(new Label("hr", "<hr/>")); 
HTML output:
 <tr><td colspan='2' align='left'><hr/></td></tr> 

Author:
Malcolm Edgar
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.click.control.Field
disabled, error, focus, form, help, label, readonly, required, tabindex, title, validate, value
 
Fields inherited from class net.sf.click.control.AbstractControl
actionListener, attributes, listener, listenerMethod, messages, name, parent, styles
 
Fields inherited from interface net.sf.click.Control
CONTROL_MESSAGES
 
Constructor Summary
Label()
          Create a Label with no label/name defined.
Label(String name)
          Create a Label display control.
Label(String name, String label)
          Create a Label display control with the given name and label.
 
Method Summary
 boolean onProcess()
          Returns true.
 void render(HtmlStringBuffer buffer)
          Render a label.
 String toString()
          Returns the label.
 
Methods inherited from class net.sf.click.control.Field
bindRequestValue, getError, getErrorLabel, getFocus, getFocusJavaScript, getForm, getHelp, getId, getLabel, getRequestValue, getTabIndex, getTextAlign, getTitle, getValidate, getValidationJavaScript, getValue, getValueObject, getWidth, isDisabled, isHidden, isReadonly, isRequired, isValid, onInit, setDisabled, setError, setErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setFocus, setForm, setHelp, setLabel, setListener, setParent, setReadonly, setRequired, setTabIndex, setTextAlign, setTitle, setValidate, setValue, setValueObject, setWidth, validate
 
Methods inherited from class net.sf.click.control.AbstractControl
addStyleClass, appendAttributes, getActionListener, getAttribute, getAttributes, getContext, getControlSizeEst, getHtmlImports, getMessage, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, getTag, hasAttribute, hasAttributes, hasStyles, onDeploy, onDestroy, onRender, registerActionEvent, removeStyleClass, renderTagBegin, renderTagEnd, setActionListener, setAttribute, setId, setName, setStyle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Label

public Label(String name)
Create a Label display control.

Note the Label control will attempt to find a localized label message in the parent messages, and if not found then in the field messages using the key name of getName() + ".label".

If a value cannot be found in the parent or control messages then the Field name will be converted into a label using the ClickUtils.toLabel(String) method.

Parameters:
name - the name of the Field

Label

public Label(String name,
             String label)
Create a Label display control with the given name and label.

Parameters:
name - the name of the Field
label - the display label caption

Label

public Label()
Create a Label with no label/name defined.

Please note the control's name must be defined before it is valid.

Method Detail

onProcess

public boolean onProcess()
Returns true.

Specified by:
onProcess in interface Control
Overrides:
onProcess in class Field
Returns:
true to continue Page event processing or false otherwise
See Also:
Field.onProcess()

render

public void render(HtmlStringBuffer buffer)
Render a label.

Specified by:
render in interface Control
Overrides:
render in class AbstractControl
Parameters:
buffer - the specified buffer to render the control's output to
See Also:
toString()

toString

public String toString()
Returns the label.

Overrides:
toString in class AbstractControl
Returns:
the label string value
See Also:
Object.toString()