Package com.microstrategy.web.app.transforms

Class InboxListTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    @Deprecated
public class InboxListTransform
extends AbstractAppTransform
    Deprecated.
    Use InboxListXHTMLTransform instead.

    Title: InboxListTransform.

    Description: This implements a simple Inbox Transform. It shows all the elements from the history list of the current user.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • LEVEL_WITHOUT_HEADER

        public static final int LEVEL_WITHOUT_HEADER
        Deprecated.
        See Also:
        Constant Field Values

      • LEVEL_WITHOUT_FOOTER

        public static final int LEVEL_WITHOUT_FOOTER
        Deprecated.
        See Also:
        Constant Field Values

      • LEVEL_EXPORT_EXCEL

        public static final int LEVEL_EXPORT_EXCEL
        Deprecated.
        See Also:
        Constant Field Values

      • LEVEL_STATUS_WITHOUT_UNREAD

        public static final int LEVEL_STATUS_WITHOUT_UNREAD
        Deprecated.
        See Also:
        Constant Field Values

      • cssHeader

        protected java.lang.String cssHeader
        Deprecated.

      • cssStatus

        protected java.lang.String cssStatus
        Deprecated.

      • cssHighlight

        protected java.lang.String cssHighlight
        Deprecated.

      • cssMessage

        protected java.lang.String cssMessage
        Deprecated.

      • cssReadMessage

        protected java.lang.String cssReadMessage
        Deprecated.

      • cssChildMessage

        protected java.lang.String cssChildMessage
        Deprecated.

      • cssChildReadMessage

        protected java.lang.String cssChildReadMessage
        Deprecated.

      • cssSeparator

        protected java.lang.String cssSeparator
        Deprecated.

      • imgChild

        public FormalParameter imgChild
        Deprecated.
        Specifies the image file name used by the transform to display the document's children reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image for this icon, you would need
        to copy it to the images folder and then specify its name in this formal parameter.

      • imgCollapse

        public FormalParameter imgCollapse
        Deprecated.
        Specifies the image file name used by the transform to display a collapsable object.
        It is used to collapse the contents of the document object when its children reports are displayed.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the collapsable object, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgExpand

        public FormalParameter imgExpand
        Deprecated.
        Specifies the image file name used by the transform to display an expandable object.
        It is used to expand the contents of the document object by showing its children reports..
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the expandable object, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgInfo

        public FormalParameter imgInfo
        Deprecated.
        Specifies the image file name used by the transform to display the info icon.
        It is used to show the details of the report or document objects contained in the history list.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the info icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgGraph

        public FormalParameter imgGraph
        Deprecated.
        Specifies the image file name used by the transform to display the graph icon.
        It is used to represent graph reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgReport

        public FormalParameter imgReport
        Deprecated.
        Specifies the image file name used by the transform to display the grid icon.
        It is used to represent grid reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgDatamart

        public FormalParameter imgDatamart
        Deprecated.
        Specifies the image file name used by the transform to display the datamart report icon.
        It is used to represent datamart reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to datamart report, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgGridGraph

        public FormalParameter imgGridGraph
        Deprecated.
        Specifies the image file name used by the transform to display the grid-graph icon.
        It is used to represent grid-graph reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the grid-graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgDocument

        public FormalParameter imgDocument
        Deprecated.
        Specifies the image file name used by the transform to display the document icon.
        It is used to represent document objects.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgRWDocument

        public FormalParameter imgRWDocument
        Deprecated.
        Specifies the image file name used by the transform to display the report writing document icon.
        It is used to represent document objects.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.0

      • imgGraphWait

        public FormalParameter imgGraphWait
        Deprecated.
        Specifies the image file name used by the transform to display the running graph icon.
        This image will appear when the graph report is still running in the I-Server.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the running graphs icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgReportWait

        public FormalParameter imgReportWait
        Deprecated.
        Specifies the image file name used by the transform to display the running grid icon.
        This image will appear when the grid report is still running in the I-Server.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the running grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgDocumentWait

        public FormalParameter imgDocumentWait
        Deprecated.
        Specifies the image file name used by the transform to display the ruuning document icon.
        This image will appear when the document object is still running in the I-Server.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgRWDocumentWait

        public FormalParameter imgRWDocumentWait
        Deprecated.
        Specifies the image file name used by the transform to display the running report writing document icon.
        This image will appear when the document object is still running in the I-Server.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.0

      • imgDatamartWait

        public FormalParameter imgDatamartWait
        Deprecated.
        Specifies the image file name used by the transform to display the running datamart icon.
        This image will appear when the datamart is still running in the I-Server.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the datamart icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.1

      • imgGraphError

        public FormalParameter imgGraphError
        Deprecated.
        Specifies the image file name used by the transform to represent errors in a graph report.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the errors in a graph report, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgReportError

        public FormalParameter imgReportError
        Deprecated.
        Specifies the image file name used by the transform to represent errors in a grid report.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the errors in a grid report, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgDocumentError

        public FormalParameter imgDocumentError
        Deprecated.
        Specifies the image file name used by the transform to represent errors in a document object.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the errors in a document object, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgRWDocumentError

        public FormalParameter imgRWDocumentError
        Deprecated.
        Specifies the image file name used by the transform to represent errors in a report writing document object.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the errors in a report writing document object, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.0

      • imgDatamartError

        public FormalParameter imgDatamartError
        Deprecated.
        Specifies the image file name used by the transform to represent errors in a datamart object.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the errors in a datamart object, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.1

      • imgGraphScheduled

        public FormalParameter imgGraphScheduled
        Deprecated.
        Specifies the image file name used by the transform to represent scheduled graph reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the scheduled graph reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgReportScheduled

        public FormalParameter imgReportScheduled
        Deprecated.
        Specifies the image file name used by the transform to represent scheduled grid reports.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the scheduled grid reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgDocumentScheduled

        public FormalParameter imgDocumentScheduled
        Deprecated.
        Specifies the image file name used by the transform to represent scheduled document objects.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the scheduled document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgRWDocumentScheduled

        public FormalParameter imgRWDocumentScheduled
        Deprecated.
        Specifies the image file name used by the transform to represent scheduled report writing document objects.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the scheduled report writing document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.0

      • imgDatamartScheduled

        public FormalParameter imgDatamartScheduled
        Deprecated.
        Specifies the image file name used by the transform to represent scheduled datamart objects.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the scheduled datamart, you would need to copy it to the images folder and then specify its name in this formal parameter.
        Since:
        MicroStrategy Web 7.5.1

      • imgReportSnapshot

        public FormalParameter imgReportSnapshot
        Deprecated.
        Specifies the image file name used by the transform to display the snapshot grid icon.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the snapshot grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgGraphSnapshot

        public FormalParameter imgGraphSnapshot
        Deprecated.
        Specifies the image file name used by the transform to display the snapshot graph icon.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the snapshot graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • levelFlagCache

        protected int levelFlagCache
        Deprecated.

      • allowReportExecutionOnDetails

        public FormalParameter allowReportExecutionOnDetails
        Deprecated.
        Specifies whether the user will be able to execute reports from the report details page.
        Allowed values:
        • true
        • false

        Usage:
        For example, if you allow to execute reports from the details page, then you would specify (true).

      • allowDocumentExecutionOnDetails

        public FormalParameter allowDocumentExecutionOnDetails
        Deprecated.
        Specifies whether the user will be able to execute documents from the document details page.
        Allowed values:
        • true
        • false

        Usage:
        For example, if you allow to execute documents from the details page, then you would specify (true).

      • imgSelect

        public FormalParameter imgSelect
        Deprecated.
        Specifies the image file name used by the transform to display options like export or PDF.
        It is used to indicate that certain options are available for the objects contained in the history list.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the options available, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgSortAscending

        public FormalParameter imgSortAscending
        Deprecated.
        Specifies the image file name used by the transform to display the sort ascending icon.
        It is used to indicate that the history list can be sorted ascending by the current column header.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgSortDescending

        public FormalParameter imgSortDescending
        Deprecated.
        Specifies the image file name used by the transform to display the sort descending icon.
        It is used to indicate that the history list can be sorted descinding by the current column header.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgActiveSortAscending

        public FormalParameter imgActiveSortAscending
        Deprecated.
        Specifies the image file name used by the transform to display the active sort ascending icon.
        It is used to indicate that the history list has been sorted ascending by the current column header.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the active sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • imgActiveSortDescending

        public FormalParameter imgActiveSortDescending
        Deprecated.
        Specifies the image file name used by the transform to display the active sort descending icon.
        It is used to indicate that the history list has been sorted descending by the current column header.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:
        For example, if you want to specify a different image to display the active sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.

      • showDeleteForm

        public FormalParameter showDeleteForm
        Deprecated.
        Specifies whether the transform will show the delete form.
        Allowed values:
        • true
        • false

        Usage:
        For example, if you want to show the delete form, then you would specify (true).

      • deleteTarget

        public FormalParameter deleteTarget
        Deprecated.
        Specifies the delete target page.
        Usage:
        For example, if you want to go to a specific target page when deleting an object,
        then you would need to specify the name in this formal parameter.

      • maxItemCount

        public FormalParameter maxItemCount
        Deprecated.
        Specifies the maximum number of objects to be displayed in the history list.
        The default value is -1, which indicates that all the objects will be rendered.
        Usage:
        For example, if you want to show only 5 objects in the history list, you would need to set (5) in this formal parameter.

    • Constructor Detail

      • InboxListTransform

        public InboxListTransform()
        Deprecated.
        Default constructor. Initialize all formal parameters

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Returns the descriptor to use in the Style Catalog.
        Returns:
        "This implements the transform for an Inbox Bean"

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Deprecated.
        Description copied from class: AbstractAppTransform

        This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

        This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the bean to transform.

      • renderInboxHeaders

        public void renderInboxHeaders​(MarkupOutput out)
        Deprecated.
        Writers the header of the history list
        Parameters:
        out - the output

      • renderNameHeader

        public void renderNameHeader​(MarkupOutput out,
                             java.lang.String header,
                             boolean centered,
                             WebEvent sortEvent)
        Deprecated.
        Writes a name header:
        Parameters:
        out - the output
        header - the header to display
        centered - whether this header is centered or not.
        sortEvent - the sort event.

      • renderStatusHeader

        public void renderStatusHeader​(MarkupOutput out,
                               java.lang.String header,
                               boolean centered,
                               WebEvent sortEvent)
        Deprecated.
        Writes a status header:
        Parameters:
        out - the output
        header - the header to display
        centered - whether this header is centered or not.
        sortEvent - the sort event.

      • renderExecutionTimeHeader

        public void renderExecutionTimeHeader​(MarkupOutput out,
                                      java.lang.String header,
                                      boolean centered,
                                      WebEvent sortEvent)
        Deprecated.
        Writes a last execution time header:
        Parameters:
        out - the output
        header - the header to display
        centered - whether this header is centered or not.
        sortEvent - the sort event.

      • renderHeader

        public void renderHeader​(MarkupOutput out,
                         java.lang.String header,
                         boolean centered)
        Deprecated.
        Writes a single header:
        Parameters:
        out - the output
        header - the header to display
        centered - whether this header is centered or not.

      • renderMessages

        public void renderMessages​(MarkupOutput out)
        Deprecated.
        Renders the available user messages
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        Since:
        MicroStrategy Web 8.0.0

      • renderEmtpyInbox

        public void renderEmtpyInbox​(MarkupOutput out)
        Deprecated.
        Invoked when there are no messages in the History List to display a "hisotyr list is empty" message
        Parameters:
        out - the output

      • renderDocumentMessage

        public void renderDocumentMessage​(MarkupOutput out,
                                  WebDocumentMessage message)
        Deprecated.
        Renders a document message and if expanded, all the submessages, that is, the messages of its children.
        Parameters:
        out - the output
        message - the message to display

      • renderRWMessage

        public void renderRWMessage​(MarkupOutput out,
                            RWMessage message)
        Deprecated.
        Renders a document message and if expanded, all the submessages, that is, the messages of its children.
        Parameters:
        out - the output
        message - the message to display
        Since:
        MicroStrategy Web 8.0.0

      • renderReportMessage

        public void renderReportMessage​(MarkupOutput out,
                                WebMessage message)
        Deprecated.
        Render a report message
        Parameters:
        out - the output
        message - the message to display

      • renderReportIconInfo

        public void renderReportIconInfo​(MarkupOutput out,
                                 WebMessage message)
        Deprecated.
        Render a report icon
        Parameters:
        out - the output
        message - the message to display

      • renderDocumentIconInfo

        public void renderDocumentIconInfo​(MarkupOutput out,
                                   WebDocumentMessage message)
        Deprecated.
        Render a document's icon
        Parameters:
        out - the output
        message - the message to display

      • renderRWIconInfo

        public void renderRWIconInfo​(MarkupOutput out,
                             RWMessage message)
        Deprecated.
        Render a document's icon
        Parameters:
        out - the output
        message - the message to display
        Since:
        MicroStrategy Web 8.0.0

      • renderExpandMessageIcon

        protected void renderExpandMessageIcon​(MarkupOutput out,
                                       WebMessage message)
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • renderNameInfo

        public void renderNameInfo​(MarkupOutput out,
                           WebMessage message)
        Deprecated.
        Render the name (title) of the message
        Parameters:
        out - the output
        message - the message to display

      • renderStatusInfo

        public void renderStatusInfo​(MarkupOutput out,
                             WebMessage message)
        Deprecated.
        Render the status of the message. If status is "read" then it also renders a link to mark as unread.
        Parameters:
        out - the output
        message - the message to display

      • renderTimeInfo

        public void renderTimeInfo​(MarkupOutput out,
                           WebMessage message)
        Deprecated.
        Renders the last modification time
        Parameters:
        out - the output
        message - the message to display

      • renderExportInfo

        public void renderExportInfo​(MarkupOutput out,
                             WebMessage message)
        Deprecated.
        Render an icon for exporting the report
        Parameters:
        out - the output
        message - the message to display

      • renderPDFExportInfo

        public void renderPDFExportInfo​(MarkupOutput out,
                                WebMessage message)
        Deprecated.
        Render an icon for exporting to PDF the report
        Parameters:
        out - the output
        message - the message to display

      • renderDetailsInfo

        public void renderDetailsInfo​(MarkupOutput out,
                              WebMessage message)
        Deprecated.
        Render an icon with a link for job details
        Parameters:
        out - the output
        message - the message to display

      • renderRemoveInfo

        public void renderRemoveInfo​(MarkupOutput out,
                             WebMessage message)
        Deprecated.
        Renders a checkbox so the user can remove the message
        Parameters:
        out - the output
        message - the message to display

      • renderInboxFooter

        public void renderInboxFooter​(MarkupOutput out)
        Deprecated.
        Renders a status bar message for the history list table
        Parameters:
        out - the output

      • renderHighlighted

        public void renderHighlighted​(MarkupOutput out,
                              java.lang.String message)
        Deprecated.
        renders a highlighted (bold) message:
        Parameters:
        out - output by this transform
        message - message to display highlighted

      • renderSeparator

        public void renderSeparator​(MarkupOutput out)
        Deprecated.
        renders a message separator line
        Parameters:
        out - output by this transform

      • renderImage

        public void renderImage​(MarkupOutput out,
                        java.lang.String image,
                        WebMessage message,
                        java.lang.String title)
        Deprecated.

      • renderImage

        public void renderImage​(MarkupOutput out,
                        java.lang.String image,
                        WebMessage message)
        Deprecated.
        Renders a transform's image
        Parameters:
        out - where to write the output of the method.
        image - the image name

      • getExecuteEvent

        protected WebEvent getExecuteEvent​(WebMessage message)
        Deprecated.
        Parameters:
        message - the message to display
        Returns:
        a WebEvent to execute the message (i.e., runReports)

      • getExportEvent

        protected WebEvent getExportEvent​(WebMessage message)
        Deprecated.
        Returns an initialized WebEvent to go to the Export page for an object. Currently this method handles only report objects.
        Parameters:
        message - the WebMessage instance which will be exported if the event is called.
        Returns:
        an initialized WebEvent object if the application supports it. Otherwise, will return null

      • getPDFExportEvent

        protected WebEvent getPDFExportEvent​(WebMessage message)
        Deprecated.
        Returns an initialized WebEvent to go to the PDF Export page for an object. Currently this method handles only report objects.
        Parameters:
        message - the WebMessage instance which will be exported if the event is called.
        Returns:
        an initialized WebEvent object if the application supports it. Otherwise, will return null

      • getDeleteEvent

        protected WebEvent getDeleteEvent()
        Deprecated.
        Returns the event used to remove messages from inbox
        Returns:
        EnumInboxBeanEvents.INBOX_EVENT_REMOVE_ALL_MESSAGES WebEvent.
        Since:
        MicroStrategy Web 8.0.0

      • generateDeleteForm

        protected void generateDeleteForm​(MarkupOutput transOut)
        Deprecated.
        Generate the delete confirmation form.

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Deprecated.
        Description copied from class: AbstractAppTransform
        Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example: 
         public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a root class/interface supported by this transform.