Package com.microstrategy.web.app.transforms

Class SubscriptionsFilteredListXHTMLTransform

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

com.microstrategy.web.app.transforms.SubscriptionsFilteredListXHTMLTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class SubscriptionsFilteredListXHTMLTransform
extends SubscriptionsListXHTMLTransform

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

Since:

MicroStrategy Web 8.0.0

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

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

LEVEL_HEADERS

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
SubscriptionsFilteredListXHTMLTransform()	Default no-args constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getAddSubscriptionEvent()	Get the event that will allow to add more subscriptions to the object.
java.lang.String	getDescription()	Returns the description of this transform to be used by the Style Catalog.
protected int	getRecipientCellIndex()
boolean	hasSubscriptionsOrCanSubscribe()
void	renderAddSubscriptionLink(MarkupOutput out)	Renders a link to add a new subscription.
void	renderEmptyList(MarkupOutput out)	Overwrites the parent method by testing if the target of the current subscription folder is of a valid type.
void	renderFooter(MarkupOutput out)	Render a general footer associated with this transform.
void	renderList(MarkupOutput out, SimpleList list)	Overwrites the parent method by testing if the target of the current subscription folder is of a valid type.
void	renderTitle(MarkupOutput out)	Render a main title associated with this transform.
boolean	shouldShowSubscriptionsList(int delMode)

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

generateColumnGroup, generateHeadersRow, generateItem, generateItem, generateItems, generateRecipientRows, generateTable, getFieldCount, getRemoveEvent, getSummaryText, isSubscriptionPersonalized, renderAddressInfo, renderEditInfo, renderEditInfo, renderEditPersonalizationInfo, renderEditPersonalizationInfo, renderFormEnd, renderFormStart, renderIconInfo, renderNameInfo, renderOwnerInfo, renderPersonalizedInfo, renderRecipientInfo, renderRecipientInfo, renderRemoveInfo, renderRemoveInfo, renderScheduleInfo

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, initializeImages, initializeTransform, isDisplayInfoAvailable, isEmpty, renderImage, renderImage, renderPersonalViewSubscriptions, renderShowMessage, renderSort, renderSubscriptionsByDeliveryMode, shouldShowPersonalViewSubscriptionsList, 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, initializeCss, 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.LayoutTransform

getLayoutDefinition, setLayoutDefinition

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

canTransform, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

SubscriptionsFilteredListXHTMLTransform

public SubscriptionsFilteredListXHTMLTransform()

Default no-args constructor, initialize formal parameters.

Method Detail

renderTitle

public void renderTitle(MarkupOutput out)

Render a main title associated with this transform. Overwrites the parent method by adding a header and subheader to the final display.

Overrides:

renderTitle in class SubscriptionsListXHTMLTransform

Parameters:

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

renderEmptyList

public void renderEmptyList(MarkupOutput out)

Overwrites the parent method by testing if the target of the current subscription folder is of a valid type.

Overrides:

renderEmptyList in class SubscriptionsListXHTMLTransform

Parameters:

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

renderList

public void renderList(MarkupOutput out,
                       SimpleList list)

Overwrites the parent method by testing if the target of the current subscription folder is of a valid type.

Overrides:

renderList in class SubscriptionsListXHTMLTransform

Parameters:

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

list - a SimpleList instance with the list of subscriptions to render.

renderFooter

public void renderFooter(MarkupOutput out)

Render a general footer associated with this transform. Overwrites the parent method by adding a link to add more subscriptions.

Overrides:

renderFooter in class AbstractSubscriptionFolderBeanTransform

Parameters:

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

renderAddSubscriptionLink

public void renderAddSubscriptionLink(MarkupOutput out)

Renders a link to add a new subscription. This is added as part of the footer of the transform.

Parameters:

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

getDescription

public java.lang.String getDescription()

Returns the description of this transform to be used by the Style Catalog.

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class SubscriptionsListXHTMLTransform

Returns:

the description of this transform to be used by the Style Catalog.

getAddSubscriptionEvent

protected WebEvent getAddSubscriptionEvent()

Get the event that will allow to add more subscriptions to the object.

Returns:

WebEvent instance initialized with the corresponding event depending on the delivery mode, if supported by the application.

EnumServletEvents.WebEventNCAddFileSubscription if it's to a file

EnumServletEvents.WebEventNCAddPrintSubscription if it's to print

EnumServletEvents.WebEventNCAddSubscription if it's to a regular subscription Otherwise returns null

getRecipientCellIndex

protected int getRecipientCellIndex()

Overrides:

getRecipientCellIndex in class SubscriptionsListXHTMLTransform

Since:

MicroStrategy Web 9.0.0

shouldShowSubscriptionsList

public boolean shouldShowSubscriptionsList(int delMode)

Overrides:

shouldShowSubscriptionsList in class AbstractSubscriptionFolderBeanTransform

hasSubscriptionsOrCanSubscribe

public boolean hasSubscriptionsOrCanSubscribe()