com.sun.rave.web.ui.component
Class LegendBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              com.sun.rave.web.ui.component.LegendBase

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

Legend

public abstract class LegendBase

extends javax.faces.component.UIOutput

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!

Field Summary

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

LegendBase()
Construct a new LegendBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
java.lang.String	getPosition() Specifies the position of the legend.
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
java.lang.String	getText() The explanatory text that is displayed in the legend.
boolean	isVisible() Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.
void	setPosition(java.lang.String position) Specifies the position of the legend.
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setText(java.lang.String text) The explanatory text that is displayed in the legend.
void	setVisible(boolean visible) Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LegendBase

public LegendBase()

Construct a new LegendBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getPosition

public java.lang.String getPosition()

Specifies the position of the legend. Valid values are: "right" (the default) and "left".

setPosition

public void setPosition(java.lang.String position)

Specifies the position of the legend. Valid values are: "right" (the default) and "left".

See Also:

getPosition()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getText

public java.lang.String getText()

The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.

setText

public void setText(java.lang.String text)

The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.

See Also:

getText()

isVisible

public boolean isVisible()

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.

setVisible

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. 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:

isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.