Package com.microstrategy.web.app.transforms

Class FolderOMDBrowserTransform

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

com.microstrategy.web.app.transforms.FolderProjectBrowserTransform

com.microstrategy.web.app.transforms.FolderSaveAsBrowserTransform

com.microstrategy.web.app.transforms.FolderOMDBrowserTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderOMDBrowserTransform
extends FolderSaveAsBrowserTransform

Since:

MicroStrategy Web 8.0.1

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

createFolderJS, filterContextID, FP_CREATE_FOLDER_JS, FP_FILTER_CONTEXT_ID, FP_SHOW_CREATE_FOLDER_BUTTON, FP_SHOW_CREATE_FOLDER_DIAOLOG, FP_TEMPLATE_CONTEXT_ID, showCreateFolderButton, showCreateFolderDialog, templateContextID

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

allowBrowseDimension, checkImage, contextID, cssBody, cssFileSearch, folderLinksLocation, FP_ALLOW_BROWSE_DIMENSION, FP_CHECK_IMAGE, FP_CONTEXT_ID, FP_FOLDER_LINKS_LOCATION, FP_HTML_GRAPHIC_MODE, FP_LEVEL_CHANGE_JS, FP_RENDER_FORM, FP_RENDER_LINKS_ANCESTORS, FP_SEARCH_BOX_JS, FP_SEARCH_JS, FP_UP_FOLDER_JS, htmlGraphicMode, levelChangeJS, renderForm, renderLinksAncestors, searchBoxJS, searchJS, sSpaces, upFolderJS

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

folderJS, FP_FOLDER_JS, FP_OBJECT_CLICK_JS, objectClickJS

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
FolderOMDBrowserTransform()	Default Constructor.

Method Summary

Modifier and Type	Method	Description
int	getFodlerLinksContextId()	Returns the context id (from EnumObjectBrowserContexts) to use
java.util.Map	getLinkAttributes(WebObjectInfo object)	this function is added to help generate layered icon in prompt project browser editor Get attribute for folder link in smallIconView
java.util.Map	getObjectAttributes(WebObjectInfo object)	overaide the method in parent class
WebEvent	getOpenCreateFolderEvent()
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderCreateFolderButton(MarkupOutput out)	Renders the button that opens the create folder dialog
void	renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean useLinkCss)	generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

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

getFolderLinksContextId, renderBrowserContent

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

generateAnchor, getBrowseEvent, getBrowseParentFolderEvent, getDescription, getEvent, getFolderContentsSelectNameHTML, getFolderLinkClasses, getFolderLinkList, getFolderObjects, getFolderRoot, getForm, getHiddenInputsEventList, getJavascriptTyAttribute, getNonFolderObjects, getObjectName, getProjectID, getSearchEvent, getSubfolders, getSubFolders, getTooltipInfo, getTooltipTitle, initializeCss, initializeImages, isFolder, isNamedFolder, renderAncestorsSelector, renderBrowser, renderClearSearch, renderFolderContentHTML, renderFolderContentsHTML, renderFolderContentsSubmitButtonHTML, renderFolderContentsTitleHTML, renderFolderLink, renderFolderLinkOptions, renderFolderLinks, renderFolderObjects, renderFoldersHTML, renderFoldersSubmitButtonHTML, renderFoldersTitleHTML, renderHiddenInputs, renderList, renderListHTML, renderNameInfo, renderObjectName, renderOpenParentLink, renderSearchBox, renderSearchButton, renderSearchSection, renderSubfolders, setFolderRoot, setUpFolderJS, shouldRenderFolderLinks, transformForRequestSuccessful

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

getContainerAttributes, postAnchorGenerated, renderLayeredIconInfo, renderList, renderObject, setObjectClickJS

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, getExportEvent, getFeatures, getFlashExportEvent, getFolderBean, getFolderChildCount, getGoToArgument, getGoToEvent, getHtmlExportEvent, getImageName, getImageSrc, getListComparator, getMstrExportEvent, getOringalChildCount, getPDFExportEvent, getSendNowEvent, getSortedChildUnits, getSortedList, getSubscriptionsEvent, getSupportedBeanType, getViewMediaReportEvent, getViewMediaRWEvent, initializeSelectedItemsList, isEmptyList, isFeatureAvailable, isFolderEmpty, isObjectRunableinPauseMode, isObjectSelected, isObjectVisible, isViewableReport, newContext, renderEmptyList, renderEmptyList, renderImage, renderJavaScript, renderObjectCount, setBoneProperties

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

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

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, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, 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, 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

FolderOMDBrowserTransform

public FolderOMDBrowserTransform()

Default Constructor. Initializes the formal parameters contextID, levelChangeJS, searchJS and renderForm.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class FolderProjectBrowserTransform

Parameters:

data - Transformable instance with the bean to be transformed.

renderCreateFolderButton

public void renderCreateFolderButton(MarkupOutput out)

Renders the button that opens the create folder dialog

Overrides:

renderCreateFolderButton in class FolderSaveAsBrowserTransform

Parameters:

out - MarkupOutput

getOpenCreateFolderEvent

public WebEvent getOpenCreateFolderEvent()

getFodlerLinksContextId

public int getFodlerLinksContextId()

Returns the context id (from EnumObjectBrowserContexts) to use

Overrides:

getFodlerLinksContextId in class FolderSaveAsBrowserTransform

Returns:

int

getObjectAttributes

public java.util.Map getObjectAttributes(WebObjectInfo object)

overaide the method in parent class

Overrides:

getObjectAttributes in class FolderSmallIconTransform

Parameters:

object - WebObjectInfo to be rendered.

Returns:

Map

Since:

MicroStrategy Web 9.0.0

getLinkAttributes

public java.util.Map getLinkAttributes(WebObjectInfo object)

Description copied from class: FolderProjectBrowserTransform

this function is added to help generate layered icon in prompt project browser editor Get attribute for folder link in smallIconView

Overrides:

getLinkAttributes in class FolderProjectBrowserTransform

Parameters:

object - - WebObjectInfo web object to get attribute from

Returns:

Map

Since:

MicroStrategy Web 9.0.0

renderLayeredIconInfo

public void renderLayeredIconInfo(MarkupOutput out,
                                  WebObjectInfo object,
                                  boolean useLinkCss)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Overrides:

renderLayeredIconInfo in class FolderProjectBrowserTransform

Parameters:

out - MarkupOutput instance where to save the contents to display

object - WebObjectInfo to be rendered.

useLinkCss - flag for a largeIconView or listView

Since:

MicroStrategy Web 9.0.0