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
Direct Known Subclasses:
TogglePanel

public abstract class AbstractTogglePanel
extends javax.faces.component.html.HtmlPanelGroup

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.UIPanel
COMPONENT_FAMILY
 
Constructor Summary
AbstractTogglePanel()
           
 
Method Summary
abstract  java.lang.String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
abstract  java.lang.String getLang()
          HTML: The base language of this document.
abstract  java.lang.String getOnclick()
          HTML: Script to be invoked when the element is clicked.
abstract  java.lang.String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
abstract  java.lang.String getOnkeydown()
          HTML: Script to be invoked when a key is pressed down over this element.
abstract  java.lang.String getOnkeypress()
          HTML: Script to be invoked when a key is pressed over this element.
abstract  java.lang.String getOnkeyup()
          HTML: Script to be invoked when a key is released over this element.
abstract  java.lang.String getOnmousedown()
          HTML: Script to be invoked when the pointing device is pressed over this element.
abstract  java.lang.String getOnmousemove()
          HTML: Script to be invoked when the pointing device is moved while it is in this element.
abstract  java.lang.String getOnmouseout()
          HTML: Script to be invoked when the pointing device is moves out of this element.
abstract  java.lang.String getOnmouseover()
          HTML: Script to be invoked when the pointing device is moved into this element.
abstract  java.lang.String getOnmouseup()
          HTML: Script to be invoked when the pointing device is released over this element.
abstract  java.lang.String getTitle()
          HTML: An advisory title for this element.
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
getStyle, getStyleClass, restoreState, saveState, setStyle, setStyleClass
 
Methods inherited from class javax.faces.component.UIPanel
getFamily
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, 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

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

getDir

public abstract java.lang.String getDir()
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).


getLang

public abstract java.lang.String getLang()
HTML: The base language of this document.


getTitle

public abstract java.lang.String getTitle()
HTML: An advisory title for this element. Often used by the user agent as a tooltip.


getOnclick

public abstract java.lang.String getOnclick()
HTML: Script to be invoked when the element is clicked.


getOndblclick

public abstract java.lang.String getOndblclick()
HTML: Script to be invoked when the element is double-clicked.


getOnkeydown

public abstract java.lang.String getOnkeydown()
HTML: Script to be invoked when a key is pressed down over this element.


getOnkeypress

public abstract java.lang.String getOnkeypress()
HTML: Script to be invoked when a key is pressed over this element.


getOnkeyup

public abstract java.lang.String getOnkeyup()
HTML: Script to be invoked when a key is released over this element.


getOnmousedown

public abstract java.lang.String getOnmousedown()
HTML: Script to be invoked when the pointing device is pressed over this element.


getOnmousemove

public abstract java.lang.String getOnmousemove()
HTML: Script to be invoked when the pointing device is moved while it is in this element.


getOnmouseout

public abstract java.lang.String getOnmouseout()
HTML: Script to be invoked when the pointing device is moves out of this element.


getOnmouseover

public abstract java.lang.String getOnmouseover()
HTML: Script to be invoked when the pointing device is moved into this element.


getOnmouseup

public abstract java.lang.String getOnmouseup()
HTML: Script to be invoked when the pointing device is released over this element.



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