org.apache.myfaces.tobago.component

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.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIEvent
extends AbstractUIEvent

Add an event behavior to the component. UIComponent class, generated from template component.stg with class EventTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UIEvent()

Method Summary

Modifier and Type	Method and Description
String	getConfirmation() Text to use as confirmation message.
ClientBehaviors	getEvent() The name of the event.
String	getFamily()
String	getLink() Link to an arbitrary URL, either an internal link or an external link.
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	setConfirmation(String confirmation)
void	setEvent(ClientBehaviors event)
void	setLink(String link)
void	setOmit(boolean omit)
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, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIEvent

public UIEvent()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

getLink

public String getLink()

Link to an arbitrary URL, either an internal link or an external link.

internal absolute link

Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.

external link

Starts with protocol followed by a colon ':' character. The link will not be modified.

internal relative link

Any other strings. A session id will be added, if needed.

Specified by:

getLink in class AbstractUICommandBase

setLink

public void setLink(String link)

getConfirmation

public String getConfirmation()

Text to use as confirmation message.

Specified by:

getConfirmation in class AbstractUICommandBase

setConfirmation

public void setConfirmation(String confirmation)

getEvent

public ClientBehaviors getEvent()

The name of the event.

Specified by:

getEvent in class AbstractUIEvent

setEvent

public void setEvent(ClientBehaviors event)

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 class AbstractUICommandBase

setOmit

public void setOmit(boolean omit)

Specified by:

setOmit in class AbstractUICommandBase

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 class AbstractUICommandBase

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. The target attribute is not reliable in combination with DeltaSpike and its

Specified by:

getTarget in class AbstractUICommandBase

setTarget

public void setTarget(String target)