org.openfaces.component.panel
Class FoldingPanel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by org.openfaces.component.OUIPanel
                  extended by org.openfaces.component.panel.AbstractPanelWithCaption
                      extended by org.openfaces.component.panel.FoldingPanel
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ComponentWithCaption, EditableStateHolder, OUIComponent

public class FoldingPanel
extends AbstractPanelWithCaption
implements EditableStateHolder

The FoldingPanel component is a container for other components that can be expanded and collapsed by the user. The component supports different folding directions to reveal its content and provides various options to customize its appearance. Plus, there are several ways to control the content loading (using Ajax).


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
FoldingPanel()
           
 
Method Summary
 void addStateChangeListener(StateChangeListener listener)
           
 void addValidator(javax.faces.validator.Validator validator)
           
 void addValueChangeListener(javax.faces.event.ValueChangeListener listener)
           
 javax.faces.convert.Converter getConverter()
           
 java.lang.String getFamily()
           
 java.lang.String getFocusedCaptionClass()
           
 java.lang.String getFocusedCaptionStyle()
           
 java.lang.String getFocusedClass()
           
 java.lang.String getFocusedContentClass()
           
 java.lang.String getFocusedContentStyle()
           
 java.lang.String getFocusedStyle()
           
 FoldingDirection getFoldingDirection()
           
 LoadingMode getLoadingMode()
           
 java.lang.Object getLocalValue()
           
 java.lang.String getOnstatechange()
           
 StateChangeListener[] getStateChangeListeners()
           
 java.lang.Object getSubmittedValue()
           
 javax.faces.el.MethodBinding getValidator()
           
 javax.faces.validator.Validator[] getValidators()
           
 java.lang.Object getValue()
           
 javax.faces.el.MethodBinding getValueChangeListener()
           
 javax.faces.event.ValueChangeListener[] getValueChangeListeners()
           
 boolean isExpanded()
           
 boolean isFocusable()
           
 boolean isImmediate()
           
 boolean isLocalValueSet()
           
 boolean isRequired()
           
 boolean isValid()
           
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void processValidators(javax.faces.context.FacesContext context)
           
 void removeStateChangeListener(StateChangeListener listener)
           
 void removeValidator(javax.faces.validator.Validator validator)
           
 void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)
           
 void resetValue()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object object)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setConverter(javax.faces.convert.Converter converter)
           
 void setExpanded(boolean expanded)
           
 void setFocusable(boolean focusable)
           
 void setFocusedCaptionClass(java.lang.String focusedCaptionClass)
           
 void setFocusedCaptionStyle(java.lang.String focusedCaptionStyle)
           
 void setFocusedClass(java.lang.String focusedClass)
           
 void setFocusedContentClass(java.lang.String focusedContentClass)
           
 void setFocusedContentStyle(java.lang.String focusedContentStyle)
           
 void setFocusedStyle(java.lang.String focusedStyle)
           
 void setFoldingDirection(FoldingDirection foldingDirection)
           
 void setImmediate(boolean immediate)
           
 void setLoadingMode(LoadingMode loadingMode)
           
 void setLocalValueSet(boolean localValueSet)
           
 void setOnstatechange(java.lang.String onstatechange)
           
 void setRequired(boolean required)
           
 void setSubmittedValue(java.lang.Object value)
          Sets the editable state value for this component.
 void setValid(boolean valid)
           
 void setValidator(javax.faces.el.MethodBinding validatorBinding)
           
 void setValue(java.lang.Object value)
           
 void setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod)
           
 
Methods inherited from class org.openfaces.component.panel.AbstractPanelWithCaption
getCaption, getCaptionClass, getCaptionFacet, getCaptionStyle, getContentClass, getContentStyle, setCaption, setCaptionClass, setCaptionFacet, setCaptionStyle, setContentClass, setContentStyle
 
Methods inherited from class org.openfaces.component.OUIPanel
getOnblur, getOnclick, getOncontextmenu, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRolloverClass, getRolloverStyle, getStyle, getStyleClass, setOnblur, setOnclick, setOncontextmenu, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRolloverClass, setRolloverStyle, setStyle, setStyleClass
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getValueExpression, initialStateMarked, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.openfaces.component.OUIComponent
getOnblur, getOnclick, getOncontextmenu, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRolloverClass, getRolloverStyle, getStyle, getStyleClass, setOnblur, setOnclick, setOncontextmenu, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRolloverClass, setRolloverStyle, setStyle, setStyleClass
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

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

FoldingPanel

public FoldingPanel()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class OUIPanel

setFocusable

public void setFocusable(boolean focusable)

isFocusable

public boolean isFocusable()

getFocusedStyle

public java.lang.String getFocusedStyle()

setFocusedStyle

public void setFocusedStyle(java.lang.String focusedStyle)

getFocusedClass

public java.lang.String getFocusedClass()

setFocusedClass

public void setFocusedClass(java.lang.String focusedClass)

getFocusedCaptionStyle

public java.lang.String getFocusedCaptionStyle()

setFocusedCaptionStyle

public void setFocusedCaptionStyle(java.lang.String focusedCaptionStyle)

getFocusedCaptionClass

public java.lang.String getFocusedCaptionClass()

setFocusedCaptionClass

public void setFocusedCaptionClass(java.lang.String focusedCaptionClass)

