Package com.microstrategy.web.app.transforms

Class FolderSummaryTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform

com.microstrategy.web.app.transforms.AbstractFolderTransform

com.microstrategy.web.app.transforms.FolderIconTransform

com.microstrategy.web.app.transforms.FolderSummaryTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderSummaryTransform
extends FolderIconTransform

This class extends the FolderIconTransform by assigning to the event used for the folder a few more arguments for enabling opening their contents on the main folder page of the application.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

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

AbstractFolderTransform.Context

Field Summary

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

columnsNumber, FP_COLUMNS_NUMBER

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

_bandingIndex, _imgHeight, _imgWidth, _sortedChildUnits, datamartImage, documentImage, execTarget, filterImage, folderImage, FP_CREATE_REPORT_DISPLAY_SECTION, FP_DATAMART_IMAGE, FP_DOCUMENT_IMAGE, FP_EXEC_TARGET, FP_FILTER_IMAGE, FP_FOLDER_IMAGE, FP_GRAPH_IMAGE, FP_GRID_GRAPH_IMAGE, FP_IMAGE_HEIGTH, FP_IMAGE_WIDTH, FP_LEVEL_FLAG, FP_MAX_OBJECT_TYPE_COUNT, FP_REPORT_IMAGE, FP_RW_DOCUMENT_IMAGE, FP_SORT_ASCENDING, FP_SORT_FIELD, FP_TABLE_ID, FP_TEMPLATE_IMAGE, graphImage, gridGraphImage, imageHeight, imageWidth, LEVEL_ALL, LEVEL_CONFIRM_DELETE, LEVEL_DELETE, LEVEL_DESCRIPTION, LEVEL_DISPLAY_HEADERS, LEVEL_EDIT, LEVEL_EMPTY_FOLDER_MESSAGE, LEVEL_EXPORT_EXCEL, LEVEL_EXPORT_PDF, LEVEL_FOLDER_INFORMATION, LEVEL_INCREMENTAL_FETCH, LEVEL_LOCATION, LEVEL_MODIFIED, LEVEL_NAME, LEVEL_OWNER, LEVEL_SEND_NOW, LEVEL_SUBSCRIPTION, levelFlag, maxObjectTypeCount, reportImage, rwDocumentImage, sortAscending, sortField, tableId, templateImage

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

FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, imgBlank, incrementalFetchNavigationType, incrementalFetchPageBlock

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
FolderSummaryTransform()

Method Summary

Modifier and Type	Method	Description
WebEvent	getEvent(WebObjectInfo object)	Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.

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

getDescription, getExportEvent, getPDFExportEvent, renderDeleteInfo, renderDescriptionInfo, renderEditInfo, renderExport, renderIconInfo, renderItems, renderList, renderModifiedInfo, renderNameInfo, renderObject, renderOwnerInfo, renderPDFExport, renderSendNowInfo, renderSubscriptionInfo

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

addScriptDependency, canCreateSubscription, canDelete, canEdit, canExecute, canExport, canExportToPDF, canSendNow, checkLevel, getBlockPosition, getBlockSize, getChildCount, getContext, getContextMenu, getContextMenuAttributes, getDeleteEvent, getDeleteEvent, getEditEvent, getExportEvent, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeCss, initializeImages, initializeSelectedItemsList, initializeTransform, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderList, renderObjectCount, setBoneProperties, transformForRequestSuccessful

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

addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLayeredIconInfo, renderLocationInfo

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, 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, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, 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, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, 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, canTransform, 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, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FolderSummaryTransform

public FolderSummaryTransform()

Method Detail

getEvent

public WebEvent getEvent(WebObjectInfo object)

Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run. Extends the original method by adding few more arguments to the event that takes care of EnumDSSXMLObjectTypes.DssXmlTypeFolder object types for being able to navigate them on the regular folder page on the application.

Overrides:

getEvent in class AbstractFolderTransform

Parameters:

object - a WebObjectInfo for which the "execution" event must be retrieved.

Returns:

the WebEvent corresponding to the object. Returns null if the user does not have enough privileges or the application does not support the event.