public class

SubscriptionsIconXHTMLTransform

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

Class Overview

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.

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.AbstractSubscriptionListTransform
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter columnCount Indicates the number of subscriptions displayed on each row.
[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
SubscriptionsIconXHTMLTransform()
Default no-args 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, WebSubscription subscription, WebObjectInfo target)
Write out the information about the different actions that can be performed on this object.
void renderAddressInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's address object information
void renderEditInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders a link to edit the subscription's
void renderEditPersonalizationInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void renderEmptyList(MarkupOutput out)
Renders the HTML when there are no subscriptions to display.
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 renderPersonalizedInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the information whether the subscription is personlized or not (i.e., it is prompted)
void renderRemoveInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders a link to remove the subscription's
void renderScheduleInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's schedule object information
void renderSubscription(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders a single subscription
void renderSubscription(MarkupOutput out, WebSubscription subscription, WebObjectInfo target, int index)
Renders a single subscription with an index
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.
void generateTargetNameProps(JsonGenerator props, WebObjectInfo target)
boolean isMultipleRecipientAndEditable(WebSubscription subscription)
[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 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 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.

Public Constructors

public SubscriptionsIconXHTMLTransform ()

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

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

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)

Renders a link to edit the subscription's

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

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

Renders a link to remove the subscription's

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 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 renderSubscription (MarkupOutput out, WebSubscription subscription, WebObjectInfo target)

Renders a single 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 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

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.

protected void generateTargetNameProps (JsonGenerator props, WebObjectInfo target)

protected boolean isMultipleRecipientAndEditable (WebSubscription subscription)