com.ibm.xsp.component.xp
Class XspEventHandler

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by com.ibm.xsp.component.UICommandEx2
                  extended by com.ibm.xsp.component.UIEventHandler
                      extended by com.ibm.xsp.component.xp.XspEventHandler
All Implemented Interfaces:
com.ibm.xsp.component.FacesNavigationBehaviour, FacesParentReliantComponent, FacesSaveBehaviour, javax.faces.component.ActionSource, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class XspEventHandler
extends UIEventHandler

A control that allows JavaScript to run both on the server and the client. Event submissions are prevented when the client-side JavaScript returns a null value.

XPages Other Controls - Event Handler


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class com.ibm.xsp.component.UICommandEx2
COMPONENT_FAMILY, EXEC_COMPLETE, EXEC_PARTIAL, MODE_COMPLETE, MODE_NOREFRESH, MODE_PARTIAL
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
XspEventHandler()
           
 
Method Summary
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 
Methods inherited from class com.ibm.xsp.component.UIEventHandler
addFor, addHandler, addParameter, broadcast, changedParent, encodeBegin, getAction, getEvent, getFor, getHandlers, getParameters, getScript, isSubmit, isSuccessOutcome, queueEvent, setEvent, setScript, setSubmit
 
Methods inherited from class com.ibm.xsp.component.UICommandEx2
doNavigation, doSave, getExecId, getExecMode, getFamily, getOnComplete, getOnError, getOnStart, getRefreshId, getRefreshMode, isDisableValidators, isNavigate, isPartialRefresh, isSave, setDisableValidators, setExecId, setExecMode, setNavigate, setOnComplete, setOnError, setOnStart, setRefreshId, setRefreshMode, setSave
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
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 java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

XspEventHandler

public XspEventHandler()
Method Detail

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIEventHandler

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIEventHandler