Class FolderFrameTreeTransform
- 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.FolderViewTransform
-
- com.microstrategy.web.app.transforms.FolderTreeTransform
-
- com.microstrategy.web.app.transforms.FolderFrameTreeTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class FolderFrameTreeTransform extends FolderTreeTransform
Transform class used to generate the visual representation of the folder as a tree in Microstrategy Web.- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.FolderViewTransform
FolderViewTransform.ClientEvent
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractFolderTransform
AbstractFolderTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Hashtable<java.lang.Integer,java.lang.Boolean>
rootFoldersOnDisplay
protected FormalParameter
visibleRootFolders
-
Fields inherited from class com.microstrategy.web.app.transforms.FolderTreeTransform
anchorTargetForNonFolderBrowseEvents, DUMMY_BEAN_NAME, tree
-
Fields inherited from class com.microstrategy.web.app.transforms.FolderViewTransform
_itemsList, CM_FLAG_ALL, CM_FLAG_COPY, CM_FLAG_CREATE_SHORTCUT, CM_FLAG_DELETE, CM_FLAG_MOVE, CM_FLAG_PROPERTIES, CM_FLAG_RENAME, contextMenuFlags, FP_CONTEXT_MENU_FLAGS, id, renderLinks
-
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 FolderFrameTreeTransform()
Class Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addScriptDependencies()
Add to the ClientSideHelper associated with this instance the javascript files require to provide interactivity of the tree on the client browser.void
addShortcutLinks(TreeNode root)
Add the folder links from the folderLinks.xml to the tree case on the context Id of the treeprotected void
createRootLevelFolders()
Creates the folders that will display at the root level of the tree.WebEvent
getEvent(WebObjectInfo object)
Based on the object type on theWebObjectInfo
sent as parameter, it creates and initializes the correspondingWebEvent
for having the object opened or run.protected java.lang.String
getFolderLinkClasses(WebObjectInfo object)
Returns the css class to use when rendering the different named folders and shortcuts available in the treeprotected boolean
getRenderEntireTree()
Returns true to indicate the tree needs to be rendered entirely.void
renderEmptyList(MarkupOutput out, WebFolder folder)
Entry method of folder transforms to generate empty list .void
renderList(MarkupOutput out)
Entry method of folder transforms to generate the list content.protected void
renderTree(MarkupOutput out, TreeView tree)
This method will write into the provided MarkupOutput the entire folder treeprotected boolean
suppressObject(int type)
This method is called for every object rendered by the tree.void
transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestEndsInError
.protected boolean
traverseBeyondFolder(WebFolder currentFolder, TreeNode currentNode)
Indicates whether the tree should render the child nodes while rendering the current node.-
Methods inherited from class com.microstrategy.web.app.transforms.FolderTreeTransform
constructEntireTree, createNewNode, getDescription, getID, getSysFolderDisplayName, getSysFolderName, getSysFolderNode, initializeTransform, newTreeNode, populateTreeNodes
-
Methods inherited from class com.microstrategy.web.app.transforms.FolderViewTransform
addSummaryAttribute, canCopy, canCreateShortcut, canDisplayProperties, canMove, canRename, checkContextMenuFlag, generateAnchor, generateAnchor, getActionImageSrc, getCopyEvent, getCreateAnalysisFromReportEvent, getCreateDocumentFromDossierEvent, getCreateDocumentFromReportEvent, getCreateDocumentFromThemeEvent, getCreateHTML5VIFromReportEvent, getCreateReportFromCubeEvent, getCreateShortcutEvent, getDeleteTooltip, getDisplayPropertiesEvent, getEditEvent, getEvent, getExportEvent, getFlashExportEvent, getFolderName, getFolderObjects, getHtmlExportEvent, getMoveEvent, getNameWrapperTag, getNewFilterEvent, getNewPromptEvent, getObjectID, getObjectManipulationBean, getObjectModificationTimeStamp, getOpenObjectManipulationDialogEvent, getPDFExportEvent, getRenameEvent, getRepublishCubeConfigJSON, getTimestamp, hasMultipleRunModesAvailable, isActionsTabAvailable, isFolderNotNull, renderAnchorTag, renderContextMenu, renderDeleteInfo, renderDescriptionInfo, renderEditInfo, renderEmptyCellForActions, renderExport, renderFolderDescription, renderFolderName, renderIconInfo, renderLayeredIconInfo, renderLayeredIconInfo, renderList, renderMenuArrow, renderModifiedInfo, renderOwnerInfo, renderPDFExport, renderSendNowInfo, renderSubscriptionInfo, shouldDisplayDeleteInfo
-
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, getExportEvent, getFeatures, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeCss, initializeImages, initializeSelectedItemsList, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderImage, renderJavaScript, renderObjectCount, setBoneProperties, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getObjectAbbreviation, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLocationInfo, renderNameInfo, renderObject
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, 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, 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, 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, getPreview, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
rootFoldersOnDisplay
protected java.util.Hashtable<java.lang.Integer,java.lang.Boolean> rootFoldersOnDisplay
-
visibleRootFolders
protected FormalParameter visibleRootFolders
-
-
Method Detail
-
addScriptDependencies
protected void addScriptDependencies()
Add to the ClientSideHelper associated with this instance the javascript files require to provide interactivity of the tree on the client browser.- Overrides:
addScriptDependencies
in classFolderTreeTransform
-
getRenderEntireTree
protected boolean getRenderEntireTree()
Returns true to indicate the tree needs to be rendered entirely. A false value will indicate the current request this is a partial node update.- Overrides:
getRenderEntireTree
in classFolderTreeTransform
-
renderTree
protected void renderTree(MarkupOutput out, TreeView tree)
This method will write into the provided MarkupOutput the entire folder tree- Overrides:
renderTree
in classFolderTreeTransform
- Parameters:
out
- MarkupOutput to write totree
- the TreeView object to include in the MarkupOutput
-
suppressObject
protected boolean suppressObject(int type)
This method is called for every object rendered by the tree. When the value returned is true, the object will not be included in the tree output.- Overrides:
suppressObject
in classFolderTreeTransform
- Parameters:
type
- The object type (#EnumDSSXMLObjectTypes) of the object being added to the tree
-
addShortcutLinks
public void addShortcutLinks(TreeNode root)
Add the folder links from the folderLinks.xml to the tree case on the context Id of the tree- Parameters:
root
-
-
traverseBeyondFolder
protected boolean traverseBeyondFolder(WebFolder currentFolder, TreeNode currentNode)
Indicates whether the tree should render the child nodes while rendering the current node.- Overrides:
traverseBeyondFolder
in classFolderTreeTransform
-
getFolderLinkClasses
protected java.lang.String getFolderLinkClasses(WebObjectInfo object)
Returns the css class to use when rendering the different named folders and shortcuts available in the tree- Parameters:
object
-
-
getEvent
public WebEvent getEvent(WebObjectInfo object)
Based on the object type on theWebObjectInfo
sent as parameter, it creates and initializes the correspondingWebEvent
for having the object opened or run.- Overrides:
getEvent
in classFolderViewTransform
- Parameters:
object
- aWebObjectInfo
for which the "execution" event must be retrieved.- Returns:
- The default event associated with the execution of this object. i.e.
- For a
EnumDSSXMLObjectTypes.DssXmlTypeReportDefinition
, theEnumReportBeanEvents.REPORT_EVENT_EXECUTE
event,- For a
EnumDSSXMLObjectTypes.DssXmlTypeFolder
, theEnumFolderBeanEvents.FOLDER_EVENT_BROWSE
event.- For a
EnumDSSXMLObjectTypes.DssXmlTypeDocumentDefinition
, theEnumDocumentBeanEvents.DOCUMENT_EVENT_EXECUTE_DOCUMENT
event.- For a
EnumDSSXMLObjectTypes.DssXmlTypeFilter
, theEnumServletEvents.WebEventSelectFilter
event.- For a
EnumDSSXMLObjectTypes.DssXmlTypeTemplate
, theEnumServletEvents.WebEventSelectTemplate
event.
If these events cannot be created or there are not enough privileges for the user to "execute" the object, it will returnnull
. - For a
-
renderList
public void renderList(MarkupOutput out)
Entry method of folder transforms to generate the list content.- Overrides:
renderList
in classFolderTreeTransform
- Parameters:
out
-MarkupOutput
instance to modify with the transform's output.
-
renderEmptyList
public void renderEmptyList(MarkupOutput out, WebFolder folder)
Entry method of folder transforms to generate empty list .- Overrides:
renderEmptyList
in classFolderTreeTransform
- Parameters:
out
-MarkupOutput
instance where the transform's output will be saved.folder
- theWebFolder
instance from theFolderBean
being transformed.
-
createRootLevelFolders
protected void createRootLevelFolders()
Creates the folders that will display at the root level of the tree. Depending on the user privileges, this list of folders will include Shared Reports, My Reports and My Objects
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status isEnumRequestStatus.WebBeanRequestEndsInError
.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
-