Package com.microstrategy.web.admin.transforms

Class AbstractDiagnosticsTransform

    • Field Detail

      • _imgLeftCorner

        protected java.lang.String _imgLeftCorner
        Image to use for the left corner of the header to display.

      • _imgRightCorner

        protected java.lang.String _imgRightCorner
        Image to use for the right corner of the header to display

      • cssGlobal

        protected java.lang.String cssGlobal
        This property keeps the css style class name to use globally on the interface to display to the user.

      • cssHeaderTable

        protected java.lang.String cssHeaderTable
        This property keeps the css style class name to use for the main header to display on the interface.

      • cssMainTableHeading

        protected java.lang.String cssMainTableHeading
        This property keeps the css style class name to use for the table that will hold the table heading to display to the user.

    • Constructor Detail

      • AbstractDiagnosticsTransform

        public AbstractDiagnosticsTransform()
        Class constructor, initializes formal parameters.
        Since:
        MicroStrategy Web 8.0.0

    • Method Detail

      • renderDiagnosticOutput

        public abstract void renderDiagnosticOutput​(MarkupOutput out)
        Generate the output the transform instance is to generate for the DiagnosticsBean bean.
        Parameters:
        out - MarkupOutput instance where the contents to display by this transform are to be saved

      • initializeTransform

        public void initializeTransform​(Transformable data)
        This method initializes the private and protected fields of the transform. It also invokes the initializeImages() and initializeCss() methods and re-defines the values for the cssFile and cssPrefix formal parameters.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the Transformable data representing the bean that this instance is going to transform.

      • initializeCss

        public void initializeCss()
        Initialize the css classes to use while displaying this transform
        Overrides:
        initializeCss in class AbstractAppTransform

      • renderDialogHeader

        public void renderDialogHeader​(MarkupOutput out)
        Render the main dialog header to display to the user on the page
        Parameters:
        out - MarkupOutput instance where the HTML to display will be saved

      • getApplyDiagnosticsEvent

        protected WebEvent getApplyDiagnosticsEvent​(DiagnosticsBean bean)
        Generate the event that will be used for applying or saving the diagnostics configuration specified on the form.
        Parameters:
        bean - DiagnosticsBean being transformed
        Returns:
        a WebEvent with the corresponding event, null if the application does not support it.

      • getLoadDefaultsEvent

        protected WebEvent getLoadDefaultsEvent​(DiagnosticsBean bean)
        Generate the event that will be used for loading the default values of the diagnostics configuration specified on the form.
        Parameters:
        bean - DiagnosticsBean being transformed
        Returns:
        a WebEvent with the corresponding event, null if the application does not support it.

      • getArgumentName

        protected java.lang.String getArgumentName​(WebEvent event,
                                           int argumentId)
        Get the name of the argument assigned to the WebEvent, based on the indicated id. This method can be overwritten with an event-argumentId mapping in case the original event defined on the application is customized.
        Overrides:
        getArgumentName in class AbstractAppTransform
        Parameters:
        event - WebEvent from where the argument name will be retrieved
        argumentId - int with the identifier of the argument to search for on the event
        Returns:
        the corresponding name of the event for the specified id. If it is not found, it will return null.

      • getTitle

        protected abstract java.lang.String getTitle()
        Returns the title for the interface to display
        Returns:
        the text to display as title of the transform

      • renderSubmitButtons

        protected void renderSubmitButtons​(MarkupOutput out,
                                   WebEvent applyDiagnostics,
                                   WebEvent loadDefaults,
                                   java.lang.String applyString,
                                   java.lang.String loadString)
        Display the submit buttons corresponding to the saveDiagnostics event
        Parameters:
        out - MarkupOutput instance to modify
        applyDiagnostics - WebEvent instance with the initialized event for applying the properties
        loadDefaults - WebEvent instance with the initialized event for loading the original default values of the properties
        applyString - String with the descriptor for the button that will be used for applying the changes on the form.
        loadString - String with the descriptor for the button that will be used for loading default values on the form.