org.apache.myfaces.component.html.ext
Class HtmlCommandLink

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by javax.faces.component.html.HtmlCommandLink
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
                      extended by org.apache.myfaces.component.html.ext.HtmlCommandLink
All Implemented Interfaces:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ForceIdAware, UserRoleAware
Direct Known Subclasses:
AbstractHtmlCommandNavigation, AbstractHtmlCommandNavigationItem, AbstractHtmlCommandSortHeader, AbstractHtmlHeaderLink

public class HtmlCommandLink
extends AbstractHtmlCommandLink


Nested Class Summary
protected static class HtmlCommandLink.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlCommandLink()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getActionFor()
          Comma separated list of subForm-ids for which validation and model update should take place when this command is executed.
 String getCharset()
           
 String getCoords()
           
 String getDir()
           
 String getDisabledStyle()
          CSS-Style Attribute to render when disabled is true
 String getDisabledStyleClass()
          CSS-Style Class to use when disabled is true
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getHreflang()
           
 String getLang()
           
 String getOnblur()
           
 String getOnclick()
           
 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()
          When set instead of a Hyperlink a span tag is rendered in the corresponding Component
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          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.)
 void setAccesskey(String accesskey)
           
 void setActionFor(String actionFor)
           
 void setCharset(String charset)
           
 void setCoords(String coords)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setDisabledStyle(String disabledStyle)
           
 void setDisabledStyleClass(String disabledStyleClass)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 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 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 org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
getClientId, isRendered
 
Methods inherited from class javax.faces.component.html.HtmlCommandLink
getDefaultEventName, getEventNames
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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
 

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

HtmlCommandLink

public HtmlCommandLink()
Method Detail

getFamily

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

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.HtmlCommandLink

getActionFor

public String getActionFor()
Description copied from class: AbstractHtmlCommandLink
Comma separated list of subForm-ids for which validation and model update should take place when this command is executed. You need to wrap your input components in org.apache.myfaces.custom.subform.SubForm instances for this to work.

Specified by:
getActionFor in class AbstractHtmlCommandLink

setActionFor

public void setActionFor(String actionFor)

isDisabled

public boolean isDisabled()
Description copied from class: AbstractHtmlCommandLink
When set instead of a Hyperlink a span tag is rendered in the corresponding Component

Specified by:
isDisabled in class AbstractHtmlCommandLink

setDisabled

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

getDisabledStyle

public String getDisabledStyle()
Description copied from class: AbstractHtmlCommandLink
CSS-Style Attribute to render when disabled is true

Specified by:
getDisabledStyle in class AbstractHtmlCommandLink

setDisabledStyle

public void setDisabledStyle(String disabledStyle)

getDisabledStyleClass

public String getDisabledStyleClass()
Description copied from class: AbstractHtmlCommandLink
CSS-Style Class to use when disabled is true

Specified by:
getDisabledStyleClass in class AbstractHtmlCommandLink

setDisabledStyleClass

public void setDisabledStyleClass(String disabledStyleClass)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
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.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
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.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
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.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getStyle

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

setStyle

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

getStyleClass

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

setStyleClass

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

getTabindex

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

setTabindex

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

getOnblur

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

setOnblur

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

getOnfocus

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

setOnfocus

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

getAccesskey

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

setAccesskey

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

getOnclick

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

setOnclick

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

getOndblclick

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

setOndblclick

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

getOnkeydown

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

setOnkeydown

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

getOnkeypress

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

setOnkeypress

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

getOnkeyup

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

setOnkeyup

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

getOnmousedown

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

setOnmousedown

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

getOnmousemove

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

setOnmousemove

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

getOnmouseout

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

setOnmouseout

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

getOnmouseover

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

setOnmouseover

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

getOnmouseup

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

setOnmouseup

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

getDir

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

setDir

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

getLang

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

setLang

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

getTitle

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

setTitle

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

getCharset

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

setCharset

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

getCoords

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

setCoords

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

getHreflang

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

setHreflang

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

getRel

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

setRel

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

getRev

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

setRev

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

getShape

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

setShape

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

getTarget

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

setTarget

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

getType

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

setType

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

setValueBinding

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

setValueExpression

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


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