| com.sun.rave.web.ui.component.LegendBase
All known Subclasses: com.sun.rave.web.ui.component.Legend,
| LegendBase | | abstract public class LegendBase extends javax.faces.component.UIOutput (Code) | | Use the ui:legend
tag to display legend, typically at the top of a page.
The legend tag has one facet:
legendImage - this allows the developer to place their own image and/or text in the legend.
HTML Elements and Layout
A legend consists of an icon/image followed by explanatory text describing the icon/image.
Client Side Javascript Functions
none.
Examples
Example 1: An example showing the default (indicates required field) legend:
<ui:legend id="legend1" />
Example 2: An example showing a custom icon, text, styles:
<ui:legend id="legend2" text="Critical Alarms"
style="position: absolute; left:100px; color:red; font-weight:bold"/>
<f:facet name="legendImage">
ui:image id="alarmimage" icon="ALARM_CRITICAL_SMALL" alt="Critical Alarm"/>
</f:facet>
</ui:legend>
Auto-generated component class.
Do NOT modify; all changes
will be lost!
|
| LegendBase | | public LegendBase()(Code) | | Construct a new LegendBase.
|
| 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.
|
| getPosition | | public String getPosition()(Code) | | Specifies the position of the legend. Valid values are: "right" (the default) and "left".
|
| 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 String getText()(Code) | | The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.
|
| 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.
|
| setPosition | | public void setPosition(String position)(Code) | | Specifies the position of the legend. Valid values are: "right" (the default) and "left".
See Also: LegendBase.getPosition() |
| setText | | public void setText(String text)(Code) | | The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.
See Also: LegendBase.getText() |
| 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: LegendBase.isVisible() |
|
|