org.apache.myfaces.custom.toggle
Class AbstractTogglePanel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by javax.faces.component.html.HtmlPanelGroup
                  extended by org.apache.myfaces.custom.toggle.AbstractTogglePanel
All Implemented Interfaces:
javax.faces.component.StateHolder, EventAware, UniversalProperties
Direct Known Subclasses:
TogglePanel

public abstract class AbstractTogglePanel
extends javax.faces.component.html.HtmlPanelGroup
implements EventAware, UniversalProperties

Container class allows user to toggle between view/edit mode. Extends PanelGroup. Allows user to toggle between 'view' mode and 'edit' mode. In the togglePanel, include a toggleLink. When the toggleLink is clicked, the rest of the group is shown, and the link is hidden.

Author:
Sharath

Field Summary
static java.lang.String COMPONENT_TYPE
           
static boolean DEFAULT_DISABLED
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
static boolean DEFAULT_TOGGLED
           
 
Fields inherited from class javax.faces.component.html.HtmlPanelGroup
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
AbstractTogglePanel()
           
 
Method Summary
abstract  boolean isDisabled()
           
abstract  boolean isToggled()
          You can set toggled to true to force the toggleGroup to always be in toggle mode.
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
abstract  void setToggled(boolean toggleMode)
           
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getFamily, getLayout, getStyle, getStyleClass, restoreState, saveState, setLayout, setStyle, setStyleClass
 
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, processRestoreState, processSaveState, 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
 
Methods inherited from interface org.apache.myfaces.component.EventAware
getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup
 
Methods inherited from interface org.apache.myfaces.component.UniversalProperties
getDir, getLang, getTitle
 

Field Detail

COMPONENT_TYPE

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

DEFAULT_RENDERER_TYPE

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

DEFAULT_TOGGLED

public static final boolean DEFAULT_TOGGLED
See Also:
Constant Field Values

DEFAULT_DISABLED

public static final boolean DEFAULT_DISABLED
See Also:
Constant Field Values
Constructor Detail

AbstractTogglePanel

public AbstractTogglePanel()
Method Detail

isToggled

public abstract boolean isToggled()
You can set toggled to true to force the toggleGroup to always be in toggle mode. Default is false.

Returns:

setToggled

public abstract void setToggled(boolean toggleMode)

isDisabled

public abstract boolean isDisabled()
Returns:

processDecodes

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

processUpdates

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


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.