Class RibbonEventHandlerImpl

    • Constructor Detail

      • RibbonEventHandlerImpl

        public RibbonEventHandlerImpl()
    • Method Detail

      • setWebComponent

        public void setWebComponent​(WebComponent component)
        Set the corresponding web component for this event handler
        Specified by:
        setWebComponent in interface WebEventHandler
        Parameters:
        component - the input web component
      • 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.
      • handleGenericEvent

        protected boolean handleGenericEvent​(RequestKeys keys)
                                      throws WebException
        Handles all the events from the ribbon toolbars, it's just a fachade for the real event execution
        Parameters:
        keys - the request should contain the bean and the event at least, in case the event requires extra arguments those can be sent in the form argName:value|argName1:value|....
        Returns:
        true means some event is handled, false means nothing is handled
        Throws:
        WebException - if an exception is found.
      • 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