Package com.microstrategy.web.app.transforms

Class FolderViewXMLTransform

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.FolderViewXMLTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderViewXMLTransform
extends FolderViewTransform

Since:

MicroStrategy Web 8.1.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 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
FolderViewXMLTransform()

Method Summary

Modifier and Type	Method	Description
protected boolean	isObjectVisible(WebObjectInfo object)	Utility method that checks if the object should be displayed or not, based on the information provided on the AbstractFolderTransform.maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already
void	renderCurFolderAccessGranted(MarkupOutput out)
void	renderCurFolderID(MarkupOutput out)
void	renderCurFolderName(MarkupOutput out)
void	renderCurFolderPath(MarkupOutput out)
void	renderObjectAccessGranted(MarkupOutput out, WebObjectInfo object)
void	renderObjectDescription(MarkupOutput out, WebObjectInfo object)	Write out the object's description.
void	renderObjectID(MarkupOutput out, WebObjectInfo object)	Write out the object's ID.
void	renderObjectName(MarkupOutput out, WebObjectInfo object)	Write out the object's name.
void	renderObjectSubType(MarkupOutput out, WebObjectInfo object)	Write out the object's type.
void	renderObjectType(MarkupOutput out, WebObjectInfo object)	Write out the object's type.
void	renderShell(MarkupOutput out)	Generates the shell for this Transform.
void	renderShortcutInfo(MarkupOutput out, WebObjectInfo object)	Write out "1" if the object is a shortcut

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, getDescription, getDisplayPropertiesEvent, getEditEvent, getEvent, getEvent, getExportEvent, getFlashExportEvent, getFolderName, getFolderObjects, getHtmlExportEvent, getID, 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, initializeTransform, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, 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, 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, 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, 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, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

FolderViewXMLTransform

public FolderViewXMLTransform()

Method Detail

renderObjectName

public void renderObjectName(MarkupOutput out,
                             WebObjectInfo object)

Write out the object's name.

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderObjectDescription

public void renderObjectDescription(MarkupOutput out,
                                    WebObjectInfo object)

Write out the object's description.

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderObjectID

public void renderObjectID(MarkupOutput out,
                           WebObjectInfo object)

Write out the object's ID.

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderObjectType

public void renderObjectType(MarkupOutput out,
                             WebObjectInfo object)

Write out the object's type. This will be a value from EnumDSSXMLObjectTypes.

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderObjectSubType

public void renderObjectSubType(MarkupOutput out,
                                WebObjectInfo object)

Write out the object's type. This will be a value from EnumDSSXMLObjectSubTypes.

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderCurFolderName

public void renderCurFolderName(MarkupOutput out)

renderCurFolderID

public void renderCurFolderID(MarkupOutput out)

renderCurFolderAccessGranted

public void renderCurFolderAccessGranted(MarkupOutput out)

renderObjectAccessGranted

public void renderObjectAccessGranted(MarkupOutput out,
                                      WebObjectInfo object)

renderShell

public void renderShell(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - output by this transform

isObjectVisible

protected boolean isObjectVisible(WebObjectInfo object)

Description copied from class: AbstractFolderTransform

Utility method that checks if the object should be displayed or not, based on the information provided on the AbstractFolderTransform.maxObjectTypeCount formal parameter and the current number of objects of that type that have been rendered already

Overrides:

isObjectVisible in class AbstractFolderTransform

Parameters:

object - WebObjectInfo with the object to check for.

Returns:

True if the object should be displayed, otherwise returns False

renderShortcutInfo

public void renderShortcutInfo(MarkupOutput out,
                               WebObjectInfo object)

Write out "1" if the object is a shortcut

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

renderCurFolderPath

public void renderCurFolderPath(MarkupOutput out)