Package com.microstrategy.web.beans
Class DerivedElementEventHandler
- java.lang.Object
-
- com.microstrategy.web.beans.GenericEventHandler
-
- com.microstrategy.web.beans.SysEventHandler
-
- com.microstrategy.web.beans.DerivedElementEventHandler
-
- All Implemented Interfaces:
EnumDerivedElementBeanEvents
,EnumExpressionBeanEvents
,EnumObjectBeanEvents
,WebEventHandler
,WebEventTags
,java.lang.Cloneable
public class DerivedElementEventHandler extends SysEventHandler implements EnumDerivedElementBeanEvents
- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler
GenericEventHandler.GenericEventKeys
-
-
Field Summary
Fields Modifier and Type Field Description protected ExpressionBean
_eb
protected WebEvent
_event
protected RequestKeys
_keys
protected static int
NONE
-
Fields inherited from class com.microstrategy.web.beans.SysEventHandler
DEFAULT_CONFIG_PATH
-
Fields inherited from class com.microstrategy.web.beans.GenericEventHandler
_extraEvents, layerOfHandleRequest, MULTIPLE_EVENT_SOURCE_SUFFIX, NO_EVENT_ID
-
Fields inherited from interface com.microstrategy.web.beans.EnumDerivedElementBeanEvents
DE_ARGUMENT_AGGREGATION_TYPE, DE_ARGUMENT_APPLY_TO_OTHERS, DE_ARGUMENT_BEHAVIOR, DE_ARGUMENT_ELEMENT_LIST, DE_ARGUMENT_OPERATOR, DE_ARGUMENT_PARENT_ELEMENT_ID, DE_ARGUMENT_SOURCE_TYPE, DE_ARGUMENT_TOKENSTREAM_DIRTY, DE_EVENT_ACCEPT_CALCULATION_CHANGES, DE_EVENT_ACCEPT_CHANGES, DE_EVENT_ACCEPT_LIST_CHANGES, DE_EVENT_SET_AVAILABLES_SOURCE_TYPE, DE_EVENT_TOGGLE_SHOW_ALL
-
Fields inherited from interface com.microstrategy.web.beans.EnumExpressionBeanEvents
EXPRESSION_EVENT_ACCEPT_ATTR_ELEMS_QUAL, EXPRESSION_EVENT_ACCEPT_ATTR_FORM_EXPR, EXPRESSION_EVENT_ACCEPT_ATTR_FORM_QUAL, EXPRESSION_EVENT_ACCEPT_BRANCH_QUAL, EXPRESSION_EVENT_ACCEPT_MENODE_QUAL, EXPRESSION_EVENT_ACCEPT_METRIC_EXPR, EXPRESSION_EVENT_ACCEPT_METRIC_QUAL, EXPRESSION_EVENT_ADD_ATTRIBUTE_ELEMENT_QUALIFICATION, EXPRESSION_EVENT_ADD_ELEMS_TO_AQ, EXPRESSION_EVENT_ADD_EMBEDDED_PROMPT, EXPRESSION_EVENT_ADD_FILTER_SHORTCUT, EXPRESSION_EVENT_ADD_OBJECT_SHORTCUT, EXPRESSION_EVENT_ADD_PROMPT_SHORTCUT, EXPRESSION_EVENT_ADD_UNIT_TO_RHS, EXPRESSION_EVENT_APPLY_EDIT, EXPRESSION_EVENT_ARGUMENT_ACCEPT_CHANGES, EXPRESSION_EVENT_ARGUMENT_APPLY_CHANGES, EXPRESSION_EVENT_ARGUMENT_CONSTANT_VALUE, EXPRESSION_EVENT_ARGUMENT_DEFAULT_ATTR_EDIT_MODE, EXPRESSION_EVENT_ARGUMENT_DESC_DISTANCE_MODE, EXPRESSION_EVENT_ARGUMENT_DESC_LEVEL, EXPRESSION_EVENT_ARGUMENT_DESC_LEVEL_MODE, EXPRESSION_EVENT_ARGUMENT_EDIT_MODE, EXPRESSION_EVENT_ARGUMENT_ELEMENT_IDS, EXPRESSION_EVENT_ARGUMENT_ELEMENT_KEYS, EXPRESSION_EVENT_ARGUMENT_FILTER_ID, EXPRESSION_EVENT_ARGUMENT_FILTER_NAME, EXPRESSION_EVENT_ARGUMENT_FORM_DATATYPE, EXPRESSION_EVENT_ARGUMENT_FORM_ID, EXPRESSION_EVENT_ARGUMENT_FORM_IDDATATYPENAME_COMBO, EXPRESSION_EVENT_ARGUMENT_FORM_NAME, EXPRESSION_EVENT_ARGUMENT_FULL_ELEM_LIST, EXPRESSION_EVENT_ARGUMENT_FUNCTION, EXPRESSION_EVENT_ARGUMENT_FUNCTION_FUNCTIONTYPE_COMBO, EXPRESSION_EVENT_ARGUMENT_FUNCTION_TYPE, EXPRESSION_EVENT_ARGUMENT_LEFT_NODE_KEY, EXPRESSION_EVENT_ARGUMENT_MATCH_CASE, EXPRESSION_EVENT_ARGUMENT_MODIFIER, EXPRESSION_EVENT_ARGUMENT_NAME_PATTERN, EXPRESSION_EVENT_ARGUMENT_NODE_TAG, EXPRESSION_EVENT_ARGUMENT_OBJECT_ID, EXPRESSION_EVENT_ARGUMENT_OBJECT_IDTYPENAME_COMBO, EXPRESSION_EVENT_ARGUMENT_OBJECT_NAME, EXPRESSION_EVENT_ARGUMENT_OBJECT_SUBTYPE, EXPRESSION_EVENT_ARGUMENT_OBJECT_TYPE, EXPRESSION_EVENT_ARGUMENT_OP_NODE_KEY, EXPRESSION_EVENT_ARGUMENT_PAGE_NUMBER, EXPRESSION_EVENT_ARGUMENT_POPULATE_FILTER, EXPRESSION_EVENT_ARGUMENT_POPULATE_OBJECT, EXPRESSION_EVENT_ARGUMENT_PROMPT_TYPE, EXPRESSION_EVENT_ARGUMENT_REMOVE_CONST_PROMPT, EXPRESSION_EVENT_ARGUMENT_RIGHT_NODE_KEY, EXPRESSION_EVENT_ARGUMENT_SECOND_ATTRIBUTE_FORM_COMBO, EXPRESSION_EVENT_ARGUMENT_SECOND_ATTRIBUTE_ID, EXPRESSION_EVENT_ARGUMENT_SECOND_ATTRIBUTE_NAME, EXPRESSION_EVENT_ARGUMENT_SECOND_FORM_ID, EXPRESSION_EVENT_ARGUMENT_SECOND_FORM_NAME, EXPRESSION_EVENT_ARGUMENT_SECOND_METRIC_ID, EXPRESSION_EVENT_ARGUMENT_SECOND_METRIC_IDTYPENAME_COMBO, EXPRESSION_EVENT_ARGUMENT_SECOND_METRIC_NAME, EXPRESSION_EVENT_ARGUMENT_SOURCE_EXPRESSION_TYPE, EXPRESSION_EVENT_ARGUMENT_TARGET_EXPRESSION_TYPE, EXPRESSION_EVENT_ARGUMENT_TOGGLE_FUNCTION, EXPRESSION_EVENT_ARGUMENT_UPDATE_RHS_UNIT_ONLY, EXPRESSION_EVENT_ARGUMENT_XDA_DIMENSION_ID, EXPRESSION_EVENT_ARGUMENT_XDA_HIERARCHY_ID, EXPRESSION_EVENT_CANCEL, EXPRESSION_EVENT_CANCEL_ALL_EDITS, EXPRESSION_EVENT_CHANGE_MODE_SELECT_UNIT, EXPRESSION_EVENT_CLEAR_ALL, EXPRESSION_EVENT_CREATE_PROMPT_FROM_OBJECT, EXPRESSION_EVENT_CREATE_SUBEXPRESSION, EXPRESSION_EVENT_DELETE_SUBEXPRESSION, EXPRESSION_EVENT_EDIT_EMBEDDED_PROMPT, EXPRESSION_EVENT_EDIT_SUBEXPRESSION, EXPRESSION_EVENT_INCR_FETCH_FIRST, EXPRESSION_EVENT_INCR_FETCH_GOTO_PAGE, EXPRESSION_EVENT_INCR_FETCH_NEXT, EXPRESSION_EVENT_INCR_FETCH_PREV, EXPRESSION_EVENT_MOVE_NODE_TO_EXPRESSION, EXPRESSION_EVENT_OK_PROMPT_EDIT, EXPRESSION_EVENT_REMOVE_ELEMS_FROM_AQ, EXPRESSION_EVENT_REMOVE_PROMPT, EXPRESSION_EVENT_SHIFT_DOWN, EXPRESSION_EVENT_SHIFT_LEFT, EXPRESSION_EVENT_SHIFT_RIGHT, EXPRESSION_EVENT_SHIFT_UP, EXPRESSION_EVENT_START_SEARCH, EXPRESSION_EVENT_TOGGLE_AQ_FORM_ELEMS_MODE, EXPRESSION_EVENT_TOGGLE_OPERATOR, EXPRESSION_EVENT_TOGGLE_QUAL_EXPR_MODE
-
Fields inherited from interface com.microstrategy.web.beans.EnumObjectBeanEvents
OBJECT_EVENT_ARGUMENT_FlAGS, OBJECT_EVENT_ARGUMENT_OBJECT_ID, OBJECT_EVENT_ARGUMENT_OBJECT_NAME, OBJECT_EVENT_ARGUMENT_OBJECT_SUBTYPE, OBJECT_EVENT_ARGUMENT_OBJECT_TYPE, OBJECT_EVENT_BROWSE
-
Fields inherited from interface com.microstrategy.web.beans.WebEventTags
ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS
-
-
Constructor Summary
Constructors Constructor Description DerivedElementEventHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getArgumentValue(int argID)
protected java.lang.String
getArgumentValue(int argID, int index)
protected int
getIntArgumentValue(int argID)
java.lang.Class
getSupportedWebComponentType()
Returns theWebComponent
class by default.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.boolean
processRequest(RequestKeys keys)
Logic to process the event.void
setWebComponent(WebComponent component)
Sets aWebComponent
instance on this event handler.-
Methods inherited from class com.microstrategy.web.beans.SysEventHandler
getCatalog, getWebEvent, getWebEvents, initEvents, newDefaultEventInstance, newWebEvent
-
Methods inherited from class com.microstrategy.web.beans.GenericEventHandler
addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, delegateRequest, getEventID, getEventTarget, getHandlerType, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getWebComponent, getWebEvent, getWebEvent, getWebEventsFromRequest, handleRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, setHandlerType, setName, validateRequiredArgument
-
-
-
-
Field Detail
-
_event
protected WebEvent _event
-
_keys
protected RequestKeys _keys
-
_eb
protected ExpressionBean _eb
-
NONE
protected static final int NONE
- See Also:
- Constant Field Values
-
-
Method Detail
-
setWebComponent
public void setWebComponent(WebComponent component)
Description copied from class:GenericEventHandler
Sets aWebComponent
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 ofWebEventHandler
, and the event handler instance previously associate the specifiedWebComponent
should have a nullWebComponent
.This method calls the method
WebComponent.setWebEventHandler(com.microstrategy.web.beans.WebEventHandler)
. Therefore, anyWebComponent
implementation should pay attention to avoid cyclic reference to each other between an event handler and a web component.- Specified by:
setWebComponent
in interfaceWebEventHandler
- Parameters:
component
- a new WebComponent object.
-
initEvents
protected void initEvents()
Description copied from class:SysEventHandler
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
Those event-handler that support more than one handler-type can extend this method and callSysEventHandler.getWebEvent(int)
and theSysEventHandler.getWebEvents()
methods to ensure it's available. If the list has been initialized, it does nothing, if not it callsSysEventHandler.initEvents(int type)
passing this handler's typeSysEventHandler.initEvents(int type)
with all the types they support.- Overrides:
initEvents
in classSysEventHandler
-
handleEvent
protected boolean handleEvent(int id) throws WebException, WebObjectsException, WebBeanException
-
handleAcceptAttrFormQual
protected boolean handleAcceptAttrFormQual() throws WebBeanException, WebObjectsException, WebException
-
handleAcceptAttrElemsQual
protected boolean handleAcceptAttrElemsQual() throws WebBeanException, WebObjectsException, WebException
-
handleAcceptListChanges
protected boolean handleAcceptListChanges() throws WebBeanException, WebObjectsException, WebException
-
handleAcceptCalculationChanges
protected boolean handleAcceptCalculationChanges() throws WebBeanException, WebObjectsException, WebException
-
handleToggleShowAll
protected boolean handleToggleShowAll() throws WebBeanException, WebObjectsException, WebException
-
handleSetAvailablesSourceType
protected boolean handleSetAvailablesSourceType() throws WebBeanException, WebObjectsException, WebException
-
handleStartSearch
protected boolean handleStartSearch() throws WebBeanException, WebObjectsException, WebException
-
handleIncrFetchNext
protected boolean handleIncrFetchNext() throws WebBeanException, WebObjectsException, WebException
-
handleIncrFetchPrev
protected boolean handleIncrFetchPrev() throws WebBeanException, WebObjectsException, WebException
-
handleIncrFetchFirst
protected boolean handleIncrFetchFirst() throws WebBeanException, WebObjectsException, WebException
-
handleIncrFetchGotoPage
protected boolean handleIncrFetchGotoPage() throws WebBeanException, WebObjectsException, WebException
-
processRequest
public boolean processRequest(RequestKeys keys) throws WebException
Description copied from class:GenericEventHandler
Logic to process the event. Specific event handler implementation extending this class will need to override the default behavior.- Specified by:
processRequest
in interfaceWebEventHandler
- Overrides:
processRequest
in classGenericEventHandler
- 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
- thrown if handling of the request fails.
-
getArgumentValue
protected java.lang.String getArgumentValue(int argID)
-
getIntArgumentValue
protected int getIntArgumentValue(int argID) throws WebBeanException
- Throws:
WebBeanException
-
getArgumentValue
protected java.lang.String getArgumentValue(int argID, int index)
-
getSupportedWebComponentType
public java.lang.Class getSupportedWebComponentType()
Description copied from class:GenericEventHandler
Returns theWebComponent
class by default. Subclasses should override this to return their respectiveWebComponent
orWebBean
int.- Specified by:
getSupportedWebComponentType
in interfaceWebEventHandler
- Overrides:
getSupportedWebComponentType
in classGenericEventHandler
- Returns:
- the
Class
of theWebComponent
this event handler is associated with.
-
handleCreateSubexpression
protected boolean handleCreateSubexpression() throws WebBeanException, WebObjectsException, WebException
-
handleClearAll
protected boolean handleClearAll() throws WebBeanException, WebObjectsException, WebException
-
handleToggleOperator
protected boolean handleToggleOperator() throws WebBeanException, WebObjectsException, WebException
-
handleAddPromptShortcut
protected boolean handleAddPromptShortcut() throws WebBeanException, WebObjectsException, WebException
-
handleShiftUp
protected boolean handleShiftUp() throws WebBeanException, WebObjectsException, WebException
-
handleShiftDown
protected boolean handleShiftDown() throws WebBeanException, WebObjectsException, WebException
-
handleShiftLeft
protected boolean handleShiftLeft() throws WebBeanException, WebObjectsException, WebException
-
handleShiftRight
protected boolean handleShiftRight() throws WebBeanException, WebObjectsException, WebException
-
handleDeleteSubexpression
protected boolean handleDeleteSubexpression() throws WebBeanException, WebObjectsException, WebException
-
-