com.ibm.xsp.component.xp
Class XspPlatformEvent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.ibm.xsp.component.UIPlatformEvent
              extended by com.ibm.xsp.component.xp.XspPlatformEvent
All Implemented Interfaces:
javax.faces.component.StateHolder

public class XspPlatformEvent
extends UIPlatformEvent

A common control that handles a platform event

XPages Other Controls - Platform Event Control


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.UIPlatformEvent
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
XspPlatformEvent()
           
 
Method Summary
 java.lang.String getEventName()
           Return the value of the eventName property.
 java.lang.String getOnevent()
           Return the value of the onevent property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setEventName(java.lang.String eventName)
           Set the value of the eventName property.
 void setOnevent(java.lang.String onevent)
           Set the value of the onevent property.
 
Methods inherited from class com.ibm.xsp.component.UIPlatformEvent
encodeBegin, encodeChildren, encodeEnd, getFamily
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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

XspPlatformEvent

public XspPlatformEvent()
Method Detail

getEventName

public java.lang.String getEventName()

Return the value of the eventName property. Contents:

Specifies the name of the event handled by the control.


getOnevent

public java.lang.String getOnevent()

Return the value of the onevent property. Contents:

The script executed when the associated component event occurs, as determined by the Event Name property.


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 javax.faces.component.UIComponentBase

saveState

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

setEventName

public void setEventName(java.lang.String eventName)

Set the value of the eventName property.


setOnevent

public void setOnevent(java.lang.String onevent)

Set the value of the onevent property.