Package com.microstrategy.web.app.transforms

Class InboxExtrasTransform

    • Field Detail

      • imgBullet

        public FormalParameter imgBullet
        Specifies the image file name used by the transform to display the bullet icon.
        This image should be contained in the images folder of the application.
        Usage:
        For example, if you want to specify a different image to display the bullet icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • FP_BULLET_IMAGE

        public static final java.lang.String FP_BULLET_IMAGE
        Constant specifying the name of the formal parameter for defining the bullet image. Value is imgBullet.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • InboxExtrasTransform

        public InboxExtrasTransform()
        Default no-argument constructor. Initializes formal parameters.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns the description of this Transform.
        Returns:
        "This implements the transform for an Inbox Bean"

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Get the class of objects this transform is able to handle.
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a Class instance with the information about the beans this transform is able to manipulate.

      • renderRefreshHistoryList

        public void renderRefreshHistoryList​(MarkupOutput out)
        Renders the option to refresh the history list.
        Parameters:
        out - MarkupOutput instance where to write the output of the method.

      • renderClearHistoryList

        public void renderClearHistoryList​(MarkupOutput out)
        Renders the option to clear the history list.
        Parameters:
        out - MarkupOutput instance where to write the output of the method.

      • renderExpandMessages

        public void renderExpandMessages​(MarkupOutput out)
        Renders the option to expand the document messages information (if applicable) on the history list.
        Parameters:
        out - MarkupOutput instance where to write the output of the method.

      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractAppTransform

      • getRefreshEvent

        protected WebEvent getRefreshEvent()
        Returns an initialized WebEvent to refresh the contents of the history list.
        Overrides:
        getRefreshEvent in class AbstractAppTransform
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.
        Since:
        MicroStrategy Web 8.0.0

      • getClearEvent

        protected WebEvent getClearEvent()
        Returns an initialized WebEvent to clear the contents of the history list.
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.
        Since:
        MicroStrategy Web 8.0.0

      • getExpandMessagesEvent

        protected WebEvent getExpandMessagesEvent()
        Returns an initialized WebEvent to expand the document messages information on the history list.
        Returns:
        the WebEvent instance initialized if possible, null if the application doesn't support it.
        Since:
        MicroStrategy Web 8.0.0

      • getSelectedMessageIDFromRequest

        protected java.lang.String getSelectedMessageIDFromRequest()
        Utility method for returning the selected message information if available on the request
        Returns:
        an empty String value if nothing was found, otherwise it will return the value of the argument found on the request.

      • getDocumentCount

        protected int getDocumentCount()
        Utility method
        Returns:
        the number of documents available on the inbox
        Since:
        MicroStrategy Web 8.0.0

      • getSelectedDocumentCount

        protected int getSelectedDocumentCount()
        Utility method
        Returns:
        the number of documents available on the inbox that have been selected by the user
        Since:
        MicroStrategy Web 8.0.0

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Overwrites the parent method by setting special attributes to the anchor as required by the caller.
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent instance from where the anchor will be constructed
        Returns:
        AnchorTag initialized instance with the information as provided by the arguments.
        Since:
        MicroStrategy Web 8.0.0