Class UIEvent
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.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:
- EventListener,- javax.faces.component.ActionSource,- javax.faces.component.ActionSource2,- javax.faces.component.behavior.ClientBehaviorHolder,- javax.faces.component.PartialStateHolder,- javax.faces.component.StateHolder,- javax.faces.component.TransientStateHolder,- javax.faces.event.ComponentSystemEventListener,- javax.faces.event.FacesListener,- javax.faces.event.SystemEventListenerHolder
@Generated("component.stg")
public class UIEvent
extends AbstractUIEvent
implements javax.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 SummaryFieldsFields inherited from class javax.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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.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.booleanSpecify, if the command calls an JSF-Action.voidrestoreState(javax.faces.context.FacesContext context, Object state) voidsetConfirmation(String confirmation) voidsetEvent(ClientBehaviors event) voidsetFragment(String fragment) voidvoidsetOmit(boolean omit) voidsetOutcome(String outcome) voidvoidsetTransition(boolean transition) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandBaseisDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabledMethods inherited from class javax.faces.component.UICommandaddActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValueMethods inherited from class javax.faces.component.UIComponentBaseaddClientBehavior, 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, getValueBinding, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreeMethods inherited from class javax.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviors
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIEventpublic UIEvent()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- javax.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- javax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- javax.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- javax.faces.component.UICommand
 
- 
getFragmentThe 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 class- AbstractUICommandBase
 
- 
setFragment
- 
getLinkLink 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 class- AbstractUICommandBase
 
- 
setLink
- 
getConfirmationText to use as confirmation message.- Specified by:
- getConfirmationin class- AbstractUICommandBase
 
- 
setConfirmation
- 
getEventThe name of the event as an instance of {- Specified by:
- getEventin class- AbstractUIEvent
 
- 
setEvent- Specified by:
- setEventin class- AbstractUIEvent
 
- 
isOmitpublic 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 class- AbstractUICommandBase
 
- 
setOmitpublic void setOmit(boolean omit) - Specified by:
- setOmitin class- AbstractUICommandBase
 
- 
getOutcomeLink 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 class- AbstractUICommandBase
 
- 
setOutcome
- 
isTransitionpublic 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 class- AbstractUICommandBase
 
- 
setTransitionpublic void setTransition(boolean transition) 
- 
getTargetName of a frame where the resource retrieved via this hyperlink is to be displayed.- Specified by:
- getTargetin class- AbstractUICommandBase
 
- 
setTarget
- 
restoreState- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- javax.faces.component.UIComponentBase
 
 
-