public class

ProjectBrowserEventHandler

extends SysEventHandler
implements EnumAppComponentEvents EnumProjectBrowserEvents
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericEventHandler
     ↳ com.microstrategy.web.beans.SysEventHandler
       ↳ com.microstrategy.web.app.beans.ProjectBrowserEventHandler

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.EnumProjectBrowserEvents
From interface com.microstrategy.web.beans.WebEventTags
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Methods
boolean processRequest(RequestKeys requestKeys)
This method encapsulates the logic to process incoming events without regard as to how it was triggered or be concerned with delegation the request (see processRequest(RequestKeys)).
void setWebComponent(WebComponent component)
Set the corresponding web component (should be of type ObjectBrowserBean) 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()
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 Methods

public boolean processRequest (RequestKeys requestKeys)

This method encapsulates the logic to process incoming events without regard as to how it was triggered or be concerned with delegation the request (see processRequest(RequestKeys)). Normally, this is invoked by handleRequest(RequestKeys).

Parameters
requestKeys 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.

public void setWebComponent (WebComponent component)

Set the corresponding web component (should be of type ObjectBrowserBean) 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 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