com.sun.webui.jsf.component
Class PanelGroup

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.PanelGroup
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class PanelGroup
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer

The PanelGroup component is used to arrange a group of components.


Field Summary
static java.lang.String SEPARATOR_FACET
           
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
PanelGroup()
          Default constructor.
 
Method Summary
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getSeparator()
           The string of characters or HTML element that should be inserted between each component that is a child of this component.
 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.
 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 setId(java.lang.String id)
          The component identifier for this 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 setSeparator(java.lang.String separator)
           The string of characters or HTML element that should be inserted between each component that is a child of this component.
 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, 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

SEPARATOR_FACET

public static final java.lang.String SEPARATOR_FACET
See Also:
Constant Field Values
Constructor Detail

PanelGroup

public PanelGroup()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public 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. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

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 or HTML element that should be inserted between each component that is a child of this component. To specify an HTML element, use the character entities &lt; and &gt; to produce the < and > characters. You can use a block element such as <p> or <br> to force each component to be rendered on a separate line. If the separator attribute is not specified, the components are rendered with a single space between them.


setSeparator

public void setSeparator(java.lang.String separator)

The string of characters or HTML element that should be inserted between each component that is a child of this component. To specify an HTML element, use the character entities &lt; and &gt; to produce the < and > characters. You can use a block element such as <p> or <br> to force each component to be rendered on a separate line. If the separator attribute is not specified, the components are rendered with a single space between them.

See Also:
getSeparator()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element 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


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.