getFocusedContentStyle

public java.lang.String getFocusedContentStyle()

setFocusedContentStyle

public void setFocusedContentStyle(java.lang.String focusedContentStyle)

getFocusedContentClass

public java.lang.String getFocusedContentClass()

setFocusedContentClass

public void setFocusedContentClass(java.lang.String focusedContentClass)

isExpanded

public boolean isExpanded()

setExpanded

public void setExpanded(boolean expanded)

getOnstatechange

public java.lang.String getOnstatechange()

setOnstatechange

public void setOnstatechange(java.lang.String onstatechange)

getFoldingDirection

public FoldingDirection getFoldingDirection()

setFoldingDirection

public void setFoldingDirection(FoldingDirection foldingDirection)

addStateChangeListener

public void addStateChangeListener(StateChangeListener listener)

getStateChangeListeners

public StateChangeListener[] getStateChangeListeners()

removeStateChangeListener

public void removeStateChangeListener(StateChangeListener listener)

getLoadingMode

public LoadingMode getLoadingMode()

setLoadingMode

public void setLoadingMode(LoadingMode loadingMode)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractPanelWithCaption

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object object)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractPanelWithCaption

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)
Overrides:
processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)
Overrides:
processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class javax.faces.component.UIComponentBase

getSubmittedValue

public java.lang.Object getSubmittedValue()
Specified by:
getSubmittedValue in interface javax.faces.component.EditableValueHolder
Specified by:
getSubmittedValue in interface EditableStateHolder
Returns:
the object that carries the editable state of the component. This editable state value is automatically handled by the iteration components and shouldn't be used directly by application code.

setSubmittedValue

public void setSubmittedValue(java.lang.Object value)
Description copied from interface: EditableStateHolder
Sets the editable state value for this component. This method is invoked by the iteration components to restore the value that was previously received with getValue method. This method shouldn't be used directly by application code.

Specified by:
setSubmittedValue in interface javax.faces.component.EditableValueHolder
Specified by:
setSubmittedValue in interface EditableStateHolder

getLocalValue

public java.lang.Object getLocalValue()
Specified by:
getLocalValue in interface javax.faces.component.ValueHolder

isLocalValueSet

public boolean isLocalValueSet()
Specified by:
isLocalValueSet in interface javax.faces.component.EditableValueHolder

setLocalValueSet

public void setLocalValueSet(boolean localValueSet)
Specified by:
setLocalValueSet in interface javax.faces.component.EditableValueHolder

isValid

public boolean isValid()
Specified by:
isValid in interface javax.faces.component.EditableValueHolder

setValid

public void setValid(boolean valid)
Specified by:
setValid in interface javax.faces.component.EditableValueHolder

isRequired

public boolean isRequired()
Specified by:
isRequired in interface javax.faces.component.EditableValueHolder

setRequired

public void setRequired(boolean required)
Specified by:
setRequired in interface javax.faces.component.EditableValueHolder

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.EditableValueHolder

setImmediate

public void setImmediate(boolean immediate)
Specified by:
setImmediate in interface javax.faces.component.EditableValueHolder

getValidator

public javax.faces.el.MethodBinding getValidator()
Specified by:
getValidator in interface javax.faces.component.EditableValueHolder

setValidator

public void setValidator(javax.faces.el.MethodBinding validatorBinding)
Specified by:
setValidator in interface javax.faces.component.EditableValueHolder

getValueChangeListener

public javax.faces.el.MethodBinding getValueChangeListener()
Specified by:
getValueChangeListener in interface javax.faces.component.EditableValueHolder

setValueChangeListener

public void setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod)
Specified by:
setValueChangeListener in interface javax.faces.component.EditableValueHolder

addValidator

public void addValidator(javax.faces.validator.Validator validator)
Specified by:
addValidator in interface javax.faces.component.EditableValueHolder

getValidators

public javax.faces.validator.Validator[] getValidators()
Specified by:
getValidators in interface javax.faces.component.EditableValueHolder

removeValidator

public void removeValidator(javax.faces.validator.Validator validator)
Specified by:
removeValidator in interface javax.faces.component.EditableValueHolder

addValueChangeListener

public void addValueChangeListener(javax.faces.event.ValueChangeListener listener)
Specified by:
addValueChangeListener in interface javax.faces.component.EditableValueHolder

getValueChangeListeners

public javax.faces.event.ValueChangeListener[] getValueChangeListeners()
Specified by:
getValueChangeListeners in interface javax.faces.component.EditableValueHolder

removeValueChangeListener

public void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)
Specified by:
removeValueChangeListener in interface javax.faces.component.EditableValueHolder

getValue

public java.lang.Object getValue()
Specified by:
getValue in interface javax.faces.component.ValueHolder

setValue

public void setValue(java.lang.Object value)
Specified by:
setValue in interface javax.faces.component.ValueHolder

getConverter

public javax.faces.convert.Converter getConverter()
Specified by:
getConverter in interface javax.faces.component.ValueHolder

setConverter

public void setConverter(javax.faces.convert.Converter converter)
Specified by:
setConverter in interface javax.faces.component.ValueHolder

resetValue

public void resetValue()
Specified by:
resetValue in interface javax.faces.component.EditableValueHolder


Copyright © 1998-2010 TeamDev Ltd. All Rights Reserved.