Package com.microstrategy.web.app.beans
Class AbstractObjectExplorerEventHandler
- java.lang.Object
-
- com.microstrategy.web.beans.GenericEventHandler
-
- com.microstrategy.web.beans.SysEventHandler
-
- com.microstrategy.web.app.beans.AbstractObjectExplorerEventHandler
-
- All Implemented Interfaces:
EnumAppComponentEvents
,EnumFrameEditorEvents
,EnumPageEvents
,EnumServletEvents
,WebEventHandler
,WebEventTags
,java.lang.Cloneable
- Direct Known Subclasses:
DerivedElementsBrowserEventHandler
,FolderObjectExplorerEventHandler
,XDADataExplorerEventHandler
public abstract class AbstractObjectExplorerEventHandler extends SysEventHandler
This abstract class represents a basic event handler for anObjectExplorerBean
.
defines methods such as:
- handleBrowse(com.microstrategy.web.beans.RequestKeys)
- handleSearch(com.microstrategy.web.beans.RequestKeys)
- handleBrowseParent(com.microstrategy.web.beans.RequestKeys)
- Since:
- MicroStrategy Web 8.0.2
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler
GenericEventHandler.GenericEventKeys
-
-
Field Summary
Fields Modifier and Type Field Description protected FolderObjectExplorerBean
_folderObjectExplorer
-
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.EnumFrameEditorEvents
WebEventApply, WebEventCancel, WebEventClose, WebEventOk, WebEventOpen
-
Fields inherited from interface com.microstrategy.web.app.beans.EnumPageEvents
WebEventArgumentAddUnitButton, WebEventArgumentAnswerFormat, WebEventArgumentAnswerOptions, WebEventArgumentAttributeIdFormId, WebEventArgumentBean, WebEventArgumentBoneHeight, WebEventArgumentBoneName, WebEventArgumentBoneWidth, WebEventArgumentBrowserSettingName, WebEventArgumentBrowserSettingValue, WebEventArgumentClearExistinAndAddUnitsButton, WebEventArgumentExecutePromptedReport, WebEventArgumentFolderViewMode, WebEventArgumentLoadFile, WebEventArgumentLoadFileSeparator, WebEventArgumentNCSubscriptionsViewMode, WebEventArgumentPrefName, WebEventArgumentPrefValue, WebEventArgumentPromptFunction, WebEventArgumentRefreshOrigin, WebEventArgumentSaveFolderID, WebEventArgumentScreenMode, WebEventArgumentSecurityRolesViewMode, WebEventArgumentShowBean, WebEventArgumentShowBeanProperties, WebEventArgumentSubscriptionsViewMode, WebEventArgumentTextFileAnswer, WebEventArgumentUnitsToAdd, WebEventArgumentUserManagerViewModeType, WebEventChangeFolderViewMode, WebEventChangeSecurityRolesViewMode, WebEventChangeSubscriptionsViewMode, WebEventChangeUserManagerViewModeType, WebEventRefresh, WebEventSetPermanentBrowserSetting, WebEventSetSaveFolderID, WebEventSetSessionBrowserSetting, WebEventShowBean, WebEventSwitchScreenMode, WebEventUpdateBoneProperty, WebEventUpdatePreference
-
Fields inherited from interface com.microstrategy.web.app.beans.EnumServletEvents
RWebEventArgumentIMPORTAFTERSAVE, WebEventAddCacheSubscription, WebEventAddInboxSubscription, WebEventAddMobileSubscription, WebEventAddPersonalViewSubscription, WebEventAddSubscription, WebEventAdminOpenHome, WebEventArgumentActionType, WebEventArgumentAdvancedOption, WebEventArgumentAllowExecute, WebEventArgumentAnalysisAddMode, WebEventArgumentAnalysisID, WebEventArgumentApplyChangesFirst, WebEventArgumentAuthenticationMode, WebEventArgumentBeansState, WebEventArgumentCheckLogin, WebEventArgumentClearPage, WebEventArgumentConvertDashboardToDoc, WebEventArgumentCubeName, WebEventArgumentCubeReportId, WebEventArgumentDocumentID, WebEventArgumentDocumentViewMode, WebEventArgumentDrillDisplayMode, WebEventArgumentDrillElementList, WebEventArgumentDrillFilterOnPageBy, WebEventArgumentDrillGraphPixelX, WebEventArgumentDrillGraphPixelY, WebEventArgumentDrillPathKey, WebEventArgumentDrillRetainParent, WebEventArgumentDrillRetainThreshold, WebEventArgumentEventToForwardTo, WebEventArgumentExportDefaultRunMode, WebEventArgumentExportExpandPageByFields, WebEventArgumentexportFilterDetails, WebEventArgumentExportFormatNameGraphs, WebEventArgumentExportFormatNameGrids, WebEventArgumentExportFromOptions, WebEventArgumentExportHeadersAsText, WebEventArgumentExportMetricValuesAsText, WebEventArgumentExportOfficeRefresh, WebEventArgumentExportOverlapGridTitles, WebEventArgumentExportSection, WebEventArgumentExportTextDelimiter, WebEventArgumentExportUseLiveChartGraphs, WebEventArgumentExportUseSeparateSheets, WebEventArgumentFacebookToken, WebEventArgumentFastExportLink, WebEventArgumentFolderId, WebEventArgumentFolderName, WebEventArgumentFolderType, WebEventArgumentFromPageHistory, WebEventArgumentGraphHeight, WebEventArgumentGraphRequestId, WebEventArgumentGraphShrinkHeight, WebEventArgumentGraphShrinkWidth, WebEventArgumentGraphWidth, WebEventArgumentIgnoreGraphHeightWidth, WebEventArgumentIsAdminHelp, WebEventArgumentIsContinueForm, WebEventArgumentIsCubeEdit, WebEventArgumentIsCubeRepublish, WebEventArgumentIsFFSQL, WebEventArgumentIsFromPrompt, WebEventArgumentIsNew, WebEventArgumentIsNewAnalysis, WebEventArgumentLoginMode, WebEventArgumentMenuID, WebEventArgumentMenuOptionID, WebEventArgumentMessage, WebEventArgumentMessageID, WebEventArgumentNodeKey, WebEventArgumentNotAskExportOptions, WebEventArgumentObjectID, WebEventArgumentObjectType, WebEventArgumentParentFolderId, WebEventArgumentPDFAdminFooterFile, WebEventArgumentPDFAdminHeaderFile, WebEventArgumentPDFCoverPageFilterDetails, WebEventArgumentPDFExpandPageByFields, WebEventArgumentPDFExportFilename, WebEventArgumentPDFExportSection, WebEventArgumentPDFFitToPagesTall, WebEventArgumentPDFFitToPagesWide, WebEventArgumentPDFFooterCenterSection, WebEventArgumentPDFFooterLeftSection, WebEventArgumentPDFFooterRightSection, WebEventArgumentPDFHeaderCenterSection, WebEventArgumentPDFHeaderLeftSection, WebEventArgumentPDFHeaderRightSection, WebEventArgumentPDFMarginSizeBottom, WebEventArgumentPDFMarginSizeLeft, WebEventArgumentPDFMarginSizeRight, WebEventArgumentPDFMarginSizeTop, WebEventArgumentPDFMaxCells, WebEventArgumentPDFMaxFooterSize, WebEventArgumentPDFMaxHeaderSize, WebEventArgumentPDFOutlineModeState, WebEventArgumentPDFPaperOrientationOption, WebEventArgumentPDFPaperSize, WebEventArgumentPDFScalingOption, WebEventArgumentPDFShowOptions, WebEventArgumentPDFShrinkFontPercentage, WebEventArgumentPortNumber, WebEventArgumentPreferenceGroup, WebEventArgumentPreferenceGroupSet, WebEventArgumentPreferenceTransform, WebEventArgumentPrintAdminFooterFile, WebEventArgumentPrintAdminHeaderFile, WebEventArgumentPrintCoverPageFilterDetails, WebEventArgumentPrintDefaultColsPerPage, WebEventArgumentPrintDefaultRowsPerPage, WebEventArgumentPrintDisplayPopupPrintDialog, WebEventArgumentPrintExpandPagebyFields, WebEventArgumentPrintFitColsToPage, WebEventArgumentPrintFitRowsToPage, WebEventArgumentPrintFooterCenterSection, WebEventArgumentPrintFooterLeftSection, WebEventArgumentPrintFooterRightSection, WebEventArgumentPrintGridColsPerPage, WebEventArgumentPrintGridGraphSamePage, WebEventArgumentPrintGridRowsPerPage, WebEventArgumentPrintHeaderCenterSection, WebEventArgumentPrintHeaderLeftSection, WebEventArgumentPrintHeaderRightSection, WebEventArgumentPrintMarginSizeBottom, WebEventArgumentPrintMarginSizeLeft, WebEventArgumentPrintMarginSizeRight, WebEventArgumentPrintMarginSizeTop, WebEventArgumentPrintMaxCellsPerBlock, WebEventArgumentPrintMaxColsPerPage, WebEventArgumentPrintMaxFooterSize, WebEventArgumentPrintMaxGraphsPerBlock, WebEventArgumentPrintMaxHeaderSize, WebEventArgumentPrintMaxRowsPerPage, WebEventArgumentPrintOpenNewWindow, WebEventArgumentPrintPaperOrientationOption, WebEventArgumentPrintPaperSize, WebEventArgumentPrintScalingOption, WebEventArgumentPrintShowOptionsOnPrint, WebEventArgumentPrintShrinkFontPercentage, WebEventArgumentProjectName, WebEventArgumentPromptExpressionType, WebEventArgumentPromptStyle, WebEventArgumentQueryBuild, WebEventArgumentRelativePageNumber, WebEventArgumentReportDesignMode, WebEventArgumentReportFilterID, WebEventArgumentReportParentFolderID, WebEventArgumentReportStateID, WebEventArgumentReportTemplateID, WebEventArgumentReportViewMode, WebEventArgumentRWCreationFlags, WebEventArgumentRWCreationTemplateID, WebEventArgumentRWExecutionMode, WebEventArgumentRWExportMode, WebEventArgumentRWPageByElements, WebEventArgumentRWViewMode, WebEventArgumentSaveAsOrigin, WebEventArgumentSaveAsOriginPath, WebEventArgumentSaveAsShowContinueButton, WebEventArgumentScheduleEditMode, WebEventArgumentSearchDomain, WebEventArgumentSearchString, WebEventArgumentServerAlias, WebEventArgumentServerName, WebEventArgumentSessionKey, WebEventArgumentShow, WebEventArgumentShowDefault, WebEventArgumentShowOptionsPage, WebEventArgumentShowServerProperties, WebEventArgumentSliceId, WebEventArgumentSourceId, WebEventArgumentSourceType, WebEventArgumentSubPage, WebEventArgumentSubscriptionDeliveryMode, WebEventArgumentSubscriptionID, WebEventArgumentTarget, WebEventArgumentTreeType, WebEventArgumentTriggerID, WebEventArgumentTwoStepVerificationCode, WebEventArgumentUpdateParentWindow, WebEventArgumentUserId, WebEventArgumentUserName, WebEventArgumentUserPassword, WebEventCallChangePassword, WebEventCloseDashboardPage, WebEventCreateBlankVI, WebEventCreateHTML5VI, WebEventCreateOptimizedVI, WebEventCreatePrompt, WebEventCreateSecurityRole, WebEventCreateUser, WebEventCreateUserGroup, WebEventDashboardPublishWizard, WebEventDeleteHistoryList, WebEventDeleteObject, WebEventDisplayError, WebEventDrillToFixedTemplateFromDocToReport, WebEventEditCacheSubscription, WebEventEditInboxSubscription, WebEventEditMobileSubscription, WebEventEditPersonalViewSubscription, WebEventEditPrompt, WebEventEditReport, WebEventEditRW, WebEventEditSecurityRole, WebEventEditSubscription, WebEventEditUser, WebEventEditUserGroup, WebEventExecuteHTML5VI, WebEventExecuteMojoIVE, WebEventExecuteRWDocumentHeavy, WebEventExportSaveReportProperties, WebEventFastDocumentExport, WebEventFastExport, WebEventFastPDFExport, WebEventForwardToRWExport, WebEventGeneric, WebEventGetDocumentDetails, WebEventGetReportDetails, WebEventGetRWDocumentDetails, WebEventGraphDrillFromDocToReport, WebEventGridDrillFromDocToReport, WebEventHTMLMenu, WebEventInitializeHTML5VIFromSubscription, WebEventIPadAnnotation, WebEventLoadGraph, WebEventLogout, WebEventNCAddFileSubscription, WebEventNCAddFTPSubscription, WebEventNCAddPrintSubscription, WebEventNCAddresses, WebEventNCAddSubscription, WebEventNCEditFileSubscription, WebEventNCEditFTPSubscription, WebEventNCEditPrintSubscription, WebEventNCEditSubscription, WebEventNCFileAddresses, WebEventNCFTPAddresses, WebEventNCOpenDeleteAddress, WebEventNCPrintAddresses, WebEventNCSendNow, WebEventNCSendNowConfirm, WebEventNCSubsConfirm, WebEventOpenAbout, WebEventOpenAdminFAQs, WebEventOpenAdminHelp, WebEventOpenAdminHelpIndex, WebEventOpenCreate, WebEventOpenCreateDocument, WebEventOpenCreatePromptPage, WebEventOpenDefaultDesktop, WebEventOpenDefaultHomePage, WebEventOpenDesktop, WebEventOpenDiagnostics, WebEventOpenExport, WebEventOpenExportDocument, WebEventOpenExportOptions, WebEventOpenExportOptionsFromReport, WebEventOpenFAQs, WebEventOpenFilterEditor, WebEventOpenHelp, WebEventOpenHelpIndex, WebEventOpenHelpSetup, WebEventOpenHistoryList, WebEventOpenHistoryPage, WebEventOpenHome, WebEventOpenImportWizard, WebEventOpenImportWizardEntryPage, WebEventOpenIPAConfiguration, WebEventOpenIPAMonitor, WebEventOpenMyPage, WebEventOpenMyReports, WebEventOpenMySubscriptions, WebEventOpenObjectSubscriptions, WebEventOpenOfficeSetup, WebEventOpenOptimizedVI, WebEventOpenPage, WebEventOpenPDFOptions, WebEventOpenPDFOptionsFromReport, WebEventOpenPDFSaveReportProperties, WebEventOpenPreferences, WebEventOpenPrint, WebEventOpenPrintDocument, WebEventOpenPrintOptions, WebEventOpenPrintOptionsFromReport, WebEventOpenPrintSaveReportProperties, WebEventOpenQBuilder, WebEventOpenRRAccountSetting, WebEventOpenRRQuoteAcceptanceForm, WebEventopenRRUserImport, WebEventOpenRRUserManagement, WebEventOpenSaveReportProperties, WebEventOpenSchedule, WebEventOpenSearch, WebEventOpenSecurityRolesFolder, WebEventOpenSecuritySetup, WebEventOpenSharedReports, WebEventOpenSubscriptionEngineSetup, WebEventOpenSummary, WebEventOpenTopLevelUserGroups, WebEventOpenWizard, WebEventPDFDisplay, WebEventPrefColorPalette, WebEventPrefDynamicAddresseList, WebEventProcessLogin, WebEventQuickLogout, WebEventReportFlashExport, WebEventReportWritingDocumentPDFExport, WebEventReportWritingDocumentPDFFastExport, WebEventReturnTo, WebEventRunSearch, WebEventRWDHTMLExport, WebEventRWExport, WebEventRWSaveAs, WebEventSaveAs, WebEventSelectFilter, WebEventSelectTemplate, WebEventTakeMeHome, WebOpenAnalysis, WebOpenPrefChangePwdPage
-
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
-
-
Constructor Summary
Constructors Constructor Description AbstractObjectExplorerEventHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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 argumentprotected int
getCurrentEventID()
protected WebComponent
getEditor()
boolean
handleApply(RequestKeys keys)
Handles apply event.abstract boolean
handleBrowse(RequestKeys keys)
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerBrowse
abstract boolean
handleBrowseParent(RequestKeys keys)
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerBrowseParent
protected boolean
handleCancel(RequestKeys keys)
Handles Cancel event, which basically means close, so just calls thehandleClose
abstract boolean
handleChangeDisplayFormat(RequestKeys keys)
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerChangeDisplayFormat
protected boolean
handleClose(RequestKeys keys)
Handles close event, asks the ReportFrameBean to close the editor.protected boolean
handleOk(RequestKeys keys)
Handles Ok event.protected boolean
handleOpen(RequestKeys keys)
Handles open event, asks the ReportFrameBean to open the editor.abstract boolean
handleSearch(RequestKeys keys)
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerSearch
protected boolean
handleSetTopLeftPosition(RequestKeys keys)
Utility method for processing a location change request, by manipulating the top and left properties of the instanceboolean
processRequest(RequestKeys keys)
handle request as specified by the RequestKeysvoid
setWebComponent(WebComponent component)
Set the corresponding web component (should be of DrillFilterEditorBean type) 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
-
-
-
-
Field Detail
-
_folderObjectExplorer
protected FolderObjectExplorerBean _folderObjectExplorer
-
-
Method Detail
-
processRequest
public boolean processRequest(RequestKeys keys) throws WebException
handle request as specified by the RequestKeys- Specified by:
processRequest
in interfaceWebEventHandler
- Parameters:
keys
- input request- Returns:
- true means some event is handled, false means nothing is handled
- Throws:
WebException
- if an exception is found.
-
handleApply
public boolean handleApply(RequestKeys keys) throws WebException
Handles apply event. This event is abstract, each editor defines what does apply means to it.- Parameters:
keys
- the RequestKeys- Returns:
- true if the apply was handled.
- Throws:
WebException
- if an exception is found.
-
handleBrowse
public abstract boolean handleBrowse(RequestKeys keys) throws WebException
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerBrowse
- Parameters:
keys
- The request keys- Returns:
- whether the event was handled
- Throws:
WebException
-
handleSearch
public abstract boolean handleSearch(RequestKeys keys) throws WebException
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerSearch
- Parameters:
keys
- The request keys- Returns:
- whether the event was handled
- Throws:
WebException
-
handleBrowseParent
public abstract boolean handleBrowseParent(RequestKeys keys) throws WebException
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerBrowseParent
- Parameters:
keys
- The request keys- Returns:
- whether the event was handled
- Throws:
WebException
-
handleChangeDisplayFormat
public abstract boolean handleChangeDisplayFormat(RequestKeys keys) throws WebException
Handles the eventEnumObjectExplorerBeanEvents.WebEventObjectExplorerChangeDisplayFormat
- Parameters:
keys
- The request keys- Returns:
- whether the event was handled
- Throws:
WebException
- Since:
- MicroStrategy Web 9.0.0
-
setWebComponent
public void setWebComponent(WebComponent component)
Set the corresponding web component (should be of DrillFilterEditorBean type) for this event handler- Specified by:
setWebComponent
in interfaceWebEventHandler
- Parameters:
component
- the input web component
-
getEditor
protected WebComponent getEditor()
- Returns:
WebComponent
editor instance attached to this event handler
-
getCurrentEventID
protected int getCurrentEventID()
- Returns:
- integer value corresponding to the event currently being handled
-
handleOpen
protected boolean handleOpen(RequestKeys keys)
Handles open event, asks the ReportFrameBean to open the editor.- Parameters:
keys
- the RequestKeys- Returns:
- true if the editor was open
-
handleClose
protected boolean handleClose(RequestKeys keys)
Handles close event, asks the ReportFrameBean to close the editor.- Parameters:
keys
- the RequestKeys- Returns:
- true if the editor was closed
-
handleOk
protected boolean handleOk(RequestKeys keys) throws WebException
Handles Ok event. Ok means apply and close, therefor this event first callshandleApply
and thenhandleClose
defines what does apply means to it.- Parameters:
keys
- the RequestKeys- Returns:
- true if apply and close were handled.
- Throws:
WebException
- if an exception is found.
-
handleCancel
protected boolean handleCancel(RequestKeys keys)
Handles Cancel event, which basically means close, so just calls thehandleClose
- Parameters:
keys
- the RequestKeys- Returns:
- true if cancel was handled.
-
getAppComponent
protected AppComponent getAppComponent()
- Returns:
AppComponent
instance associated to this event handler
-
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 analyzeargID
- 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
-
-