org.apache.myfaces.custom.toggle
Class ToggleLink

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.html.HtmlOutputLink
                  extended by org.apache.myfaces.custom.toggle.AbstractToggleLink
                      extended by org.apache.myfaces.custom.toggle.ToggleLink
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class ToggleLink
extends AbstractToggleLink


Nested Class Summary
protected static class ToggleLink.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
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
ToggleLink()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getCharset()
           
 String getCoords()
           
 String getDir()
           
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getFor()
          The class which implements org.apache.myfaces.custom.dynamicResources.ResourceRenderer.
 Boolean getForceId()
          If true, this component will force the use of the specified id when rendering.
 Boolean getForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 String getHreflang()
           
 String getLang()
           
 String getOnblur()
           
 String getOnclick()
           
 String getOnClickFocusId()
          Id of the component that will be focused when toggleLink is clicked
 String getOndblclick()
           
 String getOnfocus()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getRel()
           
 String getRev()
           
 String getShape()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTarget()
           
 String getTitle()
           
 String getType()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isDisabled()
          HTML: When true, this element cannot receive focus.
 void setAccesskey(String accesskey)
           
 void setCharset(String charset)
           
 void setCoords(String coords)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setFor(String forParam)
           
 void setForceId(Boolean forceId)
           
 void setForceIdIndex(Boolean forceIdIndex)
           
 void setHreflang(String hreflang)
           
 void setLang(String lang)
           
 void setOnblur(String onblur)
           
 void setOnclick(String onclick)
           
 void setOnClickFocusId(String onClickFocusId)
           
 void setOndblclick(String ondblclick)
           
 void setOnfocus(String onfocus)
           
 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 setRel(String rel)
           
 void setRev(String rev)
           
 void setShape(String shape)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTarget(String target)
           
 void setTitle(String title)
           
 void setType(String type)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class javax.faces.component.html.HtmlOutputLink
getEventNames, getFragment, setFragment
 
Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, 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

ToggleLink

public ToggleLink()
Method Detail

getFamily

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

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.html.HtmlOutputLink

getFor

public String getFor()
Description copied from class: AbstractToggleLink
The class which implements org.apache.myfaces.custom.dynamicResources.ResourceRenderer. The resource renderer is responsible for resource the image. The class must have a default constructor. Any request scoped attribute or managed bean is not available when this resource renderer is instantiated and used. The resource renderer must render the binary data for the resource by using the parameters passed by nested f:param elements and/or using session or application scoped beans.

Specified by:
getFor in class AbstractToggleLink
Returns:

setFor

public void setFor(String forParam)

isDisabled

public boolean isDisabled()
Description copied from class: AbstractToggleLink
HTML: When true, this element cannot receive focus.

Specified by:
isDisabled in class AbstractToggleLink

setDisabled

public void setDisabled(boolean disabled)
Overrides:
setDisabled in class javax.faces.component.html.HtmlOutputLink

getOnClickFocusId

public String getOnClickFocusId()
Description copied from class: AbstractToggleLink
Id of the component that will be focused when toggleLink is clicked

Specified by:
getOnClickFocusId in class AbstractToggleLink
Returns:

setOnClickFocusId

public void setOnClickFocusId(String onClickFocusId)

getForceId

public Boolean getForceId()
Description copied from class: AbstractToggleLink
If true, this component will force the use of the specified id when rendering.

Specified by:
getForceId in class AbstractToggleLink
Returns:

setForceId

public void setForceId(Boolean forceId)
Specified by:
setForceId in class AbstractToggleLink

getForceIdIndex

public Boolean getForceIdIndex()
Description copied from class: AbstractToggleLink
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Specified by:
getForceIdIndex in class AbstractToggleLink
Returns:

setForceIdIndex

public void setForceIdIndex(Boolean forceIdIndex)
Specified by:
setForceIdIndex in class AbstractToggleLink

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from class: AbstractToggleLink
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Specified by:
getEnabledOnUserRole in class AbstractToggleLink
Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)
Specified by:
setEnabledOnUserRole in class AbstractToggleLink

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from class: AbstractToggleLink
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Specified by:
getVisibleOnUserRole in class AbstractToggleLink
Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)
Specified by:
setVisibleOnUserRole in class AbstractToggleLink

getStyle

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

setStyle

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

getStyleClass

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

setStyleClass

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

getTabindex

public String getTabindex()
Overrides:
getTabindex in class javax.faces.component.html.HtmlOutputLink

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class javax.faces.component.html.HtmlOutputLink

getOnblur

public String getOnblur()
Overrides:
getOnblur in class javax.faces.component.html.HtmlOutputLink

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class javax.faces.component.html.HtmlOutputLink

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class javax.faces.component.html.HtmlOutputLink

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class javax.faces.component.html.HtmlOutputLink

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class javax.faces.component.html.HtmlOutputLink

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class javax.faces.component.html.HtmlOutputLink

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlOutputLink

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlOutputLink

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlOutputLink

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlOutputLink

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlOutputLink

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlOutputLink

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlOutputLink

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlOutputLink

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlOutputLink

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlOutputLink

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlOutputLink

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlOutputLink

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlOutputLink

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlOutputLink

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlOutputLink

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlOutputLink

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlOutputLink

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlOutputLink

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlOutputLink

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlOutputLink

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlOutputLink

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlOutputLink

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlOutputLink

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlOutputLink

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlOutputLink

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlOutputLink

getCharset

public String getCharset()
Overrides:
getCharset in class javax.faces.component.html.HtmlOutputLink

setCharset

public void setCharset(String charset)
Overrides:
setCharset in class javax.faces.component.html.HtmlOutputLink

getCoords

public String getCoords()
Overrides:
getCoords in class javax.faces.component.html.HtmlOutputLink

setCoords

public void setCoords(String coords)
Overrides:
setCoords in class javax.faces.component.html.HtmlOutputLink

getHreflang

public String getHreflang()
Overrides:
getHreflang in class javax.faces.component.html.HtmlOutputLink

setHreflang

public void setHreflang(String hreflang)
Overrides:
setHreflang in class javax.faces.component.html.HtmlOutputLink

getRel

public String getRel()
Overrides:
getRel in class javax.faces.component.html.HtmlOutputLink

setRel

public void setRel(String rel)
Overrides:
setRel in class javax.faces.component.html.HtmlOutputLink

getRev

public String getRev()
Overrides:
getRev in class javax.faces.component.html.HtmlOutputLink

setRev

public void setRev(String rev)
Overrides:
setRev in class javax.faces.component.html.HtmlOutputLink

getShape

public String getShape()
Overrides:
getShape in class javax.faces.component.html.HtmlOutputLink

setShape

public void setShape(String shape)
Overrides:
setShape in class javax.faces.component.html.HtmlOutputLink

getTarget

public String getTarget()
Overrides:
getTarget in class javax.faces.component.html.HtmlOutputLink

setTarget

public void setTarget(String target)
Overrides:
setTarget in class javax.faces.component.html.HtmlOutputLink

getType

public String getType()
Overrides:
getType in class javax.faces.component.html.HtmlOutputLink

setType

public void setType(String type)
Overrides:
setType in class javax.faces.component.html.HtmlOutputLink

setValueBinding

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

setValueExpression

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


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