Package com.microstrategy.web.app.transforms

Class SchedulesIconXHTMLTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class SchedulesIconXHTMLTransform
extends AbstractScheduleListTransform
    Deprecated.
    Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use SubscriptionsIconXHTMLTransform instead.
    This transform renders the list of Web 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
        Deprecated.
        Indicates the number of scheduled objects displayed on each row.
        Defines in how many columns the scheduled objects will be displayed. If this value is set to two, we will render two scheduled objects on each line. This is the default behavior.

      • FP_COLUMN_COUNT

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

    • Constructor Detail

      • SchedulesIconXHTMLTransform

        public SchedulesIconXHTMLTransform()
        Deprecated.
        Default no-arg constructor, initialize formal parameters

    • Method Detail

      • generateTable

        protected TableTag generateTable()
        Deprecated.
        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()
        Deprecated.
        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)
        Deprecated.
        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.

      • renderSchedules

        public void renderSchedules​(MarkupOutput out)
        Deprecated.
        Renders the list of the available schedules to display to the user
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.

      • renderActionInformation

        public void renderActionInformation​(MarkupOutput out,
                                    WebSchedule schedule,
                                    WebObjectInfo target)
        Deprecated.
        Write out the information about the different actions that can be performed on this object. For example edit and remove links.
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderIconInfo

        public void renderIconInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        Renders the icon information associated with the schedule to display.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderNameInfo

        public void renderNameInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        Renders the name of the schedule's target being displayed.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderPersonalizedInfo

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

      • renderTimeInfo

        public void renderTimeInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        Renders the message execution time for the schedule being displayed.
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderTriggerInfo

        public void renderTriggerInfo​(MarkupOutput out,
                              WebSchedule schedule,
                              WebObjectInfo target)
        Deprecated.
        Renders the schedule's trigger information
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderEditInfo

        public void renderEditInfo​(MarkupOutput out,
                           WebSchedule schedule,
                           WebObjectInfo target)
        Deprecated.
        Renders the link to edit the schedule being displayed
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • renderRemoveInfo

        public void renderRemoveInfo​(MarkupOutput out,
                             WebSchedule schedule,
                             WebObjectInfo target)
        Deprecated.
        Renders the checkbox to remove the schedule being displayed
        Parameters:
        out - MarkupOutput instance where the transform's output will be saved.
        schedule - WebSchedule instance to render
        target - WebObjectInfo instance target of the schedule being rendered

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Returns the description of this transform to be used by the Style Catalog.
        Returns:
        This transform renders the list of Web Subscriptions from a SubscriptionFolderBean as Large Icons.