Package com.microstrategy.web.app.beans
Class FolderFrameEventHandler
- java.lang.Object
-
- com.microstrategy.web.beans.GenericEventHandler
-
- com.microstrategy.web.beans.SysEventHandler
-
- com.microstrategy.web.app.beans.FolderFrameEventHandler
-
- All Implemented Interfaces:
EnumAppComponentEvents
,WebEventHandler
,WebEventTags
,java.lang.Cloneable
public class FolderFrameEventHandler extends SysEventHandler
- 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 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.app.beans.EnumAppComponentEvents
WebEventArgumentLeftPosition, WebEventArgumentTopPosition, WebEventSetTopLeftPosition
-
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 FolderFrameEventHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AppComponent
getAppComponent()
protected java.lang.String
getArgumentValue(WebEvent event, int argID)
Utility method to obtain the value of a given event argumentprotected int
getCurrentEventID()
java.lang.Class
getSupportedWebComponentType()
Returns theWebComponent
class by default.protected boolean
handleSetTopLeftPosition(RequestKeys keys)
Utility method for processing a location change request, by manipulating the top and left properties of the instanceboolean
processRequest(RequestKeys requestKeys)
Handle the request specified by the RequestKeysvoid
setWebComponent(WebComponent component)
Set the corresponding web component.-
Methods inherited from class com.microstrategy.web.beans.SysEventHandler
getCatalog, getWebEvent, getWebEvents, initEvents, 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
-
-
-
-
Method Detail
-
processRequest
public boolean processRequest(RequestKeys requestKeys) throws WebException
Handle the request specified by the RequestKeys- Specified by:
processRequest
in interfaceWebEventHandler
- Parameters:
requestKeys
-RequestKeys
instance with the input request- Returns:
True
meaning some event is handled, orFalse
meaning nothing was handled- Throws:
WebException
- if an error ocurrs while handling the request
-
setWebComponent
public void setWebComponent(WebComponent component)
- Specified by:
setWebComponent
in interfaceWebEventHandler
- Parameters:
component
- the input web component
-
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. - See Also:
GenericEventHandler.getSupportedWebComponentType()
-
getAppComponent
protected AppComponent getAppComponent()
- Returns:
AppComponent
instance associated to this event handler
-
getCurrentEventID
protected int getCurrentEventID()
- Returns:
- integer value corresponding to the event currently being handled
-
getArgumentValue
protected java.lang.String getArgumentValue(WebEvent event, int argID)
Utility method to obtain the value of a given event argument- Parameters:
event
-WebEvent
to analyzeargID
- integer identifier of the argument to search for- Returns:
- String instance with the value of the requested event argument
- Since:
- MicroStrategy Web 8.0.1
-
handleSetTopLeftPosition
protected boolean handleSetTopLeftPosition(RequestKeys keys)
Utility method for processing a location change request, by manipulating the top and left properties of the instance- Parameters:
keys
-RequestKeys
from where the event, top and left information will be retrieved- Returns:
- boolean value indicating whether the request was processed successfully
-
-