public class

SchedulesIconXHTMLTransform

extends AbstractScheduleListTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractScheduleListTransform
             ↳ com.microstrategy.web.app.transforms.SchedulesIconXHTMLTransform

This class is deprecated.
Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please use SubscriptionsIconXHTMLTransform instead.

Class Overview

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.

Summary

Constants
String FP_COLUMN_COUNT Constant corresponding to the name of the columnCount formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter columnCount Indicates the number of scheduled objects displayed on each row.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SchedulesIconXHTMLTransform()
Default no-arg constructor, initialize formal parameters
Public Methods
String getDescription()
Returns the description of this transform to be used by the Style Catalog.
void renderActionInformation(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Write out the information about the different actions that can be performed on this object.
void renderEditInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the link to edit the schedule being displayed
void renderEmptyList(MarkupOutput out)
Renders the HTML when there are no schedules to display.
void renderIconInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the icon information associated with the schedule to display.
void renderList(MarkupOutput out, SimpleList list)
Renders the list of elements available in the SubscriptionFolderBean being transformed
void renderNameInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the name of the schedule's target being displayed.
void renderPersonalizedInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the information whether the schedule is personlized or not (i.e., it is prompted)
void renderRemoveInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the checkbox to remove the schedule being displayed
void renderSchedule(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders a single schedule
void renderSchedules(MarkupOutput out)
Renders the list of the available schedules to display to the user
void renderTimeInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the message execution time for the schedule being displayed.
void renderTriggerInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Renders the schedule's trigger information
Protected Methods
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.
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.
TableTag generateTable()
Generates a TABLE HTML tag where all the contents of the transform to display will be added as rows of this table.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_COLUMN_COUNT

Constant corresponding to the name of the columnCount formal parameter.

Constant Value: "columnCount"

Fields

public FormalParameter columnCount

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.

Public Constructors

public SchedulesIconXHTMLTransform ()

Default no-arg constructor, initialize formal parameters

Public Methods

public String getDescription ()

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.

public void renderActionInformation (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderEditInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderEmptyList (MarkupOutput out)

Renders the HTML when there are no schedules to display.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderIconInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderList (MarkupOutput out, SimpleList list)

Renders the list of elements available in the SubscriptionFolderBean being transformed

Parameters
out MarkupOutput instance where the transform's output will be saved.
list a SimpleList instance with the list of schedules to render.

public void renderNameInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderPersonalizedInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderRemoveInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderSchedule (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

Renders a single schedule

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

public void renderSchedules (MarkupOutput out)

Renders the list of the available schedules to display to the user

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderTimeInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

public void renderTriggerInfo (MarkupOutput out, WebSchedule schedule, WebObjectInfo target)

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

Protected Methods

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.

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.

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.