|
||||||||||
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.webui.jsf.component.PropertySheet
public class PropertySheet
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
eachPropertySheetSection
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.
For
an example, please see the documentation for the propertySheet
Tag.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
PropertySheet()
Constructor. |
Method Summary | |
---|---|
void |
encodeBegin(javax.faces.context.FacesContext context)
If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext. |
java.lang.String |
getFamily()
Return the family for this component. |
java.lang.String |
getRequiredFields()
Specifies whether to display a required field legend in the upper right area of the property sheet. |
int |
getSectionCount()
This method calculates the number of visible PropertySheetSection s. |
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.util.List |
getVisibleSections()
This method creates a List of visible (rendered=true)
PropertySheetSection components. |
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 |
setId(java.lang.String id)
The component identifier for 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 |
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 |
setRequiredFields(java.lang.String requiredFields)
Specifies whether to display a required field legend in the upper right area of the property sheet. |
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 |
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 |
---|
broadcast, decode, 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 |
Constructor Detail |
---|
public PropertySheet()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public int getSectionCount()
This method calculates the number of visible
PropertySheetSection
s. A PropertySheetSection
can
be made not visible by setting its rendered propety to false. It
is also considered not visible if it contains no children
(sub-sections or properties).
public java.util.List getVisibleSections()
This method creates a List
of visible (rendered=true)
PropertySheetSection
components.
PropertySheetSection
s must also contain some content to be
considered visible.
List
of visible PropertySheetSection
objects.public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
context
- FacesContext for the current request.
java.io.IOException
- if an input/output error occurs while rendering.
java.lang.NullPointerException
- if FacesContext is null.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 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()
Specifies whether to display a required field legend in the upper right area of the property sheet. This attribute should be set to true if one or more properties in the property sheet sections are marked required.
public void setRequiredFields(java.lang.String requiredFields)
Specifies whether to display a required field legend in the upper right area of the property sheet. This attribute should be set to true if one or more properties in the property sheet sections are marked required.
getRequiredFields()
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 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 |