Class SchedulesListXHTMLTransform
- 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.AbstractScheduleListTransform
-
- com.microstrategy.web.app.transforms.SchedulesListXHTMLTransform
-
- All Implemented Interfaces:
AppTransform,Transform
- Direct Known Subclasses:
SchedulesFilteredListXHTMLTransform
@Deprecated public class SchedulesListXHTMLTransform extends AbstractScheduleListTransform
Deprecated.Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions. Hence please useSubscriptionsListXHTMLTransforminstead.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 intLEVEL_HEADERSDeprecated.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
LEVEL_TRIGGER, VIEW_MODE_CUBE, VIEW_MODE_DATAMART, VIEW_MODE_DOCUMENT, VIEW_MODE_GRAPH, VIEW_MODE_GRID, VIEW_MODE_GRID_GRAPH, 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 SchedulesListXHTMLTransform()Deprecated.Class constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected TaggenerateColumnGroup()Deprecated.Generates aCOLGROUPHTML tag withCOLtags defined for each one of the columns to be rendered on this list view transform.protected RowTaggenerateHeadersRow(SimpleList list)Deprecated.Generates aTRHTML tag withTDtags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevelformal parameter.protected RowTaggenerateItem(WebSchedule schedule, WebObjectInfo target)Deprecated.Generates theRowTaginstance corresponding to the information of theWebScheduleandWebObjectInfosent in as parameters.protected RowTag[]generateItems(SimpleList list)Deprecated.Analyzes all the items available to display and generates an array ofRowTaginstances (corresponding toTRHTML tags) with the information.protected TableTaggenerateTable()Deprecated.Generates aTABLEHTML tag where all the contents of the transform to display will be added as rows of this table.java.lang.StringgetDescription()Deprecated.Returns the description of this transform to be used by the Style Catalog.protected intgetFieldCount()Deprecated.Obtains the number of columns this transform is displaying, depending on which ones are enabled through thelevelFlagsformal parameter.protected WebEventgetRemoveEvent()Deprecated.Provides the remove event for the given listjava.lang.StringgetSummaryText()Deprecated.Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformedbooleanisSchedulePersonalized(WebSchedule schedule, WebObjectInfo target)Deprecated.Determines if the schedule being analyzed has been personalized or notvoidrenderEditInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the link to edit the schedule being displayedvoidrenderEmptyList(MarkupOutput out)Deprecated.Renders the HTML when there are no schedules to display.voidrenderFormEnd(MarkupOutput out)Deprecated.Renders theFORMtag end information.voidrenderFormStart(MarkupOutput out)Deprecated.Renders theFORMtag start informationvoidrenderIconInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the icon information associated with the schedule to display.voidrenderList(MarkupOutput out, SimpleList list)Deprecated.Renders the list of elements available in theSubscriptionFolderBeanbeing transformedvoidrenderNameInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the name of the schedule's target being displayed.voidrenderPersonalizedInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the information whether the schedule is personlized or not (i.e., it is prompted)voidrenderRemoveInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the checkbox to remove the schedule being displayedvoidrenderTimeInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the message execution time for the schedule being displayed.voidrenderTitle(MarkupOutput out)Deprecated.Render a main title associated with this transform.voidrenderTriggerInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)Deprecated.Renders the schedule's trigger information-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractScheduleListTransform
canTransform, getCssName, getEmptyListDescriptor, getExecuteEvent, getMessageId, getMessageTime, getReportExecuteEvent, getScheduleTarget, getViewMode, isValidSchedule
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
checkLevel, generateBoneProperties, 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, 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, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, 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
-
-
Method Detail
-
getSummaryText
public java.lang.String getSummaryText()
Deprecated.Obtain the summary string to display on the table containing the list of objects corresponding to the bean being transformed- Returns:
Stringwith the summary description for the table to render.
-
renderEmptyList
public void renderEmptyList(MarkupOutput out)
Deprecated.Renders the HTML when there are no schedules to display.- Specified by:
renderEmptyListin classAbstractSubscriptionFolderBeanTransform- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.
-
renderTitle
public void renderTitle(MarkupOutput out)
Deprecated.Render a main title associated with this transform. By default, nothing is displayed.- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.
-
generateTable
protected TableTag generateTable()
Deprecated.Generates aTABLEHTML 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
TableTaginstance defined, by default no rows or other information are added to it. Methods likegenerateHeadersRowandgenerateItemsshould be called for obtaining the information that shall be added to it.
-
generateColumnGroup
protected Tag generateColumnGroup()
Deprecated.Generates aCOLGROUPHTML tag withCOLtags 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=trg /> <col class=tim /> <col class=per /> </colgroup>- Returns:
Taginstance corresponding to theCOLGROUPHTML tag.
-
generateHeadersRow
protected RowTag generateHeadersRow(SimpleList list)
Deprecated.Generates aTRHTML tag withTDtags defined for each one of the column headers to be rendered on this transform according to privileges and value assigned to thelevelformal parameter. For example, the content might look like this:<tr> <td> </td> <td>Name</td> <td>Schedule</td> <td>Last Execution Time</td> <td>Personalized</td> </tr>- Parameters:
list-SimpleListinstance with the elements to render.- Returns:
RowTaginstance corresponding to theTRHTML tag where the headers were defined.
-
generateItems
protected RowTag[] generateItems(SimpleList list)
Deprecated.Analyzes all the items available to display and generates an array ofRowTaginstances (corresponding toTRHTML tags) with the information.- Parameters:
list-SimpleListinstance with the elements to render.- Returns:
- RowTag[] an array of
RowTaginstances, each one with the information of one object on the list being transformed. If no object is found to render, returnsnull.
-
isSchedulePersonalized
public boolean isSchedulePersonalized(WebSchedule schedule, WebObjectInfo target)
Deprecated.Determines if the schedule being analyzed has been personalized or not- Parameters:
schedule-WebScheduleinstance to be testedtarget-WebObjectInfoinstance target of the schedule being analyzed- Returns:
- boolean value indicating if the schedule is personalized or not
-
generateItem
protected RowTag generateItem(WebSchedule schedule, WebObjectInfo target)
Deprecated.Generates theRowTaginstance corresponding to the information of theWebScheduleandWebObjectInfosent in as parameters.- Parameters:
schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered- Returns:
- a
RowTag(TRHTML tag) with the information about theWebScheduleandWebObjectInfotarget instances requested contained onCellTagchild instances. For example, icon image, name, trigger information, etc.
-
renderList
public void renderList(MarkupOutput out, SimpleList list)
Deprecated.Renders the list of elements available in theSubscriptionFolderBeanbeing transformed- Specified by:
renderListin classAbstractSubscriptionFolderBeanTransform- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.list- aSimpleListinstance with the list of schedules to render.
-
renderIconInfo
public void renderIconInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the icon information associated with the schedule to display.- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderNameInfo
public void renderNameInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the name of the schedule's target being displayed.- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderTimeInfo
public void renderTimeInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the message execution time for the schedule being displayed.- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderPersonalizedInfo
public void renderPersonalizedInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the information whether the schedule is personlized or not (i.e., it is prompted)- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderTriggerInfo
public void renderTriggerInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the schedule's trigger information- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the link to edit the schedule being displayed- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderRemoveInfo
public void renderRemoveInfo(MarkupOutput out, WebSchedule schedule, WebObjectInfo target)
Deprecated.Renders the checkbox to remove the schedule being displayed- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.schedule-WebScheduleinstance to rendertarget-WebObjectInfoinstance target of the schedule being rendered
-
renderFormStart
public void renderFormStart(MarkupOutput out)
Deprecated.Renders theFORMtag start information- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.
-
renderFormEnd
public void renderFormEnd(MarkupOutput out)
Deprecated.Renders theFORMtag end information.- Parameters:
out-MarkupOutputinstance where the transform's output will be saved.
-
getRemoveEvent
protected WebEvent getRemoveEvent()
Deprecated.Provides the remove event for the given list- Returns:
- the
EnumSubscriptionFolderBeanEvents.SUBSCRIPTION_FOLDER_EVENT_DELETE_SCHEDULESevent initialized if available, otherwise it returnsnull.
-
getFieldCount
protected int getFieldCount()
Deprecated.Obtains the number of columns this transform is displaying, depending on which ones are enabled through thelevelFlagsformal parameter.- Overrides:
getFieldCountin classAbstractSubscriptionFolderBeanTransform- Returns:
- the number of columns to be displayed by this transform.
-
getDescription
public java.lang.String getDescription()
Deprecated.Returns the description of this transform to be used by the Style Catalog.- Returns:
- the description of this transform to be used by the Style Catalog.
-
-