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

String	FP_DELIVERY_MODE
String	FP_IMG_DATAMART	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_DOCUMENT	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_GRAPH	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_GRID	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_GRID_GRAPH	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_RW_DOCUMENT	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_SORT_ASC	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_SORT_ASC_ACTIVE	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_SORT_DESC	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_IMG_SORT_DESC_ACTIVE	This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String	FP_LEVEL_FLAG
String	FP_MAX_ITEMS_COUNT
int	LEVEL_ALL	A flag to show all LEVEL items.
int	LEVEL_EDIT	Indicates to show a link to edit the subscription
int	LEVEL_ICON	Indicates to show the icon for the subscription.
int	LEVEL_NAME	Indicates to show the name of the target of the subscription.
int	LEVEL_OWNER	Indicates to show the time for the schedule message execution
int	LEVEL_PERSONALIZED	Indicates to show if the subscription is personalized (i.e., it has prompts).
int	LEVEL_RECIPIENT	Indicates to show the time for the schedule message execution
int	LEVEL_REMOVE	Indicates to show a link to delete the subscription
int	LEVEL_SORT_ICONS	Indicates to show the sorting icons
int	LEVEL_SUBSCRIPTION_NAME	Indicates to show the subscription name
int	LEVEL_TIME	Indicates to show the time for the schedule message execution

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

protected int	_deliveryMode
protected String	_imgActiveSortAscending	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgActiveSortDescending	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgDatamart	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgDocument	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgGraph	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgGrid	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgGridGraph	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgRwDocument	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgSortAscending	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String	_imgSortDescending	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected int	_levelFlag
protected int	_maxItemCount
protected SubscriptionFolderBean	_sfb
public FormalParameter	activeSortAscendingImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	activeSortDescendingImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	datamartImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	deliveryMode	Indicates which subscriptions this transform will be displaying based on delivery mode.
public FormalParameter	documentImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	graphImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	gridGraphImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	gridImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	levelFlag	Specifies what information is displayed for each subscription.
public FormalParameter	maxItemCount	Indicates how many subscriptions will be displayed in the list.
public FormalParameter	rwDocumentImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	sortAscendingImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter	sortDescendingImage	This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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.

Interfaces

Classes

SubscriptionsIconXHTMLTransform

Class Overview

Summary

Constants

public static final String FP_COLUMN_COUNT

Fields

public FormalParameter columnCount

Public Constructors

public SubscriptionsIconXHTMLTransform ()

Public Methods

public String getDescription ()

Returns

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

Parameters

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

Parameters

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

Parameters

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

public void renderEmptyList (MarkupOutput out)

Parameters

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

Parameters

public void renderList (MarkupOutput out, SimpleList list)

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

Protected Methods

protected Tag generateColumnGroup ()

Returns

protected RowTag[] generateItems (SimpleList list)

Parameters

Returns

protected TableTag generateTable ()

Returns

protected void generateTargetNameProps (JsonGenerator props, WebObjectInfo target)

protected boolean isMultipleRecipientAndEditable (WebSubscription subscription)