public class HtmlCommandLink extends UICommand
Represents an HTML a
element for a hyperlink that acts
like a submit button. This component must be placed inside
a form, and requires JavaScript to be enabled in the client.
By default, the rendererType
property must be set to "javax.faces.Link
".
This value can be changed by calling the setRendererType()
method.
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILY
bindings
Constructor and Description |
---|
HtmlCommandLink() |
Modifier and Type | Method and Description |
---|---|
String |
getAccesskey()
Return the value of the
accesskey property. |
String |
getCharset()
Return the value of the
charset property. |
String |
getCoords()
Return the value of the
coords property. |
String |
getDir()
Return the value of the
dir property. |
String |
getHreflang()
Return the value of the
hreflang property. |
String |
getLang()
Return the value of the
lang property. |
String |
getOnblur()
Return the value of the
onblur property. |
String |
getOnclick()
Return the value of the
onclick property. |
String |
getOndblclick()
Return the value of the
ondblclick property. |
String |
getOnfocus()
Return the value of the
onfocus property. |
String |
getOnkeydown()
Return the value of the
onkeydown property. |
String |
getOnkeypress()
Return the value of the
onkeypress property. |
String |
getOnkeyup()
Return the value of the
onkeyup property. |
String |
getOnmousedown()
Return the value of the
onmousedown property. |
String |
getOnmousemove()
Return the value of the
onmousemove property. |
String |
getOnmouseout()
Return the value of the
onmouseout property. |
String |
getOnmouseover()
Return the value of the
onmouseover property. |
String |
getOnmouseup()
Return the value of the
onmouseup property. |
String |
getRel()
Return the value of the
rel property. |
String |
getRev()
Return the value of the
rev property. |
String |
getShape()
Return the value of the
shape property. |
String |
getStyle()
Return the value of the
style property. |
String |
getStyleClass()
Return the value of the
styleClass property. |
String |
getTabindex()
Return the value of the
tabindex property. |
String |
getTarget()
Return the value of the
target property. |
String |
getTitle()
Return the value of the
title property. |
String |
getType()
Return the value of the
type property. |
boolean |
isDisabled()
Return the value of the
disabled property. |
void |
restoreState(FacesContext _context,
Object _state)
Perform any processing required to restore the state from the
entries in the state Object.
|
Object |
saveState(FacesContext _context)
Gets the state of the instance as a
Serializable Object. |
void |
setAccesskey(String accesskey)
Set the value of the
accesskey property. |
void |
setCharset(String charset)
Set the value of the
charset property. |
void |
setCoords(String coords)
Set the value of the
coords property. |
void |
setDir(String dir)
Set the value of the
dir property. |
void |
setDisabled(boolean disabled)
Set the value of the
disabled property. |
void |
setHreflang(String hreflang)
Set the value of the
hreflang property. |
void |
setLang(String lang)
Set the value of the
lang property. |
void |
setOnblur(String onblur)
Set the value of the
onblur property. |
void |
setOnclick(String onclick)
Set the value of the
onclick property. |
void |
setOndblclick(String ondblclick)
Set the value of the
ondblclick property. |
void |
setOnfocus(String onfocus)
Set the value of the
onfocus property. |
void |
setOnkeydown(String onkeydown)
Set the value of the
onkeydown property. |
void |
setOnkeypress(String onkeypress)
Set the value of the
onkeypress property. |
void |
setOnkeyup(String onkeyup)
Set the value of the
onkeyup property. |
void |
setOnmousedown(String onmousedown)
Set the value of the
onmousedown property. |
void |
setOnmousemove(String onmousemove)
Set the value of the
onmousemove property. |
void |
setOnmouseout(String onmouseout)
Set the value of the
onmouseout property. |
void |
setOnmouseover(String onmouseover)
Set the value of the
onmouseover property. |
void |
setOnmouseup(String onmouseup)
Set the value of the
onmouseup property. |
void |
setRel(String rel)
Set the value of the
rel property. |
void |
setRev(String rev)
Set the value of the
rev property. |
void |
setShape(String shape)
Set the value of the
shape property. |
void |
setStyle(String style)
Set the value of the
style property. |
void |
setStyleClass(String styleClass)
Set the value of the
styleClass property. |
void |
setTabindex(String tabindex)
Set the value of the
tabindex property. |
void |
setTarget(String target)
Set the value of the
target property. |
void |
setTitle(String title)
Set the value of the
title property. |
void |
setType(String type)
Set the value of the
type property. |
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getFamily, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
encodeAll, getContainerClientId, getValueExpression, setValueExpression
public static final String COMPONENT_TYPE
The standard component type for this component.
public String getAccesskey()
Return the value of the accesskey
property.
Contents: Access key that, when pressed, transfers focus to this element.
public void setAccesskey(String accesskey)
Set the value of the accesskey
property.
public String getCharset()
Return the value of the charset
property.
Contents: The character encoding of the resource designated by this hyperlink.
public void setCharset(String charset)
Set the value of the charset
property.
public String getCoords()
Return the value of the coords
property.
Contents: The position and shape of the hot spot on the screen (for use in client-side image maps).
public void setCoords(String coords)
Set the value of the coords
property.
public String getDir()
Return the value of the dir
property.
Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
public void setDir(String dir)
Set the value of the dir
property.
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit.
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
public String getHreflang()
Return the value of the hreflang
property.
Contents: The language code of the resource designated by this hyperlink.
public void setHreflang(String hreflang)
Set the value of the hreflang
property.
public String getLang()
Return the value of the lang
property.
Contents: Code describing the language used in the generated markup for this component.
public void setLang(String lang)
Set the value of the lang
property.
public String getOnblur()
Return the value of the onblur
property.
Contents: Javascript code executed when this element loses focus.
public void setOnblur(String onblur)
Set the value of the onblur
property.
public String getOnclick()
Return the value of the onclick
property.
Contents: Javascript code executed when a pointer button is clicked over this element.
public void setOnclick(String onclick)
Set the value of the onclick
property.
public String getOndblclick()
Return the value of the ondblclick
property.
Contents: Javascript code executed when a pointer button is double clicked over this element.
public void setOndblclick(String ondblclick)
Set the value of the ondblclick
property.
public String getOnfocus()
Return the value of the onfocus
property.
Contents: Javascript code executed when this element receives focus.
public void setOnfocus(String onfocus)
Set the value of the onfocus
property.
public String getOnkeydown()
Return the value of the onkeydown
property.
Contents: Javascript code executed when a key is pressed down over this element.
public void setOnkeydown(String onkeydown)
Set the value of the onkeydown
property.
public String getOnkeypress()
Return the value of the onkeypress
property.
Contents: Javascript code executed when a key is pressed and released over this element.
public void setOnkeypress(String onkeypress)
Set the value of the onkeypress
property.
public String getOnkeyup()
Return the value of the onkeyup
property.
Contents: Javascript code executed when a key is released over this element.
public void setOnkeyup(String onkeyup)
Set the value of the onkeyup
property.
public String getOnmousedown()
Return the value of the onmousedown
property.
Contents: Javascript code executed when a pointer button is pressed down over this element.
public void setOnmousedown(String onmousedown)
Set the value of the onmousedown
property.
public String getOnmousemove()
Return the value of the onmousemove
property.
Contents: Javascript code executed when a pointer button is moved within this element.
public void setOnmousemove(String onmousemove)
Set the value of the onmousemove
property.
public String getOnmouseout()
Return the value of the onmouseout
property.
Contents: Javascript code executed when a pointer button is moved away from this element.
public void setOnmouseout(String onmouseout)
Set the value of the onmouseout
property.
public String getOnmouseover()
Return the value of the onmouseover
property.
Contents: Javascript code executed when a pointer button is moved onto this element.
public void setOnmouseover(String onmouseover)
Set the value of the onmouseover
property.
public String getOnmouseup()
Return the value of the onmouseup
property.
Contents: Javascript code executed when a pointer button is released over this element.
public void setOnmouseup(String onmouseup)
Set the value of the onmouseup
property.
public String getRel()
Return the value of the rel
property.
Contents: The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types.
public void setRel(String rel)
Set the value of the rel
property.
public String getRev()
Return the value of the rev
property.
Contents: A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types.
public void setRev(String rev)
Set the value of the rev
property.
public String getShape()
Return the value of the shape
property.
Contents: The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
public void setShape(String shape)
Set the value of the shape
property.
public String getStyle()
Return the value of the style
property.
Contents: CSS style(s) to be applied when this component is rendered.
public void setStyle(String style)
Set the value of the style
property.
public String getStyleClass()
Return the value of the styleClass
property.
Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
public void setStyleClass(String styleClass)
Set the value of the styleClass
property.
public String getTabindex()
Return the value of the tabindex
property.
Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
public void setTabindex(String tabindex)
Set the value of the tabindex
property.
public String getTarget()
Return the value of the target
property.
Contents: Name of a frame where the resource retrieved via this hyperlink is to be displayed.
public void setTarget(String target)
Set the value of the target
property.
public String getTitle()
Return the value of the title
property.
Contents: Advisory title information about markup elements generated for this component.
public void setTitle(String title)
Set the value of the title
property.
public String getType()
Return the value of the type
property.
Contents: The content type of the resource designated by this hyperlink.
public void setType(String type)
Set the value of the type
property.
public Object saveState(FacesContext _context)
StateHolder
Gets the state of the instance as a
Serializable
Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext)
method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component
should be the same as before executing
it.
The return from this method must be Serializable
saveState
in interface StateHolder
saveState
in class UICommand
public void restoreState(FacesContext _context, Object _state)
StateHolder
Perform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface StateHolder
restoreState
in class UICommand
Copyright © 2018 JBoss by Red Hat. All rights reserved.