| com.sun.rave.web.ui.component.LabelBase
All known Subclasses: com.sun.rave.web.ui.component.Label,
| LabelBase | | abstract public class LabelBase extends javax.faces.component.UIOutput (Code) | | Use the ui:label
tag to display a label for a component. To specify which component
the label belongs to you can do one of the following:
- Place the component to be labeled in the body of
ui:label; or
- Set the value of the
for attribute of ui:label to the id of the component to be labeled.
If the tags are adjacent on the page, it is simpler to place the
component in the body of the ui:label tag.
Note that many components in this library have label
and labelLevel attributes (and sometimes
labelOnTop) which can be used instead of ui:label. The main reason
to use ui:label is to specify the
appearance of the label beyond what these attributes permit.
HTML Elements and Layout
The ui:label tag results in a HTML <label>
or <span> element. A <span>
element is rendered if no labeled component is found.
If the tag has a body, the body must consist of tags for
JavaServer Faces components only. The components become children
of the Label component, and are rendered after the
<label> element.
If the tag has a body but no for attribute, a
<label> element is rendered. Its
for attribute is set to the element ID of the first
child component that is an EditableValueHolder.
Theme Identifiers
The Label renderer relies on the following theme classes:
LblLev1Txt
LblLev2Txt
LblLev3Txt
LblRqdDiv
Client Side Javascript Functions
None.
Example
Example 1: ui:label with for attribute
<ui:label id="label1" text="Label 1:" for="field1" labelLevel="2"/>
<ui:field id="field1" text="#{Bean.value}" type="text" trim="true"/>
Example 2: ui:label with labeled component in tag body
<ui:label id="label2" text="Label 2:" labelLevel="2"/>
<ui:field id="field2" text="#{Bean.value}" type="text"
trim="true"/>
</ui:label>
Example 3: Using the label attribute instead of ui:label
<ui:field id="field3" text="#{Bean.value}" type="text"
trim="true" label="Label 3:" labelLevel="2"/>
Auto-generated component class.
Do NOT modify; all changes
will be lost!
|
| Method Summary | |
| public String | getFamily()
Return the identifier of the component family to which this
component belongs. | | public String | getFor()
Use this attribute to specify the labeled component. | | public int | getLabelLevel()
Style level for this label, where lower values typically specify
progressively larger font sizes, and/or bolder font weights.
Valid values are 1, 2, and 3. | | public String | getOnClick()
| | public String | getOnMouseDown()
| | public String | getOnMouseMove()
| | public String | getOnMouseOut()
| | public String | getOnMouseOver()
| | public String | getOnMouseUp()
| | public String | getStyle()
| | public String | getStyleClass()
| | public Object | getText()
The label text to be displayed for this label. | | public String | getToolTip()
| | public ValueBinding | getValueBinding(String name)
| | public boolean | isHideIndicators()
Use the hideIndicators attribute to prevent display of the
required and invalid icons with the label. | | public boolean | isRequiredIndicator()
Flag indicating that the labeled component should be marked as
required. | | public boolean | isVisible()
Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. | | public void | restoreState(FacesContext _context, Object _state)
| | public Object | saveState(FacesContext _context)
| | public void | setFor(String _for)
Use this attribute to specify the labeled component. | | public void | setHideIndicators(boolean hideIndicators)
Use the hideIndicators attribute to prevent display of the
required and invalid icons with the label. | | public void | setLabelLevel(int labelLevel)
Style level for this label, where lower values typically specify
progressively larger font sizes, and/or bolder font weights.
Valid values are 1, 2, and 3. | | public void | setOnClick(String onClick)
| | public void | setOnMouseDown(String onMouseDown)
| | public void | setOnMouseMove(String onMouseMove)
| | public void | setOnMouseOut(String onMouseOut)
| | public void | setOnMouseOver(String onMouseOver)
| | public void | setOnMouseUp(String onMouseUp)
| | public void | setRequiredIndicator(boolean requiredIndicator)
Flag indicating that the labeled component should be marked as
required. | | public void | setStyle(String style)
| | public void | setStyleClass(String styleClass)
| | public void | setText(Object text)
The label text to be displayed for this label. | | public void | setToolTip(String toolTip)
| | public void | setValueBinding(String name, ValueBinding binding)
| | public void | setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. |
| LabelBase | | public LabelBase()(Code) | | Construct a new LabelBase.
|
| getFamily | | public String getFamily()(Code) | | Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate
Renderer for this component instance.
|
| getFor | | public String getFor()(Code) | | Use this attribute to specify the labeled component. The
attribute is only relevant if the component to be labeled is not
a child of the ui:label tag. The value of the
attribute should be the id of the component relative to the
label, not the DOM ID of the rendered HTML element.
|
| getLabelLevel | | public int getLabelLevel()(Code) | | Style level for this label, where lower values typically specify
progressively larger font sizes, and/or bolder font weights.
Valid values are 1, 2, and 3. The default label level is 2. Any label
level outside this range will result in no label level being added.
|
| getOnClick | | public String getOnClick()(Code) | | Scripting code executed when a mouse click
occurs over this component.
|
| getOnMouseDown | | public String getOnMouseDown()(Code) | | Scripting code executed when the user presses a mouse button while the
mouse pointer is on the component.
|
| getOnMouseMove | | public String getOnMouseMove()(Code) | | Scripting code executed when the user moves the mouse pointer while
over the component.
|
| getOnMouseOut | | public String getOnMouseOut()(Code) | | Scripting code executed when a mouse out movement
occurs over this component.
|
| getOnMouseOver | | public String getOnMouseOver()(Code) | | Scripting code executed when the user moves the mouse pointer into
the boundary of this component.
|
| getOnMouseUp | | public String getOnMouseUp()(Code) | | Scripting code executed when the user releases a mouse button while
the mouse pointer is on the component.
|
| getStyle | | public String getStyle()(Code) | | CSS style(s) to be applied when this component is rendered.
|
| getStyleClass | | public String getStyleClass()(Code) | | CSS style class(es) to be applied when this component is rendered.
|
| getText | | public Object getText()(Code) | | The label text to be displayed for this label. This attribute
can be set to a literal string, to a value binding expression
that corresponds to a property of a managed bean, or to a value
binding expression that corresponds to a message from a resource
bundle declared using f:loadBundle.
|
| getToolTip | | public String getToolTip()(Code) | | Display the text as a tooltip for this component
|
| getValueBinding | | public ValueBinding getValueBinding(String name)(Code) | | Return the ValueBinding stored for the
specified name (if any), respecting any property aliases.
Parameters:
name - Name of value binding to retrieve |
| isHideIndicators | | public boolean isHideIndicators()(Code) | | Use the hideIndicators attribute to prevent display of the
required and invalid icons with the label. When the required
attribute on the component to be labeled is set to true, the
required icon is displayed next to the label. If the user
submits the page with an invalid value for the component, the
invalid icon is displayed. This attribute is useful when the
component has more than one label, and only one label should
show the icons.
|
| isRequiredIndicator | | public boolean isRequiredIndicator()(Code) | | Flag indicating that the labeled component should be marked as
required. It is only relevant if the labeled component is not
a child of the label tag. Set this flag to ensure that the
required icon shows up the first time the page is rendered.
|
| isVisible | | public boolean isVisible()(Code) | | Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. If set to false, the
HTML code for the component is present in the page, but the component
is hidden with style attributes. By default, visible is set to true, so
HTML for the component HTML is included and visible to the user. If the
component is not visible, it can still be processed on subsequent form
submissions because the HTML is present.
|
| restoreState | | public void restoreState(FacesContext _context, Object _state)(Code) | | Restore the state of this component.
|
| saveState | | public Object saveState(FacesContext _context)(Code) | | Save the state of this component.
|
| setFor | | public void setFor(String _for)(Code) | | Use this attribute to specify the labeled component. The
attribute is only relevant if the component to be labeled is not
a child of the ui:label tag. The value of the
attribute should be the id of the component relative to the
label, not the DOM ID of the rendered HTML element.
See Also: LabelBase.getFor() |
| setHideIndicators | | public void setHideIndicators(boolean hideIndicators)(Code) | | Use the hideIndicators attribute to prevent display of the
required and invalid icons with the label. When the required
attribute on the component to be labeled is set to true, the
required icon is displayed next to the label. If the user
submits the page with an invalid value for the component, the
invalid icon is displayed. This attribute is useful when the
component has more than one label, and only one label should
show the icons.
See Also: LabelBase.isHideIndicators() |
| setLabelLevel | | public void setLabelLevel(int labelLevel)(Code) | | Style level for this label, where lower values typically specify
progressively larger font sizes, and/or bolder font weights.
Valid values are 1, 2, and 3. The default label level is 2. Any label
level outside this range will result in no label level being added.
See Also: LabelBase.getLabelLevel() |
| setOnMouseDown | | public void setOnMouseDown(String onMouseDown)(Code) | | Scripting code executed when the user presses a mouse button while the
mouse pointer is on the component.
See Also: LabelBase.getOnMouseDown() |
| setOnMouseMove | | public void setOnMouseMove(String onMouseMove)(Code) | | Scripting code executed when the user moves the mouse pointer while
over the component.
See Also: LabelBase.getOnMouseMove() |
| setOnMouseOver | | public void setOnMouseOver(String onMouseOver)(Code) | | Scripting code executed when the user moves the mouse pointer into
the boundary of this component.
See Also: LabelBase.getOnMouseOver() |
| setOnMouseUp | | public void setOnMouseUp(String onMouseUp)(Code) | | Scripting code executed when the user releases a mouse button while
the mouse pointer is on the component.
See Also: LabelBase.getOnMouseUp() |
| setRequiredIndicator | | public void setRequiredIndicator(boolean requiredIndicator)(Code) | | Flag indicating that the labeled component should be marked as
required. It is only relevant if the labeled component is not
a child of the label tag. Set this flag to ensure that the
required icon shows up the first time the page is rendered.
See Also: LabelBase.isRequiredIndicator() |
| setText | | public void setText(Object text)(Code) | | The label text to be displayed for this label. This attribute
can be set to a literal string, to a value binding expression
that corresponds to a property of a managed bean, or to a value
binding expression that corresponds to a message from a resource
bundle declared using f:loadBundle.
See Also: LabelBase.getText() |
| setValueBinding | | public void setValueBinding(String name, ValueBinding binding)(Code) | | Set the ValueBinding stored for the
specified name (if any), respecting any property
aliases.
Parameters:
name - Name of value binding to set
Parameters:
binding - ValueBinding to set, or null to remove |
| setVisible | | public void setVisible(boolean visible)(Code) | | Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. If set to false, the
HTML code for the component is present in the page, but the component
is hidden with style attributes. By default, visible is set to true, so
HTML for the component HTML is included and visible to the user. If the
component is not visible, it can still be processed on subsequent form
submissions because the HTML is present.
See Also: LabelBase.isVisible() |
|
|