Package com.microstrategy.web.app.transforms

Class SubscriptionsIconXHTMLTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class SubscriptionsIconXHTMLTransform
extends AbstractSubscriptionListTransform
implements LayoutTransform
    This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean as Large Icons.
    The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.
    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • columnCount

        public FormalParameter columnCount
        Indicates the number of subscriptions displayed on each row.
        Defines in how many columns the subscriptions will be displayed. If this value is set to two, we will render two subscriptions on each line. This is the default behavior.

      • FP_COLUMN_COUNT

        public static final java.lang.String FP_COLUMN_COUNT
        Constant corresponding to the name of the columnCount formal parameter.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SubscriptionsIconXHTMLTransform

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

    • Method Detail

      • 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.

      • 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=largeIconView />
   </colgroup>
        Returns:
        Tag instance corresponding to the COLGROUP HTML tag.

      • 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 objects on the list being transformed. If no object is found to render, returns null.

      • renderSubscription

        public void renderSubscription​(MarkupOutput out,
                               WebSubscription subscription,
                               WebObjectInfo target,
                               int index)
        Renders a single subscription with an index
        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
        index - indicate the index of the subscription in the typed list

      • renderActionInformation

        public void renderActionInformation​(MarkupOutput out,
                                    WebSubscription subscription,
                                    WebObjectInfo target)
        Write out the information about the different actions that can be performed on this object. For example edit and delete links.
        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

      • renderPersonalizedInfo

        public void renderPersonalizedInfo​(MarkupOutput out,
                                   WebSubscription subscription,
                                   WebObjectInfo target)
        Renders the information whether the subscription is personlized or not (i.e., it is prompted)
        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

      • 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 as Large Icons.