com.sun.rave.web.ui.component
Class PanelGroupBase
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.rave.web.ui.component.PanelGroupBase
- All Implemented Interfaces:
- javax.faces.component.StateHolder
- Direct Known Subclasses:
- PanelGroup
public abstract class PanelGroupBase
- extends javax.faces.component.UIComponentBase
Use the ui:panelGroup
tag to display a group of components
that are separated by a common separator. This tag is often useful for
providing a consistently formatted layout of a group of components.
HTML Elements and Layout
By default the PanelGroup component is rendered with a
element surrounding the group of child
components. You can change the rendered element to a
by setting the
block
attribute to
true
. When a
is used, the
panel group is displayed on a new line. Note that if you use a
component in the
ui:panelGroup
tag that renders a block
element such as a
, that component is always
displayed on its own line. The behavior of child block elements is
independent of the setting of the block attribute.
PanelGroup is a NamingContainer.
Theme Identifiers
Not Applicable
Client Side Javascript Functions
Not Applicable
Examples:
Example 1: Buttons in a panelGroup that uses default separator
The default separator is a return character.
Example 2: Specifying a separator with the separator
attribute
This example uses the separator attribute to specify a separator
consisting of a pipe character surrounded by spaces.
Example 3: Specifying a separator with the separator
facet
This example shows how to use the separator
facet and
the block
attribute.
Auto-generated component class.
Do NOT modify; all changes
will be lost!
Fields inherited from class javax.faces.component.UIComponent |
bindings |
Method Summary |
java.lang.String |
getFamily()
Return the identifier of the component family to which this
component belongs. |
java.lang.String |
getSeparator()
The String of characters that should be inserted between each UIComponent that is
a child of this component. |
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 |
isBlock()
By default, the panelGroup component is rendered on the same line as the component
that comes before it and the component that follows, in a flow layout. |
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 |
setBlock(boolean block)
By default, the panelGroup component is rendered on the same line as the component
that comes before it and the component that follows, in a flow layout. |
void |
setSeparator(java.lang.String separator)
The String of characters that should be inserted between each UIComponent that is
a child of this component. |
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 |
PanelGroupBase
public PanelGroupBase()
Construct a new PanelGroupBase
.
getFamily
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.
- Specified by:
getFamily
in class javax.faces.component.UIComponent
isBlock
public boolean isBlock()
By default, the panelGroup component is rendered on the same line as the component
that comes before it and the component that follows, in a flow layout. If the block attribute
is set to true, the panelGroup component is rendered on its own line. The components
before it and after it are on different lines. The block attribute has no effect on the
panelGroup component's children.
setBlock
public void setBlock(boolean block)
By default, the panelGroup component is rendered on the same line as the component
that comes before it and the component that follows, in a flow layout. If the block attribute
is set to true, the panelGroup component is rendered on its own line. The components
before it and after it are on different lines. The block attribute has no effect on the
panelGroup component's children.
- See Also:
isBlock()
getSeparator
public java.lang.String getSeparator()
The String of characters that should be inserted between each UIComponent that is
a child of this component. If this attribute is not specified, then a newline will be
inserted between each component.
setSeparator
public void setSeparator(java.lang.String separator)
The String of characters that should be inserted between each UIComponent that is
a child of this component. If this attribute is not specified, then a newline will be
inserted between each component.
- See Also:
getSeparator()
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()
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.
- Specified by:
restoreState
in interface javax.faces.component.StateHolder
- Overrides:
restoreState
in class javax.faces.component.UIComponentBase
saveState
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
- Specified by:
saveState
in interface javax.faces.component.StateHolder
- Overrides:
saveState
in class javax.faces.component.UIComponentBase