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.ClientBehaviorHolderAdd an event behavior to the component. It can contain f:ajax and tc:operation tags. UIComponent class, generated from templatecomponent.stgwith classEventTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetConfirmation()Text to use as confirmation message.StringgetDefaultEventName()ClientBehaviorsgetEvent()The name of the event as an instance of {Collection<String>getEventNames()StringgetFamily()StringgetFragment()The identifier of the page fragment which should be brought into focus when the target page is rendered.StringgetLink()Link to an arbitrary URL, either an internal link or an external link.StringgetOutcome()Link to an internal facelet page, like the outcome of an action.StringgetTarget()Name of a frame where the resource retrieved via this hyperlink is to be displayed.booleanisOmit()Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button.booleanisTransition()Specify, if the command calls an JSF-Action.voidrestoreState(jakarta.faces.context.FacesContext context, Object state)voidsetConfirmation(String confirmation)voidsetEvent(ClientBehaviors event)voidsetFragment(String fragment)voidsetLink(String link)voidsetOmit(boolean omit)voidsetOutcome(String outcome)voidsetTarget(String target)voidsetTransition(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
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNamesin interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventNamein interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjakarta.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjakarta.faces.component.UICommand
-
getFragment
public String 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:
getFragmentin classAbstractUICommandBase
-
setFragment
public void setFragment(String fragment)
-
getLink
public String 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:
getLinkin classAbstractUICommandBase
-
setLink
public void setLink(String link)
-
getConfirmation
public String getConfirmation()
Text to use as confirmation message.- Specified by:
getConfirmationin classAbstractUICommandBase
-
setConfirmation
public void setConfirmation(String confirmation)
-
getEvent
public ClientBehaviors getEvent()
The name of the event as an instance of {- Specified by:
getEventin classAbstractUIEvent
-
setEvent
public void setEvent(ClientBehaviors event)
- Specified by:
setEventin 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:
isOmitin classAbstractUICommandBase
-
setOmit
public void setOmit(boolean omit)
- Specified by:
setOmitin classAbstractUICommandBase
-
getOutcome
public String 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:
getOutcomein classAbstractUICommandBase
-
setOutcome
public void setOutcome(String outcome)
-
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:
isTransitionin classAbstractUICommandBase
-
setTransition
public void setTransition(boolean transition)
-
getTarget
public String getTarget()
Name of a frame where the resource retrieved via this hyperlink is to be displayed.- Specified by:
getTargetin classAbstractUICommandBase
-
setTarget
public void setTarget(String target)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-
-