Class HtmlOutcomeTargetButton
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
-
- jakarta.faces.component.UIOutcomeTarget
-
- jakarta.faces.component.html.HtmlOutcomeTargetButton
-
- All Implemented Interfaces:
ClientBehaviorHolder
,PartialStateHolder
,StateHolder
,TransientStateHolder
,ValueHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
public class HtmlOutcomeTargetButton extends UIOutcomeTarget implements ClientBehaviorHolder
Represents an HTML
input
element of type "button" or image that may be used to link to a URL handled by the Faces Servlet resolved preemptively using the logical outcome defined by theoutcome
property. The button behaves like a link, so the current form is not submitted when it is activated (the transitive of how the UICommandLink behaves like a submit button).By default, the
rendererType
property must be set to "jakarta.faces.Button
". This value can be changed by calling thesetRendererType()
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
HtmlOutcomeTargetButton.PropertyKeys
The property keys.
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_TYPE
The standard component type for this component.-
Fields inherited from class jakarta.faces.component.UIOutcomeTarget
COMPONENT_FAMILY
-
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description HtmlOutcomeTargetButton()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAccesskey()
Return the value of theaccesskey
property.String
getAlt()
Return the value of thealt
property.String
getDefaultEventName()
This is a default implementation ofClientBehaviorHolder.getDefaultEventName()
.String
getDir()
Return the value of thedir
property.Collection<String>
getEventNames()
This is a default implementation ofClientBehaviorHolder.getEventNames()
.String
getImage()
Return the value of theimage
property.String
getLang()
Return the value of thelang
property.String
getOnblur()
Return the value of theonblur
property.String
getOnclick()
Return the value of theonclick
property.String
getOndblclick()
Return the value of theondblclick
property.String
getOnfocus()
Return the value of theonfocus
property.String
getOnkeydown()
Return the value of theonkeydown
property.String
getOnkeypress()
Return the value of theonkeypress
property.String
getOnkeyup()
Return the value of theonkeyup
property.String
getOnmousedown()
Return the value of theonmousedown
property.String
getOnmousemove()
Return the value of theonmousemove
property.String
getOnmouseout()
Return the value of theonmouseout
property.String
getOnmouseover()
Return the value of theonmouseover
property.String
getOnmouseup()
Return the value of theonmouseup
property.String
getRole()
Return the value of therole
property.String
getStyle()
Return the value of thestyle
property.String
getStyleClass()
Return the value of thestyleClass
property.String
getTabindex()
Return the value of thetabindex
property.String
getTitle()
Return the value of thetitle
property.boolean
isDisabled()
Return the value of thedisabled
property.void
setAccesskey(String accesskey)
Set the value of theaccesskey
property.void
setAlt(String alt)
Set the value of thealt
property.void
setDir(String dir)
Set the value of thedir
property.void
setDisabled(boolean disabled)
Set the value of thedisabled
property.void
setImage(String image)
Set the value of theimage
property.void
setLang(String lang)
Set the value of thelang
property.void
setOnblur(String onblur)
Set the value of theonblur
property.void
setOnclick(String onclick)
Set the value of theonclick
property.void
setOndblclick(String ondblclick)
Set the value of theondblclick
property.void
setOnfocus(String onfocus)
Set the value of theonfocus
property.void
setOnkeydown(String onkeydown)
Set the value of theonkeydown
property.void
setOnkeypress(String onkeypress)
Set the value of theonkeypress
property.void
setOnkeyup(String onkeyup)
Set the value of theonkeyup
property.void
setOnmousedown(String onmousedown)
Set the value of theonmousedown
property.void
setOnmousemove(String onmousemove)
Set the value of theonmousemove
property.void
setOnmouseout(String onmouseout)
Set the value of theonmouseout
property.void
setOnmouseover(String onmouseover)
Set the value of theonmouseover
property.void
setOnmouseup(String onmouseup)
Set the value of theonmouseup
property.void
setRole(String role)
Set the value of therole
property.void
setStyle(String style)
Set the value of thestyle
property.void
setStyleClass(String styleClass)
Set the value of thestyleClass
property.void
setTabindex(String tabindex)
Set the value of thetabindex
property.void
setTitle(String title)
Set the value of thetitle
property.-
Methods inherited from class jakarta.faces.component.UIOutcomeTarget
getFamily, getOutcome, isDisableClientWindow, isIncludeViewParams, setDisableClientWindow, setIncludeViewParams, setOutcome
-
Methods inherited from class jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class jakarta.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, 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 jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAccesskey
public String getAccesskey()
Return the value of the
accesskey
property.- Returns:
- the property value
Contents: Access key that, when pressed, transfers focus to this element.
-
setAccesskey
public void setAccesskey(String accesskey)
Set the value of the
accesskey
property.- Parameters:
accesskey
- the new property value
-
getAlt
public String getAlt()
Return the value of the
alt
property. This attribute is ignored when theimage
attribute is not specified.- Returns:
- the property value
Contents: Alternate textual description of the element rendered by this component.
-
setAlt
public void setAlt(String alt)
Set the value of the
alt
property.- Parameters:
alt
- the new property value
-
getDir
public String getDir()
Return the value of the
dir
property.- Returns:
- the property value
Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.
-
setDir
public void setDir(String dir)
Set the value of the
dir
property.- Parameters:
dir
- the new property value
-
isDisabled
public boolean isDisabled()
Return the value of the
disabled
property.- Returns:
- the property value
Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".
-
setDisabled
public void setDisabled(boolean disabled)
Set the value of the
disabled
property.- Parameters:
disabled
- the new property value
-
getImage
public String getImage()
Return the value of the
image
property.- Returns:
- the property value
Contents:
Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the "value" property. Note that if the value of this attribute starts with "/", the rendered value for this attribute will be prefixed with the context-root for this application.
-
setImage
public void setImage(String image)
Set the value of the
image
property.- Parameters:
image
- the new property value
-
getLang
public String getLang()
Return the value of the
lang
property.- Returns:
- the property value
Contents: Code describing the language used in the generated markup for this component.
-
setLang
public void setLang(String lang)
Set the value of the
lang
property.- Parameters:
lang
- the new property value
-
getOnblur
public String getOnblur()
Return the value of the
onblur
property.- Returns:
- the property value
Contents: Javascript code executed when this element loses focus.
-
setOnblur
public void setOnblur(String onblur)
Set the value of the
onblur
property.- Parameters:
onblur
- the new property value
-
getOnclick
public String getOnclick()
Return the value of the
onclick
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
public void setOnclick(String onclick)
Set the value of the
onclick
property.- Parameters:
onclick
- the new property value
-
getOndblclick
public String getOndblclick()
Return the value of the
ondblclick
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
public void setOndblclick(String ondblclick)
Set the value of the
ondblclick
property.- Parameters:
ondblclick
- the new property value
-
getOnfocus
public String getOnfocus()
Return the value of the
onfocus
property.- Returns:
- the property value
Contents: Javascript code executed when this element receives focus.
-
setOnfocus
public void setOnfocus(String onfocus)
Set the value of the
onfocus
property.- Parameters:
onfocus
- the new property value
-
getOnkeydown
public String getOnkeydown()
Return the value of the
onkeydown
property.- Returns:
- the property value
Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
public void setOnkeydown(String onkeydown)
Set the value of the
onkeydown
property.- Parameters:
onkeydown
- the new property value
-
getOnkeypress
public String getOnkeypress()
Return the value of the
onkeypress
property.- Returns:
- the property value
Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
public void setOnkeypress(String onkeypress)
Set the value of the
onkeypress
property.- Parameters:
onkeypress
- the new property value
-
getOnkeyup
public String getOnkeyup()
Return the value of the
onkeyup
property.- Returns:
- the property value
Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
public void setOnkeyup(String onkeyup)
Set the value of the
onkeyup
property.- Parameters:
onkeyup
- the new property value
-
getOnmousedown
public String getOnmousedown()
Return the value of the
onmousedown
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
public void setOnmousedown(String onmousedown)
Set the value of the
onmousedown
property.- Parameters:
onmousedown
- the new property value
-
getOnmousemove
public String getOnmousemove()
Return the value of the
onmousemove
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
public void setOnmousemove(String onmousemove)
Set the value of the
onmousemove
property.- Parameters:
onmousemove
- the new property value
-
getOnmouseout
public String getOnmouseout()
Return the value of the
onmouseout
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
public void setOnmouseout(String onmouseout)
Set the value of the
onmouseout
property.- Parameters:
onmouseout
- the new property value
-
getOnmouseover
public String getOnmouseover()
Return the value of the
onmouseover
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
public void setOnmouseover(String onmouseover)
Set the value of the
onmouseover
property.- Parameters:
onmouseover
- the new property value
-
getOnmouseup
public String getOnmouseup()
Return the value of the
onmouseup
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
public void setOnmouseup(String onmouseup)
Set the value of the
onmouseup
property.- Parameters:
onmouseup
- the new property value
-
getRole
public String getRole()
Return the value of the
role
property.- Returns:
- the property value
Contents:
Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.
It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.
-
setRole
public void setRole(String role)
Set the value of the
role
property.- Parameters:
role
- the new property value
-
getStyle
public String getStyle()
Return the value of the
style
property.- Returns:
- the property value
Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
public void setStyle(String style)
Set the value of the
style
property.- Parameters:
style
- the new property value
-
getStyleClass
public String getStyleClass()
Return the value of the
styleClass
property.- Returns:
- the property value
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.
-
setStyleClass
public void setStyleClass(String styleClass)
Set the value of the
styleClass
property.- Parameters:
styleClass
- the new property value
-
getTabindex
public String getTabindex()
Return the value of the
tabindex
property.- Returns:
- the property value
Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
-
setTabindex
public void setTabindex(String tabindex)
Set the value of the
tabindex
property.- Parameters:
tabindex
- the new property value
-
getTitle
public String getTitle()
Return the value of the
title
property.- Returns:
- the property value
Contents: Advisory title information about markup elements generated for this component.
-
setTitle
public void setTitle(String title)
Set the value of the
title
property.- Parameters:
title
- the new property value
-
getEventNames
public Collection<String> getEventNames()
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must override this method to return a non-EmptyCollection
of the client event names that the component supports.- Specified by:
getEventNames
in interfaceClientBehaviorHolder
- Overrides:
getEventNames
in classUIComponentBase
- Returns:
- the collection of event names.
-
getDefaultEventName
public String getDefaultEventName()
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must provide an implementation ofClientBehaviorHolder.getEventNames()
.- Specified by:
getDefaultEventName
in interfaceClientBehaviorHolder
- Overrides:
getDefaultEventName
in classUIComponentBase
- Returns:
- the default event name.
-
-