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:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, EventAware, UniversalProperties

public class TogglePanel
extends AbstractTogglePanel


Nested Class Summary
protected static class TogglePanel.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.toggle.AbstractTogglePanel
DEFAULT_DISABLED, DEFAULT_TOGGLED
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Constructor Summary
TogglePanel()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getLang()
          HTML: The base language of this document.
 String getOnclick()
          HTML: Script to be invoked when the element is clicked.
 String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
 String getOnkeydown()
          HTML: Script to be invoked when a key is pressed down over this element.
 String getOnkeypress()
          HTML: Script to be invoked when a key is pressed over this element.
 String getOnkeyup()
          HTML: Script to be invoked when a key is released over this element.
 String getOnmousedown()
          HTML: Script to be invoked when the pointing device is pressed over this element.
 String getOnmousemove()
          HTML: Script to be invoked when the pointing device is moved while it is in this element.
 String getOnmouseout()
          HTML: Script to be invoked when the pointing device is moves out of this element.
 String getOnmouseover()
          HTML: Script to be invoked when the pointing device is moved into this element.
 String getOnmouseup()
          HTML: Script to be invoked when the pointing device is released over this element.
 String getStyle()
           
 String getStyleClass()
           
 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 setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setLang(String lang)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTitle(String title)
           
 void setToggled(boolean toggled)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 
Methods inherited from class org.apache.myfaces.custom.toggle.AbstractTogglePanel
processDecodes, processUpdates
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getLayout, setLayout
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

TogglePanel

public TogglePanel()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlPanelGroup

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.UIComponentBase

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)

getOnclick

public String getOnclick()
Description copied from interface: EventAware
HTML: Script to be invoked when the element is clicked.


setOnclick

public void setOnclick(String onclick)

getOndblclick

public String getOndblclick()
Description copied from interface: EventAware
HTML: Script to be invoked when the element is double-clicked.


setOndblclick

public void setOndblclick(String ondblclick)

getOnkeydown

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


setOnkeydown

public void setOnkeydown(String onkeydown)

getOnkeypress

public String getOnkeypress()
Description copied from interface: EventAware
HTML: Script to be invoked when a key is pressed over this element.


setOnkeypress

public void setOnkeypress(String onkeypress)

getOnkeyup

public String getOnkeyup()
Description copied from interface: EventAware
HTML: Script to be invoked when a key is released over this element.


setOnkeyup

public void setOnkeyup(String onkeyup)

getOnmousedown

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


setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove

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


setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout

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


setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover

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


setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup

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


setOnmouseup

public void setOnmouseup(String onmouseup)

getDir

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


setDir

public void setDir(String dir)

getLang

public String getLang()
Description copied from interface: UniversalProperties
HTML: The base language of this document.


setLang

public void setLang(String lang)

getTitle

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


setTitle

public void setTitle(String title)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlPanelGroup

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlPanelGroup

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlPanelGroup

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlPanelGroup

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlPanelGroup

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlPanelGroup


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