UICommandLink (RichFaces UI Components UI 4.3.7.Final API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - org.richfaces.component.AbstractActionComponent
      - org.richfaces.component.AbstractCommandLink
        
        org.richfaces.component.UICommandLink

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.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AccesskeyProps, org.richfaces.component.MetaComponentResolver
```
@Generated(value={"RichFaces CDK","4.3.1.Final"})
public class UICommandLink
extends AbstractCommandLink
implements javax.faces.component.behavior.ClientBehaviorHolder, org.richfaces.component.MetaComponentResolver, AccesskeyProps
```
The <a4j:commandLink> component is similar to the JavaServer Faces (JSF) <h:commandLink> component, except that it includes plugged-in Ajax behavior.

Author:

Nick Belaevski

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class UICommandLink.Properties

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`UICommandLink.Properties`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_FAMILY

static String COMPONENT_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
- Fields inherited from interface org.richfaces.component.MetaComponentResolver
  META_COMPONENT_SEPARATOR_CHAR

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_FAMILY`
`static String`	`COMPONENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

UICommandLink()

Constructors
Constructor and Description
`UICommandLink()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAccesskey()` Access key that, when pressed, transfers focus to this element.
`String`	`getCharset()`
`String`	`getCoords()`
`Object`	`getData()`
`String`	`getDefaultEventName()`
`Collection<String>`	`getEventNames()`
`Object`	`getExecute()`
`String`	`getFamily()`
`String`	`getHreflang()`
`String`	`getOnbeforedomupdate()`
`String`	`getOnbegin()`
`String`	`getOnclick()`
`String`	`getOncomplete()`
`String`	`getOndblclick()`
`String`	`getOnkeydown()`
`String`	`getOnkeypress()`
`String`	`getOnkeyup()`
`String`	`getOnmousedown()`
`String`	`getOnmousemove()`
`String`	`getOnmouseout()`
`String`	`getOnmouseover()`
`String`	`getOnmouseup()`
`String`	`getRel()`
`Object`	`getRender()`
`String`	`getRev()`
`String`	`getShape()`
`String`	`getStatus()`
`String`	`getStyle()`
`String`	`getStyleClass()`
`String`	`getTabindex()` This attribute specifies the position of the current element in the tabbing order for the current document.
`String`	`getTarget()`
`String`	`getTitle()`
`String`	`getType()`
`boolean`	`isBypassUpdates()` If "true", after process validations phase it skips updates of model beans on a force render response.
`boolean`	`isDisabled()`
`boolean`	`isLimitRender()`
`void`	`setAccesskey(String accesskey)`
`void`	`setBypassUpdates(boolean bypassUpdates)`
`void`	`setCharset(String charset)`
`void`	`setCoords(String coords)`
`void`	`setData(Object data)`
`void`	`setDisabled(boolean disabled)`
`void`	`setExecute(Object execute)`
`void`	`setHreflang(String hreflang)`
`void`	`setLimitRender(boolean limitRender)`
`void`	`setOnbeforedomupdate(String onbeforedomupdate)`
`void`	`setOnbegin(String onbegin)`
`void`	`setOnclick(String onclick)`
`void`	`setOncomplete(String oncomplete)`
`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`	`setRel(String rel)`
`void`	`setRender(Object render)`
`void`	`setRev(String rev)`
`void`	`setShape(String shape)`
`void`	`setStatus(String status)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`
`void`	`setTabindex(String tabindex)`
`void`	`setTarget(String target)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`

Methods inherited from class org.richfaces.component.AbstractCommandLink
resolveClientId, substituteUnresolvedClientId

Methods inherited from class org.richfaces.component.AbstractActionComponent
queueEvent

Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

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
addClientBehavior, getClientBehaviors

Methods inherited from interface org.richfaces.component.MetaComponentResolver
resolveClientId, substituteUnresolvedClientId

Field Detail
- COMPONENT_TYPE
```
public static final String COMPONENT_TYPE
```
  See Also:
  Constant Field Values
- COMPONENT_FAMILY
```
public static final String COMPONENT_FAMILY
```
  See Also:
  Constant Field Values

Constructor Detail
- UICommandLink
```
public UICommandLink()
```

Method Detail

getFamily
```
public String getFamily()
```
Overrides:

getFamily in class javax.faces.component.UICommand

getEventNames
```
public Collection<String> getEventNames()
```
Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName
```
public String getDefaultEventName()
```
Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getAccesskey
```
public String getAccesskey()
```
Description copied from interface: AccesskeyProps

Access key that, when pressed, transfers focus to this element.

Specified by:

getAccesskey in interface AccesskeyProps

setAccesskey

public void setAccesskey(String accesskey)

isBypassUpdates
```
public boolean isBypassUpdates()
```
Description copied from class: AbstractActionComponent

If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input

Specified by:

isBypassUpdates in class AbstractActionComponent

setBypassUpdates
```
public void setBypassUpdates(boolean bypassUpdates)
```
Specified by:

setBypassUpdates in class AbstractActionComponent

getCharset
```
public String getCharset()
```

setCharset

public void setCharset(String charset)

getCoords
```
public String getCoords()
```

setCoords
```
public void setCoords(String coords)
```

getData
```
public Object getData()
```

setData
```
public void setData(Object data)
```

isDisabled
```
public boolean isDisabled()
```

setDisabled

public void setDisabled(boolean disabled)

getExecute
```
public Object getExecute()
```

setExecute

public void setExecute(Object execute)

getHreflang
```
public String getHreflang()
```

setHreflang

public void setHreflang(String hreflang)

isLimitRender
```
public boolean isLimitRender()
```

setLimitRender

public void setLimitRender(boolean limitRender)

getOnbeforedomupdate
```
public String getOnbeforedomupdate()
```

setOnbeforedomupdate

public void setOnbeforedomupdate(String onbeforedomupdate)

getOnbegin
```
public String getOnbegin()
```

setOnbegin

public void setOnbegin(String onbegin)

getOnclick
```
public String getOnclick()
```

setOnclick

public void setOnclick(String onclick)

getOncomplete
```
public String getOncomplete()
```

setOncomplete

public void setOncomplete(String oncomplete)

getOndblclick
```
public String getOndblclick()
```

setOndblclick

public void setOndblclick(String ondblclick)

getOnkeydown
```
public String getOnkeydown()
```

setOnkeydown

public void setOnkeydown(String onkeydown)

getOnkeypress
```
public String getOnkeypress()
```

setOnkeypress

public void setOnkeypress(String onkeypress)

getOnkeyup
```
public String getOnkeyup()
```

setOnkeyup

public void setOnkeyup(String onkeyup)

getOnmousedown
```
public String getOnmousedown()
```

setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove
```
public String getOnmousemove()
```

setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout
```
public String getOnmouseout()
```

setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover
```
public String getOnmouseover()
```

setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup
```
public String getOnmouseup()
```

setOnmouseup

public void setOnmouseup(String onmouseup)

getRel
```
public String getRel()
```

setRel
```
public void setRel(String rel)
```

getRender
```
public Object getRender()
```

setRender
```
public void setRender(Object render)
```

getRev
```
public String getRev()
```

setRev
```
public void setRev(String rev)
```

getShape
```
public String getShape()
```

setShape
```
public void setShape(String shape)
```

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

getStyle
```
public String getStyle()
```

setStyle
```
public void setStyle(String style)
```

getStyleClass
```
public String getStyleClass()
```

setStyleClass

public void setStyleClass(String styleClass)

getTabindex
```
public String getTabindex()
```
Description copied from class: AbstractCommandLink

This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros

Specified by:

getTabindex in class AbstractCommandLink

setTabindex

public void setTabindex(String tabindex)

getTarget
```
public String getTarget()
```

setTarget
```
public void setTarget(String target)
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

Class UICommandLink

Nested Class Summary

Field Summary

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface org.richfaces.component.MetaComponentResolver

Constructor Summary

Method Summary

Methods inherited from class org.richfaces.component.AbstractCommandLink

Methods inherited from class org.richfaces.component.AbstractActionComponent

Methods inherited from class javax.faces.component.UICommand

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

Methods inherited from interface org.richfaces.component.MetaComponentResolver

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UICommandLink

Method Detail

getFamily

getEventNames

getDefaultEventName

getAccesskey

setAccesskey

isBypassUpdates

setBypassUpdates

getCharset

setCharset

getCoords

setCoords

getData

setData

isDisabled

setDisabled

getExecute

setExecute

getHreflang

setHreflang

isLimitRender

setLimitRender

getOnbeforedomupdate

setOnbeforedomupdate

getOnbegin

setOnbegin

getOnclick

setOnclick

getOncomplete

setOncomplete

getOndblclick

setOndblclick

getOnkeydown

setOnkeydown

getOnkeypress

setOnkeypress

getOnkeyup

setOnkeyup

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getRel

setRel

getRender

setRender

getRev

setRev

getShape

setShape

getStatus

setStatus

getStyle

setStyle