Package com.microstrategy.web.app.transforms

Class SubscriptionsListTransform

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

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

SubscriptionsFilteredListTransform

public class SubscriptionsListTransform
extends AbstractSubscriptionListTransform

Deprecated.

Use SubscriptionsListXHTMLTransform instead.

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

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_imgCheck	Deprecated.
FormalParameter	checkImage	Deprecated. The name of the image used to indicate if the subscription is personalized.
static java.lang.String	FP_IMG_CHECK	Deprecated.
static int	LEVEL_HEADERS	Deprecated.

Fields inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform

CMD_EDIT, CMD_MULTIPLE, CMD_PERSONALIZATION, CMD_REMOVE, CMD_REMOVE_CHECKBOX, CMD_TARGET, CMD_TARGET_ICON, EXEC_TARGET, execTarget, LEVEL_ADDRESS, LEVEL_SCHEDULE, VIEW_MODE_BULK_EXPORT, VIEW_MODE_CUBE, VIEW_MODE_DASHBOARD, VIEW_MODE_DATAMART, VIEW_MODE_DOCUMENT, VIEW_MODE_GRAPH, VIEW_MODE_GRID, VIEW_MODE_GRID_GRAPH, VIEW_MODE_REPORT_IR, VIEW_MODE_RW_DOCUMENT

Fields inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform

_deliveryMode, _imgActiveSortAscending, _imgActiveSortDescending, _imgDatamart, _imgDocument, _imgGraph, _imgGrid, _imgGridGraph, _imgRwDocument, _imgSortAscending, _imgSortDescending, _levelFlag, _maxItemCount, _sfb, activeSortAscendingImage, activeSortDescendingImage, datamartImage, deliveryMode, documentImage, FP_DELIVERY_MODE, FP_IMG_DATAMART, FP_IMG_DOCUMENT, FP_IMG_GRAPH, FP_IMG_GRID, FP_IMG_GRID_GRAPH, FP_IMG_RW_DOCUMENT, FP_IMG_SORT_ASC, FP_IMG_SORT_ASC_ACTIVE, FP_IMG_SORT_DESC, FP_IMG_SORT_DESC_ACTIVE, FP_LEVEL_FLAG, FP_MAX_ITEMS_COUNT, graphImage, gridGraphImage, gridImage, LEVEL_ALL, LEVEL_EDIT, LEVEL_ICON, LEVEL_NAME, LEVEL_OWNER, LEVEL_PERSONALIZED, LEVEL_RECIPIENT, LEVEL_REMOVE, LEVEL_SORT_ICONS, LEVEL_SUBSCRIPTION_NAME, LEVEL_TIME, levelFlag, maxItemCount, rwDocumentImage, sortAscendingImage, sortDescendingImage

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
SubscriptionsListTransform()	Deprecated. Default no-args constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Deprecated. Returns the description of this transform to be used by the Style Catalog.
protected int	getFieldCount()	Deprecated.
void	initializeCss()	Deprecated. Extends initializeCss by intializing the classes this transform use.
void	initializeImages()	Deprecated. Initialize the images to be used by this transform.
void	renderAddressInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders the subscription's address object information
void	renderEditInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders a link to edit the subscription's
void	renderEmptyList(MarkupOutput out)	Deprecated. renders an empty list
void	renderFormEnd(MarkupOutput out)	Deprecated. renders the FORM tag end.
void	renderFormStart(MarkupOutput out)	Deprecated. renders the FORM tag start
void	renderHeaders(MarkupOutput out)	Deprecated. Renders the column headers
void	renderIconInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders the icon associated with the subscription
void	renderImage(MarkupOutput out, java.lang.String image)	Deprecated. Renders a transform's image
void	renderList(MarkupOutput out, SimpleList list)	Deprecated. Renders the list of components in the SubscriptionFolderBean
void	renderNameInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders the name of the subscription's target
void	renderPersonalizedInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders the information whether the subscription is personlized or not (i.e., it is prompted)
void	renderRemoveInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders a checkbox to remove the subscription's
void	renderScheduleInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders the subscription's schedule object information
void	renderSubscription(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)	Deprecated. Renders a single subscription

Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform

