Package com.microstrategy.web.app.transforms

Class SubscriptionsListXHTMLTransform

    • Constructor Detail

      • SubscriptionsListXHTMLTransform

        public SubscriptionsListXHTMLTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • getSummaryText

        public java.lang.String getSummaryText()
        Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed
        Returns:
        String with the summary description for the table to render.

      • generateTable

        protected TableTag generateTable()
        Generates a TABLE HTML tag where all the contents of the transform to display will be added as rows of this table. Basic HTML attributes are defined to it, such as class.
        Returns:
        a TableTag instance defined, by default no rows or other information are added to it. Methods like generateHeadersRow and generateItems should be called for obtaining the information that shall be added to it.

      • generateColumnGroup

        protected Tag generateColumnGroup()
        Generates a COLGROUP HTML tag with COL tags defined for each one of the columns to be rendered on this list view transform. For example, the content might look like this: 
           <colgroup>
     <col class=typ />
     <col class=nam />
     <col class=sch />
     <col class=adr />
     <col class=per />
   </colgroup>
        Returns:
        Tag instance corresponding to the COLGROUP HTML tag.

      • generateHeadersRow

        protected RowTag generateHeadersRow​(SimpleList list)
        Generates a TR HTML tag with TD tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to the level formal parameter. For example, the content might look like this: 
           <tr>
     <td> </td>
     <td>Name</td>
     <td>Schedule</td>
     <td>Address</td>
     <td>Personalized</td>
   </tr>
        Parameters:
        list - SimpleList instance with the elements to render.
        Returns:
        RowTag instance corresponding to the TR HTML tag where the headers were defined.

      • generateItems

        protected RowTag[] generateItems​(SimpleList list)
        Analyzes all the items available to display and generates an array of RowTag instances (corresponding to TR HTML tags) with the information.
        Parameters:
        list - SimpleList instance with the elements to render.
        Returns:
        RowTag[] an array of RowTag instances, each one with the information of one object on the list being transformed. If no object is found to render, returns null.

      • getRecipientCellIndex

        protected int getRecipientCellIndex()
        Since:
        MicroStrategy Web 9.0.0

      • generateRecipientRows

        protected int generateRecipientRows​(java.util.ArrayList auxRows,
                                    int rowIndex,
                                    WebSubscription subscription,
                                    WebObjectInfo target)
        Since:
        MicroStrategy Web 9.0.0

      • generateItem

        protected RowTag generateItem​(int rowIndex,
                              WebSubscription subscription,
                              WebObjectInfo target)
        Generates the RowTag instance corresponding to the information of the WebSubscription and WebObjectInfo sent in as parameters.
        Parameters:
        subscription - WebSubscription instance to render
        target - WebObjectInfo instance target of the subscription being rendered
        rowIndex - index of the current Row. This will be used to render the show/hide button for recipients of multi-recipient subscription.
        Returns:
        a RowTag (TR HTML tag) with the information about the WebSubscription and WebObjectInfo target instances requested contained on CellTag child instances. For example, icon image, name, schedule information, etc.
        Since:
        MicroStrategy Web 9.0.0

      • renderTitle

        public void renderTitle​(MarkupOutput out)
        Render a main title associated with this transform. By default, nothing is displayed.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • renderOwnerInfo

        public void renderOwnerInfo​(MarkupOutput out,
                            WebSubscription subscription)
        Renders the name of the subscription's target
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        subscription - WebSubscription instance to render
        Since:
        MicroStrategy Web 9.0.0

      • renderRecipientInfo

        public void renderRecipientInfo​(MarkupOutput out,
                                int rowIndex,
                                WebSubscription subscription)
        Since:
        MicroStrategy Web 9.0.0

      • renderPersonalizedInfo

        public void renderPersonalizedInfo​(MarkupOutput out,
                                   WebSubscription subscription,
                                   WebObjectInfo target)
        Renders the information whether the subscription is personlized or not.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        subscription - WebSubscription instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • isSubscriptionPersonalized

        public boolean isSubscriptionPersonalized​(WebSubscription subscription,
                                          WebObjectInfo target)
        Determines if the schedule being analyzed has been personalized or not
        Parameters:
        subscription - WebSubscription instance to be tested
        target - WebObjectInfo instance target of the schedule being analyzed
        Returns:
        boolean value indicating if the schedule is personalized or not

      • renderEditInfo

        public void renderEditInfo​(MarkupOutput out,
                           java.lang.String subscriptionID,
                           WebObjectInfo target)
        Renders a link to edit the subscription's
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        subscriptionID - WebSubscription instance to render
        target - WebObjectInfo instance target of the schedule being rendered
        Since:
        MicroStrategy Web 9.0.0

      • renderEditPersonalizationInfo

        public void renderEditPersonalizationInfo​(MarkupOutput out,
                                          java.lang.String subscriptionID,
                                          WebObjectInfo target)
        Since:
        MicroStrategy Web 9.0.0

      • renderRemoveInfo

        public void renderRemoveInfo​(MarkupOutput out,
                             java.lang.String subscriptionID,
                             WebObjectInfo target)
        Renders a checkbox to remove the subscription's
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        subscriptionID - subscription ID to render
        target - WebObjectInfo instance target of the schedule being rendered
        Since:
        MicroStrategy Web 9.0.0

      • renderFormStart

        public void renderFormStart​(MarkupOutput out)
        Renders the FORM tag start information
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • renderFormEnd

        public void renderFormEnd​(MarkupOutput out)
        Renders the FORM tag end information.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • getFieldCount

        protected int getFieldCount()
        Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.
        Overrides:
        getFieldCount in class AbstractSubscriptionFolderBeanTransform
        Returns:
        the number of columns to be displayed by this transform.

      • getDescription

        public java.lang.String getDescription()
        Returns the description of this transform to be used by the Style Catalog.
        Specified by:
        getDescription in interface Transform
        Returns:
        This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.