Klasse UIButton
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UICommand
- Alle implementierten Schnittstellen:
jakarta.faces.component.ActionSource
,jakarta.faces.component.ActionSource2
,jakarta.faces.component.behavior.ClientBehaviorHolder
,jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,SupportFieldId
,SupportsAccessKey
,SupportsAutoSpacing
,Visual
@Generated("component.stg")
public class UIButton
extends AbstractUIButton
implements SupportsAccessKey
Renders a button element.
UIComponent class, generated from template
component.stg
with class
ButtonTagDeclaration
.-
Feldübersicht
FelderVon Klasse geerbte Felder jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungThe access key of this control.Automatically add spacing (margins/paddings) to the component for better positioning.Text to use as confirmation message.Sets a CSS class in its parent, if the parent supports it.The identifier of the page fragment which should be brought into focus when the target page is rendered.getImage()
Url to an image to display.getLabel()
A localized user presentable label for this component.getLink()
Link to an arbitrary URL, either an internal link or an external link.Link to an internal facelet page, like the outcome of an action.Controls the navigation of the focus through the input controls on a page with the Tab-Key.Name of a frame where the resource retrieved via this hyperlink is to be displayed.getTip()
Text value to display as tooltip.boolean
If true the command is executed as default -- for example if the user presses the enter key inside a related input field.boolean
isOmit()
Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button.boolean
Specify, if the command calls an JSF-Action.void
restoreState
(jakarta.faces.context.FacesContext context, Object state) void
setAccessKey
(Character accessKey) void
setAutoSpacing
(Boolean autoSpacing) void
setConfirmation
(String confirmation) void
setCustomClass
(CustomClass customClass) void
setDefaultCommand
(boolean defaultCommand) void
setFragment
(String fragment) void
void
void
void
void
setOmit
(boolean omit) void
setOutcome
(String outcome) void
setTabIndex
(Integer tabIndex) void
void
void
setTransition
(boolean transition) Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUICommand
getFieldId, isParentOfCommands
Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
isDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabled
Von Klasse geerbte Methoden jakarta.faces.component.UICommand
addActionListener, broadcast, getActionExpression, getActionListeners, getValue, isImmediate, removeActionListener, setActionExpression, setImmediate, setValue
Von Klasse geerbte Methoden jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
Von Klasse geerbte Methoden jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
Von Klasse geerbte Methoden java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Von Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Felddetails
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- Siehe auch:
-
-
Konstruktordetails
-
UIButton
public UIButton()
-
-
Methodendetails
-
getEventNames
- Angegeben von:
getEventNames
in Schnittstellejakarta.faces.component.behavior.ClientBehaviorHolder
- Setzt außer Kraft:
getEventNames
in Klassejakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Angegeben von:
getDefaultEventName
in Schnittstellejakarta.faces.component.behavior.ClientBehaviorHolder
- Setzt außer Kraft:
getDefaultEventName
in Klassejakarta.faces.component.UIComponentBase
-
getFamily
- Setzt außer Kraft:
getFamily
in Klassejakarta.faces.component.UICommand
-
getImage
Url to an image to display.- Angegeben von:
getImage
in KlasseAbstractUICommand
-
setImage
-
getMarkup
-
setMarkup
-
getLink
Link to an arbitrary URL, either an internal link or an external link. For internal URLs, a session id will be added, if needed (when cookies disabled). The context path needs to be added manually e.g. #{request.contextPath}. For JSF navigation to a viewId use the outcome attribute!
The semantic of this attributes has been changed from Tobago 3 to 4!
- Angegeben von:
getLink
in KlasseAbstractUICommandBase
-
setLink
-
getTabIndex
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order. -
setTabIndex
-
getConfirmation
Text to use as confirmation message.- Angegeben von:
getConfirmation
in KlasseAbstractUICommandBase
-
setConfirmation
-
getLabel
A localized user presentable label for this component.- Angegeben von:
getLabel
in SchnittstelleSupportsAccessKey
- Angegeben von:
getLabel
in KlasseAbstractUICommand
-
setLabel
-
isTransition
public boolean isTransition()Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Default:true
- Angegeben von:
isTransition
in KlasseAbstractUICommandBase
-
setTransition
public void setTransition(boolean transition) -
getTarget
Name of a frame where the resource retrieved via this hyperlink is to be displayed.- Angegeben von:
getTarget
in KlasseAbstractUICommandBase
-
setTarget
-
isDefaultCommand
public boolean isDefaultCommand()If true the command is executed as default -- for example if the user presses the enter key inside a related input field.
Default:false
-
setDefaultCommand
public void setDefaultCommand(boolean defaultCommand) -
getFragment
The identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.- Angegeben von:
getFragment
in KlasseAbstractUICommandBase
-
setFragment
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet- Angegeben von:
getAutoSpacing
in SchnittstelleSupportsAutoSpacing
-
setAutoSpacing
-
getAccessKey
The access key of this control.- Angegeben von:
getAccessKey
in SchnittstelleSupportsAccessKey
-
setAccessKey
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>
One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Angegeben von:
getCustomClass
in SchnittstelleVisual
-
setCustomClass
- Angegeben von:
setCustomClass
in SchnittstelleVisual
-
getTip
Text value to display as tooltip. -
setTip
-
isOmit
public boolean isOmit()Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button. When setting this value to true, the action will not be executed by the Tobago, but it can executed by JavaScript. This attribute is useful, when you want to add JavaScript event handlers to commands manually. In this case you usually don't want a submit with a full reload of the page.
Default:false
- Angegeben von:
isOmit
in KlasseAbstractUICommandBase
-
setOmit
public void setOmit(boolean omit) - Angegeben von:
setOmit
in KlasseAbstractUICommandBase
-
getOutcome
Link to an internal facelet page, like the outcome of an action. The context path will be added. A session id will be added, if needed.- Angegeben von:
getOutcome
in KlasseAbstractUICommandBase
-
setOutcome
-
restoreState
- Angegeben von:
restoreState
in Schnittstellejakarta.faces.component.StateHolder
- Setzt außer Kraft:
restoreState
in Klassejakarta.faces.component.UIComponentBase
-