Package com.microstrategy.web.app.beans

Class RibbonEventHandlerImpl

java.lang.Object

com.microstrategy.web.beans.GenericEventHandler

com.microstrategy.web.beans.SysEventHandler

com.microstrategy.web.app.beans.RibbonEventHandlerImpl

All Implemented Interfaces:

EnumAppComponentEvents, EnumRibbonEvents, WebEventHandler, WebEventTags, java.lang.Cloneable

public class RibbonEventHandlerImpl
extends SysEventHandler
implements EnumRibbonEvents

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.app.beans.EnumRibbonEvents

WebEventArgumentBean, WebEventArgumentEvent, WebEventArgumentSelectedRibbon, WebEventArgumentStringArguments, WebEventHandleGeneric, WebEventUpdateSelectedRibbon, WebEventUpdateSelectedRWRibbon

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
RibbonEventHandlerImpl()

Method Summary

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 argument
protected int	getCurrentEventID()
protected WebComponent	getRibbon()
java.lang.Class	getSupportedWebComponentType()	Returns the WebComponent class by default.
protected boolean	handleGenericEvent(RequestKeys keys)	Handles all the events from the ribbon toolbars, it's just a fachade for the real event execution
protected boolean	handleSetTopLeftPosition(RequestKeys keys)	Utility method for processing a location change request, by manipulating the top and left properties of the instance
boolean	processRequest(RequestKeys keys)	handle request as specified by the RequestKeys
void	setWebComponent(WebComponent component)	Set the corresponding web component for this event handler

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RibbonEventHandlerImpl

public RibbonEventHandlerImpl()

Method Detail

getSupportedWebComponentType

public java.lang.Class getSupportedWebComponentType()

Description copied from class: GenericEventHandler

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

Specified by:

getSupportedWebComponentType in interface WebEventHandler

Overrides:

getSupportedWebComponentType in class GenericEventHandler

Returns:

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

setWebComponent

public void setWebComponent(WebComponent component)

Set the corresponding web component for this event handler

Specified by:

setWebComponent in interface WebEventHandler

Parameters:

component - the input web component

getRibbon

protected WebComponent getRibbon()

Returns:

WebComponent ribbon instance attached to this event handler

processRequest

public boolean processRequest(RequestKeys keys)
                       throws WebException

handle request as specified by the RequestKeys

Specified by:

processRequest in interface WebEventHandler

Parameters:

keys - input request

Returns:

true means some event is handled, false means nothing is handled

Throws:

WebException - if an exception is found.

handleGenericEvent

protected boolean handleGenericEvent(RequestKeys keys)
                              throws WebException

Handles all the events from the ribbon toolbars, it's just a fachade for the real event execution

Parameters:

keys - the request should contain the bean and the event at least, in case the event requires extra arguments those can be sent in the form argName:value|argName1:value|....

Returns:

true means some event is handled, false means nothing is handled

Throws:

WebException - if an exception is found.

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 analyze

argID - 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