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 templatecomponent.stg
with classEventTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getConfirmation()
Text to use as confirmation message.String
getDefaultEventName()
ClientBehaviors
getEvent()
The name of the event as an instance of {Collection<String>
getEventNames()
String
getFamily()
String
getFragment()
The identifier of the page fragment which should be brought into focus when the target page is rendered.String
getLink()
Link to an arbitrary URL, either an internal link or an external link.String
getOutcome()
Link to an internal facelet page, like the outcome of an action.String
getTarget()
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
isTransition()
Specify, if the command calls an JSF-Action.void
restoreState(javax.faces.context.FacesContext context, Object state)
void
setConfirmation(String confirmation)
void
setEvent(ClientBehaviors event)
void
setFragment(String fragment)
void
setLink(String link)
void
setOmit(boolean omit)
void
setOutcome(String outcome)
void
setTarget(String target)
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 javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
-
Methods inherited from class javax.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, getValueBinding, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
-
Methods inherited from class javax.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:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjavax.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:
getFragment
in 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:
getLink
in classAbstractUICommandBase
-
setLink
public void setLink(String link)
-
getConfirmation
public String getConfirmation()
Text to use as confirmation message.- Specified by:
getConfirmation
in classAbstractUICommandBase
-
setConfirmation
public void setConfirmation(String confirmation)
-
getEvent
public ClientBehaviors getEvent()
The name of the event as an instance of {- Specified by:
getEvent
in classAbstractUIEvent
-
setEvent
public void setEvent(ClientBehaviors event)
- 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
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:
getOutcome
in 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:
isTransition
in 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:
getTarget
in classAbstractUICommandBase
-
setTarget
public void setTarget(String target)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-
-