Class 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 Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields inherited from class javax.faces.component.UIComponent

        ATTRS_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 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 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
      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors
    • Constructor Detail

      • UIEvent

        public UIEvent()
    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class javax.faces.component.UIComponentBase
      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class javax.faces.component.UIComponentBase
      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.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 class AbstractUICommandBase
      • 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 class AbstractUICommandBase
      • setLink

        public void setLink​(String link)
      • setConfirmation

        public void setConfirmation​(String confirmation)
      • 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
      • 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 class AbstractUICommandBase
      • 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 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.
        Specified by:
        getTarget in class AbstractUICommandBase
      • setTarget

        public void setTarget​(String target)
      • restoreState

        public void restoreState​(javax.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIComponentBase