Class AbstractObjectExplorerEventHandler

    • Constructor Detail

      • AbstractObjectExplorerEventHandler

        public AbstractObjectExplorerEventHandler()
    • Method Detail

      • processRequest

        public boolean processRequest​(RequestKeys keys)
                               throws WebException
        handle request as specified by the RequestKeys
        Specified by:
        processRequest in interface WebEventHandler
        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.
      • setWebComponent

        public void setWebComponent​(WebComponent component)
        Set the corresponding web component (should be of DrillFilterEditorBean type) for this event handler
        Specified by:
        setWebComponent in interface WebEventHandler
        Parameters:
        component - the input web component
      • 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 calls handleApply and then handleClose 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 the handleClose
        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 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