canSubscribe, canSubscribe, canTransform, generateBoneProperties, generateEditPersonalizationInfoAnchor, generateTargetNameProps, getCssName, getEditSubscriptionEvent, getEmptyListDescriptor, getExecuteEvent, getSubscriptionTarget, getViewMode, hasExecutePermission, isCurrentUserSubscriptionOwner, isDeliveryModeWithAddress, isEditSupported, isMultipleRecipientAndEditable, isViewableReport, renderRegisterBone, renderSubscriptionName, setBoneProperties, shouldRenderAction, transformForRequestInError

Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform

checkLevel, getImageTooltip, getJSGenerator, getPreferenceValue, getSubscriptionFolderBean, getSupportedBeanType, hasSubscriptions, initializeTransform, isDisplayInfoAvailable, isEmpty, renderFooter, renderImage, renderPersonalViewSubscriptions, renderShowMessage, renderSort, renderSubscriptionsByDeliveryMode, shouldShowPersonalViewSubscriptionsList, shouldShowSubscriptionsList, transformForRequestSuccessful

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.Transform

getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

LEVEL_HEADERS

public static final int LEVEL_HEADERS

Deprecated.

See Also:

Constant Field Values

FP_IMG_CHECK

public static final java.lang.String FP_IMG_CHECK

Deprecated.

See Also:

Constant Field Values

checkImage

public FormalParameter checkImage

Deprecated.

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"

_imgCheck

protected java.lang.String _imgCheck

Deprecated.

Constructor Detail

SubscriptionsListTransform

public SubscriptionsListTransform()

Deprecated.

Default no-args constructor, initialize formal parameters.

Method Detail

renderEmptyList

public void renderEmptyList(MarkupOutput out)

Deprecated.

renders an empty list

Specified by:

renderEmptyList in class AbstractSubscriptionFolderBeanTransform

Parameters:

out - output by this transform

renderList

public void renderList(MarkupOutput out,
                       SimpleList list)

Deprecated.

Renders the list of components in the SubscriptionFolderBean

Specified by:

renderList in class AbstractSubscriptionFolderBeanTransform

Parameters:

out - output by this transform

list - the list of subscriptions to render

renderHeaders

public void renderHeaders(MarkupOutput out)

Deprecated.

Renders the column headers

Parameters:

out - output by this transform

renderSubscription

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

Deprecated.

Renders a single subscription

Parameters:

out - the transform's output

subscription - the subscription to render

target - the target object of the subscription.

renderIconInfo

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

Deprecated.

Renders the icon associated with the subscription

Parameters:

out - the transform's output

subscription - the subscription to render

target - the subscription's target object

renderNameInfo

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

Deprecated.

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

renderPersonalizedInfo

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

Deprecated.

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

renderScheduleInfo

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

Deprecated.

Renders the subscription's schedule object information

Parameters:

out - the transform's output

subscription - the subscription to render

target - the subscription's target object

renderAddressInfo

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

Deprecated.

Renders the subscription's address object information

Parameters:

out - the transform's output

subscription - the subscription to render

target - the subscription's target object

renderEditInfo

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

Deprecated.

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

renderRemoveInfo

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

Deprecated.

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

renderFormStart

public void renderFormStart(MarkupOutput out)

Deprecated.

renders the FORM tag start

Parameters:

out - output by this transform

renderFormEnd

public void renderFormEnd(MarkupOutput out)

Deprecated.

renders the FORM tag end.

Parameters:

out - output by this transform

getFieldCount

protected int getFieldCount()

Deprecated.

Overrides:

getFieldCount in class AbstractSubscriptionFolderBeanTransform

Returns:

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

initializeImages

public void initializeImages()

Deprecated.

Initialize the images to be used by this transform.

Overrides:

initializeImages in class AbstractSubscriptionFolderBeanTransform

initializeCss

public void initializeCss()

Deprecated.

Extends initializeCss by intializing the classes this transform use.

Overrides:

initializeCss in class AbstractAppTransform

renderImage

public void renderImage(MarkupOutput out,
                        java.lang.String image)

Deprecated.

Renders a transform's image

Overrides:

renderImage in class AbstractSubscriptionFolderBeanTransform

Parameters:

out - where to write the output of the method.

image - the image name

getDescription

public java.lang.String getDescription()

Deprecated.

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.