|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
org.ajax4jsf.component.AjaxActionComponent
org.ajax4jsf.component.UIAjaxCommandLink
org.ajax4jsf.component.html.HtmlAjaxCommandLink
public class HtmlAjaxCommandLink
Component-Type org.ajax4jsf.CommandLink Component-Family javax.faces.Command Renderer-Type org.ajax4jsf.components.AjaxCommandLinkRenderer Renders an HTML "a" anchor element that acts like a form submit button when clicked. <br /> During Decoding: Obtains the Map from the "requestParameterMap" property of the ExternalContext. If this Map contains non null value for the "clientId" key, creates a javax.faces.event.ActionEvent around the component and passes it to the queueEvent() method of the component. If the request is Ajax-performed, adds its target IDs from the reRender property to the rendered areas list of the nesting AjaxContainer. <br /> element for decoding as described above with the parameters of the component. (PARAM_NAME and PARAM_VALUE are the names and values, respectively, of any nested UIParameter children.) The name and the value must be URLEncoded. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Render any non-UIParameter children as normal inside of the "a" element. These will appear as the link text.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from class org.ajax4jsf.component.AjaxActionComponent |
---|
FOCUS_DATA_ID |
Fields inherited from interface org.ajax4jsf.component.AjaxComponent |
---|
AJAX_COMPONETT_PARAMETER |
Constructor Summary | |
---|---|
HtmlAjaxCommandLink()
Constructor to init default renderers |
Method Summary | |
---|---|
java.lang.String |
getAccesskey()
This attribute assigns an access key to an element. |
java.lang.String |
getCharset()
The character encoding of a resource designated by this hyperlink Getter for charset |
java.lang.String |
getCoords()
This attribute specifies the position and shape on the screen. |
java.lang.Object |
getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
java.lang.String |
getDir()
Direction indication for text that does not inherit directionality. |
java.lang.String |
getEventsQueue()
Name of requests queue to avoid send next request before complete other from same event. |
java.lang.String |
getFamily()
|
java.lang.String |
getFocus()
id of element to set focus after request completed on client side Getter for focus |
java.lang.String |
getHreflang()
Base language of a resource specified with the href attribute; hreflang may only be used with href Getter for hreflang |
java.lang.String |
getLang()
Code describing the language used in the generated markup for this component Getter for lang |
java.lang.String |
getOnbeforedomupdate()
JavaScript code for call before DOM has been updated on client side Getter for onbeforedomupdate |
java.lang.String |
getOnblur()
JavaScript code. |
java.lang.String |
getOnclick()
HTML: a script expression; a pointer button is clicked Getter for onclick |
java.lang.String |
getOncomplete()
JavaScript code for call after request completed on client side Getter for oncomplete |
java.lang.String |
getOndblclick()
HTML: a script expression; a pointer button is double-clicked Getter for ondblclick |
java.lang.String |
getOnfocus()
JavaScript code. |
java.lang.String |
getOnkeydown()
HTML: a script expression; a key is pressed down Getter for onkeydown |
java.lang.String |
getOnkeypress()
HTML: a script expression; a key is pressed and released Getter for onkeypress |
java.lang.String |
getOnkeyup()
HTML: a script expression; a key is released Getter for onkeyup |
java.lang.String |
getOnmousedown()
HTML: script expression; a pointer button is pressed down Getter for onmousedown |
java.lang.String |
getOnmousemove()
HTML: a script expression; a pointer is moved within Getter for onmousemove |
java.lang.String |
getOnmouseout()
HTML: a script expression; a pointer is moved away Getter for onmouseout |
java.lang.String |
getOnmouseover()
HTML: a script expression; a pointer is moved onto Getter for onmouseover |
java.lang.String |
getOnmouseup()
HTML: script expression; a pointer button is released Getter for onmouseup |
java.lang.String |
getRel()
The relationship from the current document to the anchor specified by this hyperlink. |
int |
getRequestDelay()
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
java.lang.Object |
getReRender()
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. |
java.lang.String |
getRev()
A reverse link from the anchor specified by this hyperlink to the current document. |
java.lang.String |
getShape()
default|rect|circle|poly [CI] This attribute specifies the shape of a region. |
java.lang.String |
getStatus()
ID (in format of call UIComponent.findComponent()) of Request status component Getter for status |
java.lang.String |
getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style |
java.lang.String |
getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass |
java.lang.String |
getTabindex()
This attribute specifies the position of the current element in the tabbing order for the current document. |
java.lang.String |
getTarget()
This attribute specifies the name of a frame where a document is to be opened. |
int |
getTimeout()
Timeout ( in ms ) for request. |
java.lang.String |
getTitle()
Advisory title information about markup elements generated for this component Getter for title |
java.lang.String |
getType()
The content type of the resource designated by this hyperlink Getter for type |
boolean |
isAjaxSingle()
if "true", submits ONLY one field/link, instead of all form controls Getter for ajaxSingle |
boolean |
isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response. |
boolean |
isIgnoreDupResponses()
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
boolean |
isLimitToList()
If "true", updates on client side ONLY elements from this 'reRender' property. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setAccesskey(java.lang.String __accesskey)
This attribute assigns an access key to an element. |
void |
setAjaxSingle(boolean __ajaxSingle)
if "true", submits ONLY one field/link, instead of all form controls Setter for ajaxSingle |
void |
setBypassUpdates(boolean __bypassUpdates)
If "true", after process validations phase it skips updates of model beans on a force render response. |
void |
setCharset(java.lang.String __charset)
The character encoding of a resource designated by this hyperlink Setter for charset |
void |
setCoords(java.lang.String __coords)
This attribute specifies the position and shape on the screen. |
void |
setData(java.lang.Object __data)
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
void |
setDir(java.lang.String __dir)
Direction indication for text that does not inherit directionality. |
void |
setEventsQueue(java.lang.String __eventsQueue)
Name of requests queue to avoid send next request before complete other from same event. |
void |
setFocus(java.lang.String __focus)
id of element to set focus after request completed on client side Setter for focus |
void |
setHreflang(java.lang.String __hreflang)
Base language of a resource specified with the href attribute; hreflang may only be used with href Setter for hreflang |
void |
setIgnoreDupResponses(boolean __ignoreDupResponses)
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
void |
setLang(java.lang.String __lang)
Code describing the language used in the generated markup for this component Setter for lang |
void |
setLimitToList(boolean __limitToList)
If "true", updates on client side ONLY elements from this 'reRender' property. |
void |
setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate |
void |
setOnblur(java.lang.String __onblur)
JavaScript code. |
void |
setOnclick(java.lang.String __onclick)
HTML: a script expression; a pointer button is clicked Setter for onclick |
void |
setOncomplete(java.lang.String __oncomplete)
JavaScript code for call after request completed on client side Setter for oncomplete |
void |
setOndblclick(java.lang.String __ondblclick)
HTML: a script expression; a pointer button is double-clicked Setter for ondblclick |
void |
setOnfocus(java.lang.String __onfocus)
JavaScript code. |
void |
setOnkeydown(java.lang.String __onkeydown)
HTML: a script expression; a key is pressed down Setter for onkeydown |
void |
setOnkeypress(java.lang.String __onkeypress)
HTML: a script expression; a key is pressed and released Setter for onkeypress |
void |
setOnkeyup(java.lang.String __onkeyup)
HTML: a script expression; a key is released Setter for onkeyup |
void |
setOnmousedown(java.lang.String __onmousedown)
HTML: script expression; a pointer button is pressed down Setter for onmousedown |
void |
setOnmousemove(java.lang.String __onmousemove)
HTML: a script expression; a pointer is moved within Setter for onmousemove |
void |
setOnmouseout(java.lang.String __onmouseout)
HTML: a script expression; a pointer is moved away Setter for onmouseout |
void |
setOnmouseover(java.lang.String __onmouseover)
HTML: a script expression; a pointer is moved onto Setter for onmouseover |
void |
setOnmouseup(java.lang.String __onmouseup)
HTML: script expression; a pointer button is released Setter for onmouseup |
void |
setRel(java.lang.String __rel)
The relationship from the current document to the anchor specified by this hyperlink. |
void |
setRequestDelay(int __requestDelay)
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
void |
setReRender(java.lang.Object __reRender)
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. |
void |
setRev(java.lang.String __rev)
A reverse link from the anchor specified by this hyperlink to the current document. |
void |
setShape(java.lang.String __shape)
default|rect|circle|poly [CI] This attribute specifies the shape of a region. |
void |
setStatus(java.lang.String __status)
ID (in format of call UIComponent.findComponent()) of Request status component Setter for status |
void |
setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style |
void |
setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass |
void |
setTabindex(java.lang.String __tabindex)
This attribute specifies the position of the current element in the tabbing order for the current document. |
void |
setTarget(java.lang.String __target)
This attribute specifies the name of a frame where a document is to be opened. |
void |
setTimeout(int __timeout)
Timeout ( in ms ) for request. |
void |
setTitle(java.lang.String __title)
Advisory title information about markup elements generated for this component Setter for title |
void |
setType(java.lang.String __type)
The content type of the resource designated by this hyperlink Setter for type |
Methods inherited from class org.ajax4jsf.component.AjaxActionComponent |
---|
addAjaxListener, broadcast, getAjaxListeners, getSingleComponent, queueEvent, removeAjaxListener, setupReRender, setupReRender |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, getAction, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
Constructor Detail |
---|
public HtmlAjaxCommandLink()
Method Detail |
---|
public void setAccesskey(java.lang.String __accesskey)
accesskey
- - new valuepublic java.lang.String getAccesskey()
public void setAjaxSingle(boolean __ajaxSingle)
ajaxSingle
- - new valuepublic boolean isAjaxSingle()
public void setBypassUpdates(boolean __bypassUpdates)
bypassUpdates
- - new valuepublic boolean isBypassUpdates()
public void setCharset(java.lang.String __charset)
charset
- - new valuepublic java.lang.String getCharset()
public void setCoords(java.lang.String __coords)
coords
- - new valuepublic java.lang.String getCoords()
public void setData(java.lang.Object __data)
data
- - new valuepublic java.lang.Object getData()
public void setDir(java.lang.String __dir)
dir
- - new valuepublic java.lang.String getDir()
public void setEventsQueue(java.lang.String __eventsQueue)
eventsQueue
- - new valuepublic java.lang.String getEventsQueue()
public void setFocus(java.lang.String __focus)
focus
- - new valuepublic java.lang.String getFocus()
public void setHreflang(java.lang.String __hreflang)
hreflang
- - new valuepublic java.lang.String getHreflang()
public void setIgnoreDupResponses(boolean __ignoreDupResponses)
ignoreDupResponses
- - new valuepublic boolean isIgnoreDupResponses()
public void setLang(java.lang.String __lang)
lang
- - new valuepublic java.lang.String getLang()
public void setLimitToList(boolean __limitToList)
limitToList
- - new valuepublic boolean isLimitToList()
public void setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
onbeforedomupdate
- - new valuepublic java.lang.String getOnbeforedomupdate()
public void setOnblur(java.lang.String __onblur)
onblur
- - new valuepublic java.lang.String getOnblur()
public void setOnclick(java.lang.String __onclick)
onclick
- - new valuepublic java.lang.String getOnclick()
public void setOncomplete(java.lang.String __oncomplete)
oncomplete
- - new valuepublic java.lang.String getOncomplete()
public void setOndblclick(java.lang.String __ondblclick)
ondblclick
- - new valuepublic java.lang.String getOndblclick()
public void setOnfocus(java.lang.String __onfocus)
onfocus
- - new valuepublic java.lang.String getOnfocus()
public void setOnkeydown(java.lang.String __onkeydown)
onkeydown
- - new valuepublic java.lang.String getOnkeydown()
public void setOnkeypress(java.lang.String __onkeypress)
onkeypress
- - new valuepublic java.lang.String getOnkeypress()
public void setOnkeyup(java.lang.String __onkeyup)
onkeyup
- - new valuepublic java.lang.String getOnkeyup()
public void setOnmousedown(java.lang.String __onmousedown)
onmousedown
- - new valuepublic java.lang.String getOnmousedown()
public void setOnmousemove(java.lang.String __onmousemove)
onmousemove
- - new valuepublic java.lang.String getOnmousemove()
public void setOnmouseout(java.lang.String __onmouseout)
onmouseout
- - new valuepublic java.lang.String getOnmouseout()
public void setOnmouseover(java.lang.String __onmouseover)
onmouseover
- - new valuepublic java.lang.String getOnmouseover()
public void setOnmouseup(java.lang.String __onmouseup)
onmouseup
- - new valuepublic java.lang.String getOnmouseup()
public void setReRender(java.lang.Object __reRender)
reRender
- - new valuepublic java.lang.Object getReRender()
public void setRel(java.lang.String __rel)
rel
- - new valuepublic java.lang.String getRel()
public void setRequestDelay(int __requestDelay)
requestDelay
- - new valuepublic int getRequestDelay()
public void setRev(java.lang.String __rev)
rev
- - new valuepublic java.lang.String getRev()
public void setShape(java.lang.String __shape)
shape
- - new valuepublic java.lang.String getShape()
public void setStatus(java.lang.String __status)
status
- - new valuepublic java.lang.String getStatus()
public void setStyle(java.lang.String __style)
style
- - new valuepublic java.lang.String getStyle()
public void setStyleClass(java.lang.String __styleClass)
styleClass
- - new valuepublic java.lang.String getStyleClass()
public void setTabindex(java.lang.String __tabindex)
tabindex
- - new valuepublic java.lang.String getTabindex()
public void setTarget(java.lang.String __target)
target
- - new valuepublic java.lang.String getTarget()
public void setTimeout(int __timeout)
timeout
- - new valuepublic int getTimeout()
public void setTitle(java.lang.String __title)
title
- - new valuepublic java.lang.String getTitle()
public void setType(java.lang.String __type)
type
- - new valuepublic java.lang.String getType()
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UICommand
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UICommand
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |