org.apache.myfaces.custom.toggle
Class TogglePanel

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
                      extended by org.apache.myfaces.custom.toggle.TogglePanel
All Implemented Interfaces:
javax.faces.component.StateHolder

public class TogglePanel
extends AbstractTogglePanel


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.toggle.AbstractTogglePanel
DEFAULT_DISABLED, DEFAULT_TOGGLED
 
Constructor Summary
TogglePanel()
           
 
Method Summary
 java.lang.String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getFamily()
           
 java.lang.String getLang()
          HTML: The base language of this document.
 java.lang.String getOnclick()
          HTML: Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
 java.lang.String getOnkeydown()
          HTML: Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          HTML: Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          HTML: Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          HTML: Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          HTML: Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          HTML: Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          HTML: Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          HTML: Script to be invoked when the pointing device is released over this element.
 java.lang.String getTitle()
          HTML: An advisory title for this element.
 boolean isDisabled()
           
 boolean isToggled()
          You can set toggled to true to force the toggleGroup to always be in toggle mode.
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setDir(java.lang.String dir)
           
 void setDisabled(boolean disabled)
           
 void setLang(java.lang.String lang)
           
 void setOnclick(java.lang.String onclick)
           
 void setOndblclick(java.lang.String ondblclick)
           
 void setOnkeydown(java.lang.String onkeydown)
           
 void setOnkeypress(java.lang.String onkeypress)
           
 void setOnkeyup(java.lang.String onkeyup)
           
 void setOnmousedown(java.lang.String onmousedown)
           
 void setOnmousemove(java.lang.String onmousemove)
           
 void setOnmouseout(java.lang.String onmouseout)
           
 void setOnmouseover(java.lang.String onmouseover)
           
 void setOnmouseup(java.lang.String onmouseup)
           
 void setTitle(java.lang.String title)
           
 void setToggled(boolean toggled)
           
 
Methods inherited from class org.apache.myfaces.custom.toggle.AbstractTogglePanel
processDecodes, processUpdates
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getStyle, getStyleClass, setStyle, setStyleClass
 
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_FAMILY

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

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
Constructor Detail

TogglePanel

public TogglePanel()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UIPanel

isToggled

public boolean isToggled()
Description copied from class: AbstractTogglePanel
You can set toggled to true to force the toggleGroup to always be in toggle mode. Default is false.

Specified by:
isToggled in class AbstractTogglePanel
Returns:

setToggled

public void setToggled(boolean toggled)
Specified by:
setToggled in class AbstractTogglePanel

isDisabled

public boolean isDisabled()
Specified by:
isDisabled in class AbstractTogglePanel
Returns:

setDisabled

public void setDisabled(boolean disabled)

getDir

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

Specified by:
getDir in class AbstractTogglePanel

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()
Description copied from class: AbstractTogglePanel
HTML: The base language of this document.

Specified by:
getLang in class AbstractTogglePanel

setLang

public void setLang(java.lang.String lang)

getTitle

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

Specified by:
getTitle in class AbstractTogglePanel

setTitle

public void setTitle(java.lang.String title)

getOnclick

public java.lang.String getOnclick()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when the element is clicked.

Specified by:
getOnclick in class AbstractTogglePanel

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when the element is double-clicked.

Specified by:
getOndblclick in class AbstractTogglePanel

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when a key is pressed down over this element.

Specified by:
getOnkeydown in class AbstractTogglePanel

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when a key is pressed over this element.

Specified by:
getOnkeypress in class AbstractTogglePanel

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when a key is released over this element.

Specified by:
getOnkeyup in class AbstractTogglePanel

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getOnmousedown

public java.lang.String getOnmousedown()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when the pointing device is pressed over this element.

Specified by:
getOnmousedown in class AbstractTogglePanel

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

getOnmousemove

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

Specified by:
getOnmousemove in class AbstractTogglePanel

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

getOnmouseout

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

Specified by:
getOnmouseout in class AbstractTogglePanel

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

getOnmouseover

public java.lang.String getOnmouseover()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when the pointing device is moved into this element.

Specified by:
getOnmouseover in class AbstractTogglePanel

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

getOnmouseup

public java.lang.String getOnmouseup()
Description copied from class: AbstractTogglePanel
HTML: Script to be invoked when the pointing device is released over this element.

Specified by:
getOnmouseup in class AbstractTogglePanel

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

saveState

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

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.html.HtmlPanelGroup


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