MBS-7.1.1.5 Javadocs

psdi.webclient.system.controller
Class WebClientEvent

java.lang.Object
  extended by psdi.webclient.system.controller.WebClientEvent

public class WebClientEvent
extends java.lang.Object


Field Summary
protected  java.lang.String additionalEvent
           
protected  java.lang.String additionalEventValue
           
static int CANCEL_EVENT
           
protected  int messageReturn
           
protected  java.util.Hashtable<java.lang.Object,java.lang.Object> params
           
static int PROCESS_EVENT
           
protected  boolean processed
           
protected  boolean render
           
protected  int row
           
protected  ComponentInstance sourceComponentInstance
           
protected  ControlInstance sourceControlInstance
           
protected  int status
           
protected  java.lang.String targetId
           
protected  java.lang.Object transformedValue
          Contains the transformed value for this event.
protected  java.lang.String type
           
protected  long uniqueid
           
protected  java.lang.Object value
           
protected  WebClientSession webClientSession
           
 
Constructor Summary
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, SessionContext sessionContext)
          Deprecated. FIREFOX
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, long uniqueid, SessionContext sessionContext)
          Deprecated. FIREFOX
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, long uniqueid, WebClientSession wcs)
           
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, java.lang.String additionalEventValue, long uniqueid, WebClientSession wcs)
           
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, java.lang.String additionalEventValue, long uniqueid, WebClientSession wcs, BaseInstance creatingInstance)
           
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, WebClientSession wcs)
           
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, WebClientSession wcs)
           
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, WebClientSession wcs, ComponentInstance source)
          Use this contstructor to create an event and force it's source component and control
 
Method Summary
 void addParameter(java.lang.Object key, java.lang.Object value)
           
 void cancelRender()
           
 boolean canRender()
           
 java.lang.String getAdditionalEvent()
           
 java.lang.String getAdditionalEventValue()
           
 int getEventStatus()
           
 int getMessageReturn()
           
 java.util.Hashtable getParameters()
           
 int getRow()
           
 SessionContext getSessionContext()
          Deprecated. FIREFOX
 ComponentInstance getSourceComponentInstance()
          Returns the ComponentHandler that created the event
 ControlHandler getSourceControl()
          Deprecated. FIREFOX
 ControlInstance getSourceControlInstance()
          Returns the ControlHandler that created the event
 java.lang.String getTargetId()
           
 java.lang.Object getTransformedValue()
           
 java.lang.String getType()
           
 long getUniqueId()
           
 java.lang.Object getValue()
           
 java.lang.String getValueString()
           
 WebClientSession getWebClientSession()
          method to get the webclientsession from the event
 boolean hasTransformedValue()
           
 boolean isPassedSigCheck()
           
 void setAdditionalEvent(java.lang.String event)
           
 void setAdditionalEventValue(java.lang.String eventValue)
           
 void setMessageReturn(int msgReturn)
           
 void setPassedSigCheck(boolean passedSigCheck)
           
 void setProcessed()
           
 void setRow(int row)
           
 void setSourceComponent(ComponentInstance sourceComponent)
          Sets ComponentHandler
 void setSourceControl(ControlHandler sourceControl)
          Deprecated. FIREFOX
 void setSourceControl(ControlInstance sourceControl)
          Overrides ControlHandler that created the event.
 void setStatus(int eventStatus)
           
 void setTransformedValue(java.lang.Object transformedValue)
           
 void setValue(java.lang.Object eventvalue)
           
 boolean wasProcessed()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROCESS_EVENT

public static final int PROCESS_EVENT
See Also:
Constant Field Values

CANCEL_EVENT

public static final int CANCEL_EVENT
See Also:
Constant Field Values

type

protected java.lang.String type

targetId

protected java.lang.String targetId

value

protected java.lang.Object value

row

protected int row

status

protected int status

params

protected java.util.Hashtable<java.lang.Object,java.lang.Object> params

messageReturn

protected int messageReturn

processed

protected boolean processed

sourceControlInstance

protected ControlInstance sourceControlInstance

sourceComponentInstance

protected ComponentInstance sourceComponentInstance

additionalEvent

protected java.lang.String additionalEvent

uniqueid

protected long uniqueid

additionalEventValue

protected java.lang.String additionalEventValue

webClientSession

protected WebClientSession webClientSession

render

protected boolean render

transformedValue

protected java.lang.Object transformedValue
Contains the transformed value for this event. When a launch in context is performed, the value is transformed and set in this event. The original value is still available in case it is needed.

Constructor Detail

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      long uniqueid,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      java.lang.String additionalEventValue,
                      long uniqueid,
                      WebClientSession wcs,
                      BaseInstance creatingInstance)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      java.lang.String additionalEventValue,
                      long uniqueid,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      WebClientSession wcs,
                      ComponentInstance source)
Use this contstructor to create an event and force it's source component and control


WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      long uniqueid,
                      SessionContext sessionContext)
Deprecated. FIREFOX


WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      SessionContext sessionContext)
Deprecated. FIREFOX

Method Detail

getSourceControlInstance

public ControlInstance getSourceControlInstance()
Returns the ControlHandler that created the event

Returns:

getSourceControl

public ControlHandler getSourceControl()
Deprecated. FIREFOX

See Also:
getSourceControlInstance

setSourceControl

public void setSourceControl(ControlInstance sourceControl)
Overrides ControlHandler that created the event.


setSourceControl

public void setSourceControl(ControlHandler sourceControl)
Deprecated. FIREFOX

Parameters:
sourceControl -
See Also:
setSourceControl

getType

public java.lang.String getType()

getTargetId

public java.lang.String getTargetId()

getValue

public java.lang.Object getValue()

getRow

public int getRow()

getValueString

public java.lang.String getValueString()

setValue

public void setValue(java.lang.Object eventvalue)

getEventStatus

public int getEventStatus()

setStatus

public void setStatus(int eventStatus)

addParameter

public void addParameter(java.lang.Object key,
                         java.lang.Object value)

getParameters

public java.util.Hashtable getParameters()

getWebClientSession

public WebClientSession getWebClientSession()
method to get the webclientsession from the event

Returns:

getMessageReturn

public int getMessageReturn()

setMessageReturn

public void setMessageReturn(int msgReturn)

wasProcessed

public boolean wasProcessed()
Returns:

setProcessed

public void setProcessed()
Parameters:
b -

getAdditionalEvent

public java.lang.String getAdditionalEvent()
Returns:

getUniqueId

public long getUniqueId()
Returns:

getAdditionalEventValue

public java.lang.String getAdditionalEventValue()

setRow

public void setRow(int row)

getSessionContext

public SessionContext getSessionContext()
Deprecated. FIREFOX

See Also:
psdi.webclient.system.session.WebClientEvent.getWebClientSession()

cancelRender

public void cancelRender()

canRender

public boolean canRender()

getSourceComponentInstance

public ComponentInstance getSourceComponentInstance()
Returns the ComponentHandler that created the event

Returns:

setSourceComponent

public void setSourceComponent(ComponentInstance sourceComponent)
Sets ComponentHandler


isPassedSigCheck

public boolean isPassedSigCheck()

setPassedSigCheck

public void setPassedSigCheck(boolean passedSigCheck)

setAdditionalEventValue

public void setAdditionalEventValue(java.lang.String eventValue)

setAdditionalEvent

public void setAdditionalEvent(java.lang.String event)

setTransformedValue

public void setTransformedValue(java.lang.Object transformedValue)

getTransformedValue

public java.lang.Object getTransformedValue()

hasTransformedValue

public boolean hasTransformedValue()

Copyright IBM 2008-2009