Class SubscriptionsListXHTMLTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
SubscriptionsFilteredListXHTMLTransform
public class SubscriptionsListXHTMLTransform extends AbstractSubscriptionListTransform implements LayoutTransform
This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.
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 Modifier and Type Field Description static int
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 SubscriptionsListXHTMLTransform()
Default no-args constructor, initialize formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Tag
generateColumnGroup()
Generates aCOLGROUP
HTML tag withCOL
tags defined for each one of the columns to be rendered on this list view transform.protected RowTag
generateHeadersRow(SimpleList list)
Generates aTR
HTML tag withTD
tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevel
formal parameter.protected RowTag
generateItem(int rowIndex, WebSubscription subscription, WebObjectInfo target)
Generates theRowTag
instance corresponding to the information of theWebSubscription
andWebObjectInfo
sent in as parameters.protected RowTag
generateItem(WebSubscription subscription, WebObjectInfo target)
Deprecated.protected RowTag[]
generateItems(SimpleList list)
Analyzes all the items available to display and generates an array ofRowTag
instances (corresponding toTR
HTML tags) with the information.protected int
generateRecipientRows(java.util.ArrayList auxRows, int rowIndex, WebSubscription subscription, WebObjectInfo target)
protected TableTag
generateTable()
Generates aTABLE
HTML tag where all the contents of the transform to display will be added as rows of this table.java.lang.String
getDescription()
Returns the description of this transform to be used by the Style Catalog.protected int
getFieldCount()
Obtains the number of columns this transform is displaying, depending on which ones are enabled through thelevelFlags
formal parameter.protected int
getRecipientCellIndex()
protected WebEvent
getRemoveEvent()
Provides the remove event for the given listjava.lang.String
getSummaryText()
Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformedboolean
isSubscriptionPersonalized(WebSubscription subscription, WebObjectInfo target)
Determines if the schedule being analyzed has been personalized or notvoid
renderAddressInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's address object informationvoid
renderEditInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void
renderEditInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
Renders a link to edit the subscription'svoid
renderEditPersonalizationInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void
renderEditPersonalizationInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
void
renderEmptyList(MarkupOutput out)
Renders the HTML when there are no subscriptions to display.void
renderFormEnd(MarkupOutput out)
Renders theFORM
tag end information.void
renderFormStart(MarkupOutput out)
Renders theFORM
tag start informationvoid
renderIconInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the icon associated with the subscriptionvoid
renderList(MarkupOutput out, SimpleList list)
Renders the list of elements available in theSubscriptionFolderBean
being transformedvoid
renderNameInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the name of the subscription's targetvoid
renderOwnerInfo(MarkupOutput out, WebSubscription subscription)
Renders the name of the subscription's targetvoid
renderPersonalizedInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the information whether the subscription is personlized or not.void
renderRecipientInfo(MarkupOutput out, int rowIndex, WebSubscription subscription)
void
renderRecipientInfo(MarkupOutput out, WebSubscription subscription)
Deprecated.void
renderRemoveInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
void
renderRemoveInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
Renders a checkbox to remove the subscription'svoid
renderScheduleInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the subscription's schedule object informationvoid
renderTitle(MarkupOutput out)
Render a main title associated with this transform.-
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, renderFooter, renderImage, 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, 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
-
-
-
-
Field Detail
-
LEVEL_HEADERS
public static final int LEVEL_HEADERS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSummaryText
public java.lang.String getSummaryText()
Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed- Returns:
String
with the summary description for the table to render.
-
renderEmptyList
public void renderEmptyList(MarkupOutput out)
Renders the HTML when there are no subscriptions to display.- Specified by:
renderEmptyList
in classAbstractSubscriptionFolderBeanTransform
- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
generateTable
protected TableTag generateTable()
Generates aTABLE
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 asclass
.- Returns:
- a
TableTag
instance defined, by default no rows or other information are added to it. Methods likegenerateHeadersRow
andgenerateItems
should be called for obtaining the information that shall be added to it.
-
generateColumnGroup
protected Tag generateColumnGroup()
Generates aCOLGROUP
HTML tag withCOL
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=typ /> <col class=nam /> <col class=sch /> <col class=adr /> <col class=per /> </colgroup>
- Returns:
Tag
instance corresponding to theCOLGROUP
HTML tag.
-
generateHeadersRow
protected RowTag generateHeadersRow(SimpleList list)
Generates aTR
HTML tag withTD
tags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevel
formal parameter. For example, the content might look like this:<tr> <td> </td> <td>Name</td> <td>Schedule</td> <td>Address</td> <td>Personalized</td> </tr>
- Parameters:
list
-SimpleList
instance with the elements to render.- Returns:
RowTag
instance corresponding to theTR
HTML tag where the headers were defined.
-
generateItems
protected RowTag[] generateItems(SimpleList list)
Analyzes all the items available to display and generates an array ofRowTag
instances (corresponding toTR
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 one object on the list being transformed. If no object is found to render, returnsnull
.
-
getRecipientCellIndex
protected int getRecipientCellIndex()
- Since:
- MicroStrategy Web 9.0.0
-
generateRecipientRows
protected int generateRecipientRows(java.util.ArrayList auxRows, int rowIndex, WebSubscription subscription, WebObjectInfo target)
- Since:
- MicroStrategy Web 9.0.0
-
generateItem
protected RowTag generateItem(int rowIndex, WebSubscription subscription, WebObjectInfo target)
Generates theRowTag
instance corresponding to the information of theWebSubscription
andWebObjectInfo
sent in as parameters.- Parameters:
subscription
-WebSubscription
instance to rendertarget
-WebObjectInfo
instance target of the subscription being renderedrowIndex
- index of the current Row. This will be used to render the show/hide button for recipients of multi-recipient subscription.- Returns:
- a
RowTag
(TR
HTML tag) with the information about theWebSubscription
andWebObjectInfo
target instances requested contained onCellTag
child instances. For example, icon image, name, schedule information, etc. - Since:
- MicroStrategy Web 9.0.0
-
generateItem
protected RowTag generateItem(WebSubscription subscription, WebObjectInfo target)
Deprecated.Generates theRowTag
instance corresponding to the information of theWebSubscription
andWebObjectInfo
sent in as parameters.- Parameters:
subscription
-WebSubscription
instance to rendertarget
-WebObjectInfo
instance target of the subscription being rendered- Returns:
- a
RowTag
(TR
HTML tag) with the information about theWebSubscription
andWebObjectInfo
target instances requested contained onCellTag
child instances. For example, icon image, name, schedule information, etc. - See Also:
instead.
-
renderTitle
public void renderTitle(MarkupOutput out)
Render a main title associated with this transform. By default, nothing is displayed.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
renderList
public void renderList(MarkupOutput out, SimpleList list)
Renders the list of elements available in theSubscriptionFolderBean
being transformed- Specified by:
renderList
in classAbstractSubscriptionFolderBeanTransform
- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.list
- aSimpleList
instance with the list of schedules to render.
-
renderIconInfo
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 rendertarget
-WebObjectInfo
instance target of the schedule being rendered
-
renderNameInfo
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 rendertarget
-WebObjectInfo
instance target of the schedule being rendered
-
renderOwnerInfo
public void renderOwnerInfo(MarkupOutput out, WebSubscription subscription)
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- Since:
- MicroStrategy Web 9.0.0
-
renderRecipientInfo
public void renderRecipientInfo(MarkupOutput out, int rowIndex, WebSubscription subscription)
- Since:
- MicroStrategy Web 9.0.0
-
renderRecipientInfo
public void renderRecipientInfo(MarkupOutput out, WebSubscription subscription)
Deprecated.- Parameters:
out
-subscription
-- Since:
- MicroStrategy Web 9.0.0
-
renderPersonalizedInfo
public void renderPersonalizedInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
Renders the information whether the subscription is personlized or not.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.subscription
-WebSubscription
instance to rendertarget
-WebObjectInfo
instance target of the schedule being rendered
-
isSubscriptionPersonalized
public boolean isSubscriptionPersonalized(WebSubscription subscription, WebObjectInfo target)
Determines if the schedule being analyzed has been personalized or not- Parameters:
subscription
-WebSubscription
instance to be testedtarget
-WebObjectInfo
instance target of the schedule being analyzed- Returns:
- boolean value indicating if the schedule is personalized or not
-
renderScheduleInfo
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 rendertarget
-WebObjectInfo
instance target of the schedule being rendered
-
renderAddressInfo
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 rendertarget
-WebObjectInfo
instance target of the schedule being rendered
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
Renders a link to edit the subscription's- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.subscriptionID
-WebSubscription
instance to rendertarget
-WebObjectInfo
instance target of the schedule being rendered- Since:
- MicroStrategy Web 9.0.0
-
renderEditPersonalizationInfo
public void renderEditPersonalizationInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
- Since:
- MicroStrategy Web 9.0.0
-
renderEditPersonalizationInfo
public void renderEditPersonalizationInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
- Since:
- MicroStrategy Web 9.0.0
-
renderRemoveInfo
public void renderRemoveInfo(MarkupOutput out, WebSubscription subscription, WebObjectInfo target)
-
renderRemoveInfo
public void renderRemoveInfo(MarkupOutput out, java.lang.String subscriptionID, WebObjectInfo target)
Renders a checkbox to remove the subscription's- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.subscriptionID
- subscription ID to rendertarget
-WebObjectInfo
instance target of the schedule being rendered- Since:
- MicroStrategy Web 9.0.0
-
renderFormStart
public void renderFormStart(MarkupOutput out)
Renders theFORM
tag start information- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
renderFormEnd
public void renderFormEnd(MarkupOutput out)
Renders theFORM
tag end information.- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.
-
getFieldCount
protected int getFieldCount()
Obtains the number of columns this transform is displaying, depending on which ones are enabled through thelevelFlags
formal parameter.- Overrides:
getFieldCount
in classAbstractSubscriptionFolderBeanTransform
- Returns:
- the number of columns to be displayed by this transform.
-
getRemoveEvent
protected WebEvent getRemoveEvent()
Provides the remove event for the given list- Returns:
- the
EnumSubscriptionFolderBeanEvents.SUBSCRIPTION_FOLDER_EVENT_DELETE_SUBSCRIPTIONS
event initialized if available, otherwise it returnsnull
.
-
getDescription
public java.lang.String getDescription()
Returns the description of this transform to be used by the Style Catalog.- Specified by:
getDescription
in interfaceTransform
- Returns:
- This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.
-
-