public class

SubscriptionsListXHTMLTransform

extends AbstractSubscriptionListTransform
implements LayoutTransform
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.AbstractSubscriptionListTransform
             ↳ com.microstrategy.web.app.transforms.SubscriptionsListXHTMLTransform
Known Direct Subclasses

Class Overview

This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.
The output of this Transform generates well-formed XHTML, and it's designed to use external css files for all formatting.

Summary

Constants
int LEVEL_HEADERS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SubscriptionsListXHTMLTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
String getDescription()
Returns the description of this transform to be used by the Style Catalog.
String getSummaryText()
Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed
boolean isSubscriptionPersonalized(WebSubscription subscription, WebObjectInfo target)
Determines if the schedule being analyzed has been personalized or not
void renderAddressInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's address object information
void renderEditInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void renderEditInfo(MarkupOutput out, String subscriptionID, WebObjectInfo target)
Renders a link to edit the subscription's
void renderEditPersonalizationInfo(MarkupOutput out, String subscriptionID, WebObjectInfo target)
void renderEditPersonalizationInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void renderEmptyList(MarkupOutput out)
Renders the HTML when there are no subscriptions to display.
void renderFormEnd(MarkupOutput out)
Renders the FORM tag end information.
void renderFormStart(MarkupOutput out)
Renders the FORM tag start information
void renderIconInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the icon associated with the subscription
void renderList(MarkupOutput out, SimpleList list)
Renders the list of elements available in the SubscriptionFolderBean being transformed
void renderNameInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the name of the subscription's target
void renderOwnerInfo(MarkupOutput out, WebSubscription subscription)
Renders the name of the subscription's target
void renderPersonalizedInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the information whether the subscription is personlized or not.
void renderRecipientInfo(MarkupOutput out, int rowIndex, WebSubscription subscription)
void renderRecipientInfo(MarkupOutput out, WebSubscription subscription)
This method is deprecated. renderRecipientInfo(MarkupOutput, int, WebSubscription) instead.
void renderRemoveInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void renderRemoveInfo(MarkupOutput out, String subscriptionID, WebObjectInfo target)
Renders a checkbox to remove the subscription's
void renderScheduleInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's schedule object information
void renderTitle(MarkupOutput out)
Render a main title associated with this transform.
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 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.
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.
RowTag generateItem(WebSubscription subscription, WebObjectInfo target)
Generates the RowTag instance corresponding to the information of the WebSubscription and WebObjectInfo sent in as parameters.
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.
int generateRecipientRows(ArrayList auxRows, int rowIndex, WebSubscription subscription, WebObjectInfo target)
TableTag generateTable()
Generates a TABLE HTML tag where all the contents of the transform to display will be added as rows of this table.
int getFieldCount()
Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.
int getRecipientCellIndex()
WebEvent getRemoveEvent()
Provides the remove event for the given list
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final int LEVEL_HEADERS

Constant Value: 128 (0x00000080)

Public Constructors

public SubscriptionsListXHTMLTransform ()

Default no-args 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 Narrowcast Subscriptions from a SubscriptionFolderBean.

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

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

public void renderAddressInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

Renders the subscription's address object information

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

public void renderEditInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

public void renderEditInfo (MarkupOutput out, 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

public void renderEditPersonalizationInfo (MarkupOutput out, String subscriptionID, WebObjectInfo target)

public void renderEditPersonalizationInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

public void renderEmptyList (MarkupOutput out)

Renders the HTML when there are no subscriptions to display.

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

public void renderFormEnd (MarkupOutput out)

Renders the FORM tag end information.

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

public void renderFormStart (MarkupOutput out)

Renders the FORM tag start information

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

public void renderIconInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

Renders the icon associated with the subscription

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

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, WebSubscription subscription, WebObjectInfo target)

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
target WebObjectInfo instance target of the schedule being rendered

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

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

public void renderRecipientInfo (MarkupOutput out, int rowIndex, WebSubscription subscription)

public void renderRecipientInfo (MarkupOutput out, WebSubscription subscription)

This method is deprecated.
renderRecipientInfo(MarkupOutput, int, WebSubscription) instead.

public void renderRemoveInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

public void renderRemoveInfo (MarkupOutput out, 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

public void renderScheduleInfo (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

Renders the subscription's schedule object information

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

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.

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=typ />
     <col class=nam />
     <col class=sch />
     <col class=adr />
     <col class=per />
   </colgroup>
 

Returns
  • Tag instance corresponding to the COLGROUP HTML tag.

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.

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
rowIndex index of the current Row. This will be used to render the show/hide button for recipients of multi-recipient subscription.
subscription WebSubscription instance to render
target WebObjectInfo instance target of the subscription being rendered
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.

protected RowTag generateItem (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
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.

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.

protected int generateRecipientRows (ArrayList auxRows, int rowIndex, WebSubscription subscription, WebObjectInfo target)

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.

protected int getFieldCount ()

Obtains the number of columns this transform is displaying, depending on which ones are enabled through the levelFlags formal parameter.

Returns
  • the number of columns to be displayed by this transform.

protected int getRecipientCellIndex ()

protected WebEvent getRemoveEvent ()

Provides the remove event for the given list

Returns