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

void	addEvent(WebEvent event) Adds a `WebEvent` instance into the current event handler.
void	addEvent(Element eventNode) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
void	addEvents(Element node) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
static void	addEventsFromRequestKeys(ArrayList eventList, RequestKeys keys, WebComponent component, SimpleList filterEventIDList)
void	addEventsFromXML(String eventsXML) This method is deprecated. The GenericEventHandler is not responsible to read the xml structure, therefore this method is not used anymore. Events should be added to an event handler using the Web Customization Editor
void	appendRemainingEvent(WebEvent event) Append an remaining event at the end of the remaining events' list.
Object	clone() Clone the current event handler instance.
boolean	delegateRequest(RequestKeys keys) The default implementation of this method simply delegates the event to the next source component specified in the static field `GenericWebEvent.URL_SOURCE_NAME`.
static int	getEventID(RequestKeys keys) Retrieves the event id passed in from the `RequestKeys`.
WebComponent	getEventTarget(RequestKeys keys)
int	getHandlerType() Returns the `type` of the current `WebEventHandle`.
String	getName() Returns the name of this event handler
String	getNextSourceName(RequestKeys keys) Returns the next component name in the event component path.
static String	getNextSourceName(String currentBeanPath, String eventFullPath) Returns the next source component which will handle the event.
static SimpleList	getOrderedEvents(RequestKeys keys, String errorDesc)
SimpleList	getPendingEvents() Returns the list of events that were not processed.
Class	getSupportedWebComponentType() Returns the `WebComponent` class by default.
WebComponent	getWebComponent() Returns the `WebComponent` object associated with the current event handler.
WebEvent	getWebEvent(RequestKeys keys) Decodes the `WebEvent` from the `RequestKeys`.
WebEvent	getWebEvent(int eventID, RequestKeys keys) This method should be used when the eventID passed in is different from the one that is included as a value in the keys parameter
WebEvent	getWebEvent(int eventID) Returns the specified `WebEvent` instance which this event handler supports.
Enumeration	getWebEvents() Returns an enumeration over the `WebEvent` suppored by this event handler.
Enumeration	getWebEventsFromRequest(RequestKeys keys) Returns an enumeration over the `WebEvent` suppored by this event handler that are present in the request keys provided.
boolean	handleRequest(RequestKeys keys) Handles the `WebEvent` specified in the `RequestKeys` object.
boolean	isInitialized() Returns `true` after the `markInitailized()` has been called.
boolean	isMyEvent(RequestKeys keys)
void	markInitailized() Call this method to mark this event-handler instance as initialized.
void	processExtraEvents()
static void	processMultipleEvents(String flatState, MultipleEventHandler handler, String componentPath) Processes multiple events encoded via the `FlatStateSerializer`.
static void	processMultipleEvents(String flatState, MultipleEventHandler handler) This method is deprecated. Use `processMultipleEvents(String, MultipleEventHandler, String)`
boolean	processRequest(RequestKeys keys) Logic to process the event.
void	setHandlerType(int type) Sets the `type` of the current event handler.
void	setName(String name) Sets the name to this event handler
void	setWebComponent(WebComponent component) Sets a `WebComponent` instance on this event handler.
void	validateRequiredArgument(String argName, String argValue) A helper method which ensures that the `argValue` corresponding to `argName` is not null and not empty.

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

AppComponent instance associated to this event handler

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

Interfaces

Classes

Exceptions

FolderFrameEventHandler

Summary

Public Constructors

public FolderFrameEventHandler ()

Public Methods

public Class getSupportedWebComponentType ()

Returns

See Also

public boolean processRequest (RequestKeys requestKeys)

Parameters

Returns

Throws

public void setWebComponent (WebComponent component)

Parameters

Protected Methods

protected AppComponent getAppComponent ()

Returns

protected String getArgumentValue (WebEvent event, int argID)

Parameters

Returns

protected int getCurrentEventID ()

Returns

protected boolean handleSetTopLeftPosition (RequestKeys keys)

Parameters

Returns