Class UIEvent
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UICommand
org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
org.apache.myfaces.tobago.internal.component.AbstractUIEvent
org.apache.myfaces.tobago.component.UIEvent
- All Implemented Interfaces:
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
@Generated("component.stg")
public class UIEvent
extends AbstractUIEvent
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Add an event behavior to the component.
It can contain f:ajax and tc:operation tags.
UIComponent class, generated from template
component.stg
with class
EventTagDeclaration
.-
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionText to use as confirmation message.getEvent()
The name of the event as an instance of {The identifier of the page fragment which should be brought into focus when the target page is rendered.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.Prevent the JavaScript event from bubbling up.Name of a frame where the resource retrieved via this hyperlink is to be displayed.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
setConfirmation
(String confirmation) void
setEvent
(ClientBehaviors event) void
setFragment
(String fragment) void
void
setOmit
(boolean omit) void
setOutcome
(String outcome) void
setStopPropagation
(Boolean stopPropagation) void
void
setTransition
(boolean transition) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
isDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabled
Methods inherited from class jakarta.faces.component.UICommand
addActionListener, broadcast, getActionExpression, getActionListeners, getValue, isImmediate, removeActionListener, setActionExpression, setImmediate, setValue
Methods inherited from class 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
Methods inherited from class 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
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 Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIEvent
public UIEvent()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNames
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventName
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjakarta.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamily
in classjakarta.faces.component.UICommand
-
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!
- Specified by:
getLink
in classAbstractUICommandBase
-
setLink
-
getConfirmation
Text to use as confirmation message.- Specified by:
getConfirmation
in classAbstractUICommandBase
-
setConfirmation
-
getStopPropagation
Prevent the JavaScript event from bubbling up.- Specified by:
getStopPropagation
in classAbstractUIEvent
-
setStopPropagation
-
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
- Specified by:
isTransition
in classAbstractUICommandBase
-
setTransition
public void setTransition(boolean transition) -
getTarget
Name of a frame where the resource retrieved via this hyperlink is to be displayed.- Specified by:
getTarget
in classAbstractUICommandBase
-
setTarget
-
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.- Specified by:
getFragment
in classAbstractUICommandBase
-
setFragment
-
getEvent
The name of the event as an instance of {- Specified by:
getEvent
in classAbstractUIEvent
-
setEvent
- Specified by:
setEvent
in classAbstractUIEvent
-
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
- Specified by:
isOmit
in classAbstractUICommandBase
-
setOmit
public void setOmit(boolean omit) - Specified by:
setOmit
in classAbstractUICommandBase
-
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.- Specified by:
getOutcome
in classAbstractUICommandBase
-
setOutcome
-
restoreState
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-