public class

RibbonEventHandlerImpl

extends SysEventHandler
implements EnumAppComponentEvents EnumRibbonEvents
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericEventHandler
     ↳ com.microstrategy.web.beans.SysEventHandler
       ↳ com.microstrategy.web.app.beans.RibbonEventHandlerImpl

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.beans.SysEventHandler
From class com.microstrategy.web.beans.GenericEventHandler
From interface com.microstrategy.web.app.beans.EnumAppComponentEvents
From interface com.microstrategy.web.app.beans.EnumRibbonEvents
From interface com.microstrategy.web.beans.WebEventTags
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Constructors
RibbonEventHandlerImpl()
Public Methods
Class getSupportedWebComponentType()
Returns the WebComponent class by default.
boolean processRequest(RequestKeys keys)
handle request as specified by the RequestKeys
void setWebComponent(WebComponent component)
Set the corresponding web component for this event handler
Protected Methods
AppComponent getAppComponent()
String getArgumentValue(WebEvent event, int argID)
Utility method to obtain the value of a given event argument
int getCurrentEventID()
WebComponent getRibbon()
boolean handleGenericEvent(RequestKeys keys)
Handles all the events from the ribbon toolbars, it's just a fachade for the real event execution
boolean handleSetTopLeftPosition(RequestKeys keys)
Utility method for processing a location change request, by manipulating the top and left properties of the instance
[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

Public Constructors

public RibbonEventHandlerImpl ()

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)

handle request as specified by the RequestKeys

Parameters
keys input request
Returns
  • true means some event is handled, false means nothing is handled
Throws
WebException if an exception is found.

public void setWebComponent (WebComponent component)

Set the corresponding web component for this event handler

Parameters
component the input web component

Protected Methods

protected AppComponent getAppComponent ()

Returns

protected 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

protected int getCurrentEventID ()

Returns
  • integer value corresponding to the event currently being handled

protected WebComponent getRibbon ()

Returns
  • WebComponent ribbon instance attached to this event handler

protected boolean handleGenericEvent (RequestKeys keys)

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.

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