com.sun.rave.web.ui.component
Class PropertySheet

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.sun.rave.web.ui.component.TemplateComponentBase
              com.sun.rave.web.ui.component.PropertySheetBase
                  com.sun.rave.web.ui.component.PropertySheet

All Implemented Interfaces:

ChildManager, javax.faces.component.NamingContainer, javax.faces.component.StateHolder, TemplateComponent

public class PropertySheet

extends PropertySheetBase

Author:

Ken Paulsen

Field Summary

static java.lang.String

LAYOUT_KEY This is the location of the XML file that declares the layout for the PropertySheet.

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.
int	getSectionCount() This method calculates the number of visible PropertySheetSections.
java.util.List	getVisibleSections() This method creates a List of visible (rendered=true) PropertySheetSection components.

Methods inherited from class com.sun.rave.web.ui.component.PropertySheetBase

getFamily, getRequiredFields, getStyle, getStyleClass, isJumpLinks, isVisible, restoreState, saveState, setJumpLinks, setRequiredFields, setStyle, setStyleClass, setVisible

Methods inherited from class com.sun.rave.web.ui.component.TemplateComponentBase

getChild, getChild, getLayoutDefinition, getLayoutDefinitionKey, setLayoutDefinitionKey

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LAYOUT_KEY

public static final java.lang.String LAYOUT_KEY

This is the location of the XML file that declares the layout for the PropertySheet. (layout/propertySheet.xml)

See Also:

Constant Field Values

Constructor Detail

PropertySheet

public PropertySheet()

Constructor.

Method Detail

getSectionCount

public int getSectionCount()

This method calculates the number of visible PropertySheetSections. 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).

Returns:

The number of visible sections.

getVisibleSections

public java.util.List getVisibleSections()

This method creates a List of visible (rendered=true) PropertySheetSection components. PropertySheetSections must also contain some content to be considered visible.

Returns:

A List of visible PropertySheetSection objects.

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

Parameters:

context - FacesContext for the current request.

Throws:

java.io.IOException - if an input/output error occurs while rendering.

java.lang.NullPointerException - if FacesContext is null.