public class

SubscriptionsListTransform

extends AbstractSubscriptionListTransform
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.SubscriptionsListTransform
Known Direct Subclasses

This class is deprecated.
Use SubscriptionsListXHTMLTransform instead.

Class Overview

This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.

Summary

Constants
String FP_IMG_CHECK
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
Fields
protected String _imgCheck
public FormalParameter checkImage The name of the image used to indicate if the subscription is personalized.
[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
SubscriptionsListTransform()
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 initializeCss()
Extends initializeCss by intializing the classes this transform use.
void initializeImages()
Initialize the images to be used by this transform.
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 renderEmptyList(MarkupOutput out)
renders an empty list
void renderFormEnd(MarkupOutput out)
renders the FORM tag end.
void renderFormStart(MarkupOutput out)
renders the FORM tag start
void renderHeaders(MarkupOutput out)
Renders the column headers
void renderIconInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the icon associated with the subscription
void renderImage(MarkupOutput out, String image)
Renders a transform's image
void renderList(MarkupOutput out, SimpleList list)
Renders the list of components in the SubscriptionFolderBean
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 checkbox 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
Protected Methods
int getFieldCount()
[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.Transform

Constants

public static final String FP_IMG_CHECK

Constant Value: "checkImage"

public static final int LEVEL_HEADERS

Constant Value: 128 (0x00000080)

Fields

protected String _imgCheck

public FormalParameter checkImage

The name of the image used to indicate if the subscription is personalized.
If a subscription is personalized by answering prompts we will render this image next to the subscription.
Usage:
"Check.gif"

Public Constructors

public SubscriptionsListTransform ()

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 void initializeCss ()

Extends initializeCss by intializing the classes this transform use.

public void initializeImages ()

Initialize the images to be used by this transform.

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

Renders the subscription's address object information

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

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

Renders a link to edit the subscription's

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

public void renderEmptyList (MarkupOutput out)

renders an empty list

Parameters
out output by this transform

public void renderFormEnd (MarkupOutput out)

renders the FORM tag end.

Parameters
out output by this transform

public void renderFormStart (MarkupOutput out)

renders the FORM tag start

Parameters
out output by this transform

public void renderHeaders (MarkupOutput out)

Renders the column headers

Parameters
out output by this transform

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

Renders the icon associated with the subscription

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

public void renderImage (MarkupOutput out, String image)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name

public void renderList (MarkupOutput out, SimpleList list)

Renders the list of components in the SubscriptionFolderBean

Parameters
out output by this transform
list the list of subscriptions to render

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

Renders the name of the subscription's target

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

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 the transform's output
subscription the subscription to render
target the subscription's target object

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

Renders a checkbox to remove the subscription's

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

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

Renders the subscription's schedule object information

Parameters
out the transform's output
subscription the subscription to render
target the subscription's target object

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

Renders a single subscription

Parameters
out the transform's output
subscription the subscription to render
target the target object of the subscription.

Protected Methods

protected int getFieldCount ()

Returns
  • the number fields this transform is displaying, this will depend on the fields that are enabled through the levelFlags formal parameter