|
||||||||||
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.PropertySheetSection
public class PropertySheetSection
The PropertySheetSection
component was written to be used
within the PropertySheet
component. It allows you to group
Property
components together in sections within the
PropertySheet
component.
When you use this component to
create a grouping of Property
components, you may provide a
description for thePropertySheetSection
. This is done via the
label
attribute. Set this attribute to the desired value,
which, of course, may be a ValueBinding expression or a literal String.
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 | |
---|---|
PropertySheetSection()
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 |
getLabel()
This attribute allows you to provide a label or title for the section this PropertySheetSection defines for thePropertySheet component. |
int |
getSectionChildrenCount()
This method calculates the number of visible child PropertySheetSection or Property
UIComponent 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 |
getVisibleSectionChildren()
This method creates a List of visible (rendered=true)
child PropertySheetSection or Property
components. |
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 |
setLabel(java.lang.String label)
This attribute allows you to provide a label or title for the section this PropertySheetSection defines for thePropertySheet component. |
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 |
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 PropertySheetSection()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public int getSectionChildrenCount()
This method calculates the number of visible child
PropertySheetSection
or Property
UIComponent
s. A PropertySheetSection
or Property
can be made not visible by setting their
rendered property to false.
PropertySheetSection
children.public java.util.List getVisibleSectionChildren()
This method creates a List
of visible (rendered=true)
child PropertySheetSection
or Property
components.
List
of child PropertySheetSection
or
Property
UIComponent
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 java.lang.String getLabel()
This attribute allows you to provide a label or title for the section
this PropertySheetSection
defines for thePropertySheet
component. The value may be a literal
String, or it may be a ValueBinding expression (useful for
localization).
public void setLabel(java.lang.String label)
This attribute allows you to provide a label or title for the section
this PropertySheetSection
defines for thePropertySheet
component. The value may be a literal
String, or it may be a ValueBinding expression (useful for
localization).
getLabel()
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 |