Package com.microstrategy.web.app.beans

Class ProjectBrowserEventHandler

java.lang.Object

com.microstrategy.web.beans.GenericEventHandler

com.microstrategy.web.beans.SysEventHandler

com.microstrategy.web.app.beans.ProjectBrowserEventHandler

All Implemented Interfaces:

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

public class ProjectBrowserEventHandler
extends SysEventHandler
implements EnumProjectBrowserEvents

Since:

MicroStrategy Web 8.0.1

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.EnumProjectBrowserEvents

BROWSE_PATH_DELIMITER, PROJECT_BROWSER_EVENT_ARGUMENT_ATTRIBUTE_ID, PROJECT_BROWSER_EVENT_ARGUMENT_BLOCK_BEGIN, PROJECT_BROWSER_EVENT_ARGUMENT_BROWSE_PATH, PROJECT_BROWSER_EVENT_ARGUMENT_BROWSE_PATH_ELEMENT, PROJECT_BROWSER_EVENT_ARGUMENT_DIMENSION_ID, PROJECT_BROWSER_EVENT_ARGUMENT_DISPLAY_FORMAT, PROJECT_BROWSER_EVENT_ARGUMENT_ELEMENTS, PROJECT_BROWSER_EVENT_ARGUMENT_FOLDER_BLOCK_BEGIN, PROJECT_BROWSER_EVENT_ARGUMENT_FOLDER_ID, PROJECT_BROWSER_EVENT_ARGUMENT_FORMAT_BY_DATA_EXPLORER, PROJECT_BROWSER_EVENT_ARGUMENT_SEARCH_PATTERN, PROJECT_BROWSER_EVENT_ARGUMENT_UNIT, PROJECT_BROWSER_EVENT_CHANGE_DISPLAY_FORMAT, PROJECT_BROWSER_EVENT_DATA_EXPLORER_BROWSE, PROJECT_BROWSER_EVENT_DATA_EXPLORER_BROWSE_WITH_PATH, PROJECT_BROWSER_EVENT_DATA_EXPLORER_SEARCH, PROJECT_BROWSER_EVENT_MODIFY_GRID

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

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

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, getSupportedWebComponentType, 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

Method Detail

setWebComponent

public void setWebComponent(WebComponent component)

Set the corresponding web component (should be of type ObjectBrowserBean) for this event handler

Specified by:

setWebComponent in interface WebEventHandler

Parameters:

component - the input web component

processRequest

public boolean processRequest(RequestKeys requestKeys)
                       throws WebException

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 GenericEventHandler.handleRequest(RequestKeys).

Specified by:

processRequest in interface WebEventHandler

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.

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