Class Label

  • All Implemented Interfaces:
    Serializable, org.apache.click.Stateful, org.openidentityplatform.openam.click.Control

    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> 
    See Also:
    Serialized Form
    • 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 org.openidentityplatform.openam.click.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 org.openidentityplatform.openam.click.Control
        Overrides:
        render in class AbstractControl
        Parameters:
        buffer - the specified buffer to render the control's output to
        See Also:
        toString()