|
||||||||||
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
com.sun.rave.web.ui.component.PropertySheetBase
public abstract class PropertySheetBase
The PropertySheet
component is a NamingContainer
used to layout PropertySheetSection
components on a page.
Each PropertySheetSection
may in turn have any number of
Property
components within it. This allows you to easily
format a page with a number of input or read-only fields.
PropertySheetSection
s allow you to group Property
components together and provide a label
for the set of
enclosed Property
s.
The PropertySheet
allows each
PropertySheetSection
to have an optional "jump link" from the
top of the PropertySheet
to each
PropertySheetSection
within the PropertySheet
.
This is accomplished by supplying the attribute jumpLinks
with
a value of true. If not specified, this attribute defaults to false.
None.
PropertySheet
which contains 2 PropertySheetSection
components each containing 2 Property
components:
<ui:propertySheet id="propSheetExample1" jumpLinks="true">
<ui:propertySheetSection id="firstSection" label="Search Criteria">
<ui:property id="Property1" label="Instance Name: " labelAlign="right" noWrap="true" overlapLabel="false">
<ui:dropDown id="servers" required="true" items="#{BackingFileChoice.servers}" />
<f:verbatim>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</f:verbatim>
<ui:label id="logFileLabel" labelLevel="2" text="Log File: " />
<ui:dropDown id="logFile" items="#{BackingFileChoice.archivedLogFiles}" />
</ui:property>
<ui:property id="Property2" label="Log Level: " labelAlign="right" noWrap="true" overlapLabel="false" helpText="#{bundle.['log.level.help']}">
<f:facet name="content">
<ui:dropDown id="logLevel" items="#{BackingFileChoice.logLevel}" />
</f:facet>
</ui:property>
</ui:propertySheetSection>
<ui:propertySheetSection id="secondSection" label="Advanced Options">
<ui:property id="Property3" label="Logger: " labelAlign="right" noWrap="true" overlapLabel="false" helpText="Select one or more module logs to view">
<ui:listbox id="logger" items="#{BackingFileChoice.loggers}" rows="5" />
</ui:property>
<ui:property id="Property4" noWrap="true" overlapLabel="false" helpText="Select one or more module logs to view">
<ui:checkbox id="limitLongLogs" label="Limit excessively long messages" />
</ui:property>
</ui:propertySheetSection>
</ui:propertySheet>
Auto-generated component class. Do NOT modify; all changes will be lost!
Field Summary |
---|
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
PropertySheetBase()
Construct a new PropertySheetBase . |
Method Summary | |
---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getRequiredFields()
This property indicates whether a required field legend should be displayed at the top right-hand side of the property sheet. |
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. |
boolean |
isJumpLinks()
This boolean attribute allows you to control whether jump links will be created at the top of this PropertySheet
or not. |
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 |
setJumpLinks(boolean jumpLinks)
This boolean attribute allows you to control whether jump links will be created at the top of this PropertySheet
or not. |
void |
setRequiredFields(java.lang.String requiredFields)
This property indicates whether a required field legend should be displayed at the top right-hand side of the property sheet. |
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 |
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.UIComponentBase |
---|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PropertySheetBase()
Construct a new PropertySheetBase
.
Method Detail |
---|
public java.lang.String getFamily()
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.
getFamily
in class javax.faces.component.UIComponent
public boolean isJumpLinks()
This boolean attribute allows you to control whether jump links
will be created at the top of this PropertySheet
or not. The default is NOT to create the links -- setting this
attribute to "true" turns this feature on.
public void setJumpLinks(boolean jumpLinks)
This boolean attribute allows you to control whether jump links
will be created at the top of this PropertySheet
or not. The default is NOT to create the links -- setting this
attribute to "true" turns this feature on.
isJumpLinks()
public java.lang.String getRequiredFields()
This property indicates whether a required field legend should be displayed at the top right-hand side of the property sheet.
public void setRequiredFields(java.lang.String requiredFields)
This property indicates whether a required field legend should be displayed at the top right-hand side of the property sheet.
getRequiredFields()
public java.lang.String getStyle()
CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied when this component is rendered.
getStyleClass()
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.UIComponentBase
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.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |