|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
com.sun.webui.jsf.component.Legend
public class Legend
The Legend component displays a legend to explain icons used in a page.
Field Summary | |
---|---|
static java.lang.String |
LEGEND_IMAGE_FACET
Facet name |
Fields inherited from class javax.faces.component.UIOutput |
---|
COMPONENT_FAMILY, COMPONENT_TYPE |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
Legend()
Default constructor. |
Method Summary | |
---|---|
javax.faces.convert.Converter |
getConverter()
The converter attribute is used to specify a method to translate native property values to String and back for this component. |
java.lang.String |
getFamily()
Return the family for this component. |
javax.faces.component.UIComponent |
getLegendImage()
Return a component that implements a legend image. |
java.lang.String |
getPosition()
Specifies the position of the legend. |
java.lang.String |
getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getText()
The explanatory text that is displayed in the legend. |
java.lang.Object |
getValue()
|
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 |
setId(java.lang.String id)
The component identifier for this component. |
void |
setPosition(java.lang.String position)
Specifies the position of the legend. |
void |
setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. |
void |
setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element 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 |
---|
getLocalValue, setConverter, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LEGEND_IMAGE_FACET
Constructor Detail |
---|
public Legend()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIOutput
public javax.faces.component.UIComponent getLegendImage()
legendImage
is found
that component is returned.
If a facet is not found an Icon
component instance is returned with the id
getId() + "_legendImage"
. The Icon
instance
returned is ThemeImages.LABEL_REQUIRED_ICON.
If a facet is not defined then the returned Icon
component is created every time this method is called.
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
public javax.faces.convert.Converter getConverter()
javax.faces.converter.Converter
interface; or
getConverter
in interface javax.faces.component.ValueHolder
getConverter
in class javax.faces.component.UIOutput
public java.lang.Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class javax.faces.component.UIOutput
public java.lang.String getPosition()
Specifies the position of the legend. Valid values are: "right" (the default) and "left".
public void setPosition(java.lang.String position)
Specifies the position of the legend. Valid values are: "right" (the default) and "left".
getPosition()
public java.lang.String getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public java.lang.String getText()
The explanatory text that is displayed in the legend. If not specified, the required field legend text is displayed.
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.
getText()
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.
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.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIOutput
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIOutput
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |