public class

DerivedElementEventHandler

extends SysEventHandler
implements EnumDerivedElementBeanEvents EnumExpressionBeanEvents
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericEventHandler
     ↳ com.microstrategy.web.beans.SysEventHandler
       ↳ com.microstrategy.web.beans.DerivedElementEventHandler

Summary

Constants
int NONE
[Expand]
Inherited Constants
From class com.microstrategy.web.beans.SysEventHandler
From class com.microstrategy.web.beans.GenericEventHandler
From interface com.microstrategy.web.beans.EnumDerivedElementBeanEvents
From interface com.microstrategy.web.beans.EnumExpressionBeanEvents
From interface com.microstrategy.web.beans.EnumObjectBeanEvents
From interface com.microstrategy.web.beans.WebEventTags
Fields
protected ExpressionBean _eb
protected WebEvent _event
protected RequestKeys _keys
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Constructors
DerivedElementEventHandler()
Public Methods
Class getSupportedWebComponentType()
Returns the WebComponent class by default.
boolean processRequest(RequestKeys keys)
Logic to process the event.
void setWebComponent(WebComponent component)
Sets a WebComponent instance on this event handler.
Protected Methods
String getArgumentValue(int argID)
String getArgumentValue(int argID, int index)
int getIntArgumentValue(int argID)
boolean handleAcceptAttrElemsQual()
boolean handleAcceptAttrFormQual()
boolean handleAcceptCalculationChanges()
boolean handleAcceptListChanges()
boolean handleAddPromptShortcut()
boolean handleClearAll()
boolean handleCreateSubexpression()
boolean handleDeleteSubexpression()
boolean handleEvent(int id)
boolean handleIncrFetchFirst()
boolean handleIncrFetchGotoPage()
boolean handleIncrFetchNext()
boolean handleIncrFetchPrev()
boolean handleSetAvailablesSourceType()
boolean handleShiftDown()
boolean handleShiftLeft()
boolean handleShiftRight()
boolean handleShiftUp()
boolean handleStartSearch()
boolean handleToggleOperator()
boolean handleToggleShowAll()
void initEvents()

This method is called to initialize the list of events available with this event-handler.

[Expand]
Inherited Methods
From class com.microstrategy.web.beans.SysEventHandler
From class com.microstrategy.web.beans.GenericEventHandler
From class java.lang.Object
From interface com.microstrategy.web.beans.WebEventHandler

Constants

protected static final int NONE

Constant Value: -19302 (0xffffb49a)

Fields

protected ExpressionBean _eb

protected WebEvent _event

protected RequestKeys _keys

Public Constructors

public DerivedElementEventHandler ()

Public Methods

public Class getSupportedWebComponentType ()

Returns the WebComponent class by default. Subclasses should override this to return their respective WebComponent or WebBean int.

Returns
  • the Class of the WebComponent this event handler is associated with.

public boolean processRequest (RequestKeys keys)

Logic to process the event. Specific event handler implementation extending this class will need to override the default behavior.

Parameters
keys the RequestKeys object containing event ID, sources, and any other information.
Returns
  • true if handling succeeds; false if the event is ignored and not handled.
Throws
WebException

public void setWebComponent (WebComponent component)

Sets a WebComponent instance on this event handler. A WebComponent must maintain a one-one relationship with an event handler instance. After this method call, the WebComponent previously associated with this event handler should have a null instance of WebEventHandler, and the event handler instance previously associate the specified WebComponent should have a null WebComponent.

This method calls the method setWebEventHandler(WebEventHandler). Therefore, any WebComponent implementation should pay attention to avoid cyclic reference to each other between an event handler and a web component.

Parameters
component a new WebComponent object.

Protected Methods

protected String getArgumentValue (int argID)

protected String getArgumentValue (int argID, int index)

protected int getIntArgumentValue (int argID)

protected boolean handleAcceptAttrElemsQual ()

protected boolean handleAcceptAttrFormQual ()

protected boolean handleAcceptCalculationChanges ()

protected boolean handleAcceptListChanges ()

protected boolean handleAddPromptShortcut ()

protected boolean handleClearAll ()

protected boolean handleCreateSubexpression ()

protected boolean handleDeleteSubexpression ()

protected boolean handleEvent (int id)

protected boolean handleIncrFetchFirst ()

protected boolean handleIncrFetchGotoPage ()

protected boolean handleIncrFetchNext ()

protected boolean handleIncrFetchPrev ()

protected boolean handleSetAvailablesSourceType ()

protected boolean handleShiftDown ()

protected boolean handleShiftLeft ()

protected boolean handleShiftRight ()

protected boolean handleShiftUp ()

protected boolean handleStartSearch ()

protected boolean handleToggleOperator ()

protected boolean handleToggleShowAll ()

protected void initEvents ()

This method is called to initialize the list of events available with this event-handler. Since this class uses lazy initialization for its event list; this method will be always called by the getWebEvent(RequestKeys) and the getWebEvents() methods to ensure it's available. If the list has been initialized, it does nothing, if not it calls initEvents(int) passing this handler's type

Those event-handler that support more than one handler-type can extend this method and call initEvents(int) with all the types they support.