public class

FolderFrameEventHandler

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

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.beans.WebEventTags
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.GenericEventHandler
Public Constructors
FolderFrameEventHandler()
Public Methods
Class getSupportedWebComponentType()
Returns the WebComponent class by default.
boolean processRequest(RequestKeys requestKeys)
Handle the request specified by the RequestKeys
void setWebComponent(WebComponent component)
Set the corresponding web component.
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 Constructors

public FolderFrameEventHandler ()

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 requestKeys)

Handle the request specified by the RequestKeys

Parameters
requestKeys RequestKeys instance with the input request
Returns
  • True meaning some event is handled, or False meaning nothing was handled
Throws
WebException if an error ocurrs while handling the request

public void setWebComponent (WebComponent component)

Set the corresponding web component.
It should be of type FolderFrameBean 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