CommandLink (primefaces 6.1 API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - javax.faces.component.html.HtmlCommandLink
      - org.primefaces.component.commandlink.CommandLink

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, AjaxSource, Confirmable, PrimeClientBehaviorHolder
```
public class CommandLink
extends javax.faces.component.html.HtmlCommandLink
implements AjaxSource, Confirmable, PrimeClientBehaviorHolder
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommandLink.PropertyKeys

Nested Classes
Modifier and Type	Class and Description
`static class`	`CommandLink.PropertyKeys`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_FAMILY`
`static String`	`COMPONENT_TYPE`
`static String`	`DEFAULT_RENDERER`
`static String`	`DISABLED_STYLE_CLASS`
`static String`	`STYLE_CLASS`

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

Constructor Summary

Constructors
Constructor and Description

CommandLink()

Constructors
Constructor and Description
`CommandLink()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Class<? extends javax.faces.event.BehaviorEvent>>`	`getBehaviorEventMapping()`
`String`	`getConfirmationScript()`
`String`	`getDefaultEventName()`
`String`	`getDelay()`
`Collection<String>`	`getEventNames()`
`String`	`getFamily()`
`String`	`getForm()`
`String`	`getOncomplete()`
`String`	`getOnerror()`
`String`	`getOnstart()`
`String`	`getOnsuccess()`
`String`	`getPartialSubmitFilter()`
`String`	`getProcess()`
`int`	`getTimeout()`
`String`	`getUpdate()`
`boolean`	`isAjax()`
`boolean`	`isAjaxified()`
`boolean`	`isAsync()`
`boolean`	`isGlobal()`
`boolean`	`isIgnoreAutoUpdate()`
`boolean`	`isPartialSubmit()`
`boolean`	`isPartialSubmitSet()`
`boolean`	`isResetValues()`
`boolean`	`isResetValuesSet()`
`boolean`	`isValidateClient()`
`void`	`queueEvent(javax.faces.event.FacesEvent event)`
`boolean`	`requiresConfirmation()`
`void`	`setAjax(boolean _ajax)`
`void`	`setAsync(boolean _async)`
`void`	`setConfirmationScript(String confirmationScript)`
`void`	`setDelay(String _delay)`
`void`	`setForm(String _form)`
`void`	`setGlobal(boolean _global)`
`void`	`setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)`
`void`	`setOncomplete(String _oncomplete)`
`void`	`setOnerror(String _onerror)`
`void`	`setOnstart(String _onstart)`
`void`	`setOnsuccess(String _onsuccess)`
`void`	`setPartialSubmit(boolean _partialSubmit)`
`void`	`setPartialSubmitFilter(String _partialSubmitFilter)`
`void`	`setProcess(String _process)`
`void`	`setResetValues(boolean _resetValues)`
`void`	`setTimeout(int _timeout)`
`void`	`setUpdate(String _update)`
`void`	`setValidateClient(boolean _validateClient)`

Methods inherited from class javax.faces.component.html.HtmlCommandLink
getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, isDisabled, setAccesskey, setCharset, setCoords, setDir, setDisabled, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType

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

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, 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

- 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
  - DEFAULT_RENDERER
```
public static final String DEFAULT_RENDERER
```
    See Also:
    
    Constant Field Values
  - STYLE_CLASS
```
public static final String STYLE_CLASS
```
    See Also:
    
    Constant Field Values
  - DISABLED_STYLE_CLASS
```
public static final String DISABLED_STYLE_CLASS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommandLink
```
public CommandLink()
```
- Method Detail
  - getFamily
```
public String getFamily()
```
    Overrides:
    
    getFamily in class javax.faces.component.UICommand
  - isAjax
```
public boolean isAjax()
```
  - setAjax
```
public void setAjax(boolean _ajax)
```
  - isAsync
```
public boolean isAsync()
```
    Specified by:
    
    isAsync in interface AjaxSource
  - setAsync
```
public void setAsync(boolean _async)
```
  - getProcess
```
public String getProcess()
```
    Specified by:
    
    getProcess in interface AjaxSource
  - setProcess
```
public void setProcess(String _process)
```
  - getUpdate
```
public String getUpdate()
```
    Specified by:
    
    getUpdate in interface AjaxSource
  - setUpdate
```
public void setUpdate(String _update)
```
  - getOnstart
```
public String getOnstart()
```
    Specified by:
    
    getOnstart in interface AjaxSource
  - setOnstart
```
public void setOnstart(String _onstart)
```
  - getOncomplete
```
public String getOncomplete()
```
    Specified by:
    
    getOncomplete in interface AjaxSource
  - setOncomplete
```
public void setOncomplete(String _oncomplete)
```
  - getOnerror
```
public String getOnerror()
```
    Specified by:
    
    getOnerror in interface AjaxSource
  - setOnerror
```
public void setOnerror(String _onerror)
```
  - getOnsuccess
```
public String getOnsuccess()
```
    Specified by:
    
    getOnsuccess in interface AjaxSource
  - setOnsuccess
```
public void setOnsuccess(String _onsuccess)
```
  - isGlobal
```
public boolean isGlobal()
```
    Specified by:
    
    isGlobal in interface AjaxSource
  - setGlobal
```
public void setGlobal(boolean _global)
```
  - getDelay
```
public String getDelay()
```
    Specified by:
    
    getDelay in interface AjaxSource
  - setDelay
```
public void setDelay(String _delay)
```
  - getTimeout
```
public int getTimeout()
```
    Specified by:
    
    getTimeout in interface AjaxSource
  - setTimeout
```
public void setTimeout(int _timeout)
```
  - isPartialSubmit
```
public boolean isPartialSubmit()
```
    Specified by:
    
    isPartialSubmit in interface AjaxSource
  - setPartialSubmit
```
public void setPartialSubmit(boolean _partialSubmit)
```
  - isResetValues
```
public boolean isResetValues()
```
    Specified by:
    
    isResetValues in interface AjaxSource
  - setResetValues
```
public void setResetValues(boolean _resetValues)
```
  - isIgnoreAutoUpdate
```
public boolean isIgnoreAutoUpdate()
```
    Specified by:
    
    isIgnoreAutoUpdate in interface AjaxSource
  - setIgnoreAutoUpdate
```
public void setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)
```
  - isValidateClient
```
public boolean isValidateClient()
```
  - setValidateClient
```
public void setValidateClient(boolean _validateClient)
```
  - getPartialSubmitFilter
```
public String getPartialSubmitFilter()
```
    Specified by:
    
    getPartialSubmitFilter in interface AjaxSource
  - setPartialSubmitFilter
```
public void setPartialSubmitFilter(String _partialSubmitFilter)
```
  - getForm
```
public String getForm()
```
    Specified by:
    
    getForm in interface AjaxSource
  - setForm
```
public void setForm(String _form)
```
  - getBehaviorEventMapping
```
public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()
```
    Specified by:
    
    getBehaviorEventMapping in interface PrimeClientBehaviorHolder
  - getEventNames
```
public Collection<String> getEventNames()
```
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getEventNames in class javax.faces.component.html.HtmlCommandLink
  - getDefaultEventName
```
public String getDefaultEventName()
```
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class javax.faces.component.html.HtmlCommandLink
  - queueEvent
```
public void queueEvent(javax.faces.event.FacesEvent event)
```
    Overrides:
    
    queueEvent in class javax.faces.component.UICommand
  - isPartialSubmitSet
```
public boolean isPartialSubmitSet()
```
    Specified by:
    
    isPartialSubmitSet in interface AjaxSource
  - isResetValuesSet
```
public boolean isResetValuesSet()
```
    Specified by:
    
    isResetValuesSet in interface AjaxSource
  - isAjaxified
```
public boolean isAjaxified()
```
    Specified by:
    
    isAjaxified in interface AjaxSource
  - getConfirmationScript
```
public String getConfirmationScript()
```
    Specified by:
    
    getConfirmationScript in interface Confirmable
  - setConfirmationScript
```
public void setConfirmationScript(String confirmationScript)
```
    Specified by:
    
    setConfirmationScript in interface Confirmable
  - requiresConfirmation
```
public boolean requiresConfirmation()
```
    Specified by:
    
    requiresConfirmation in interface Confirmable

Class CommandLink

Nested Class Summary

Field Summary

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.html.HtmlCommandLink

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

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

DEFAULT_RENDERER

STYLE_CLASS

DISABLED_STYLE_CLASS

Constructor Detail

CommandLink

Method Detail

getFamily

isAjax

setAjax

isAsync

setAsync

getProcess

setProcess

getUpdate

setUpdate

getOnstart

setOnstart

getOncomplete

setOncomplete

getOnerror

setOnerror

getOnsuccess

setOnsuccess

isGlobal

setGlobal

getDelay

setDelay

getTimeout

setTimeout

isPartialSubmit

setPartialSubmit

isResetValues

setResetValues

isIgnoreAutoUpdate

setIgnoreAutoUpdate

isValidateClient

setValidateClient

getPartialSubmitFilter

setPartialSubmitFilter

getForm

setForm

getBehaviorEventMapping

getEventNames

getDefaultEventName

queueEvent

isPartialSubmitSet

isResetValuesSet

isAjaxified

getConfirmationScript

setConfirmationScript

requiresConfirmation