Package com.microstrategy.web.app.transforms

Class AllObjectBrowserTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractEditorTransform

com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform

com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform

com.microstrategy.web.app.transforms.FolderObjectExplorerTransform

com.microstrategy.web.app.transforms.AllObjectBrowserTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

AllObjectBrowserHTMLTransform, FilterAllObjectBrowserTransform

public class AllObjectBrowserTransform
extends FolderObjectExplorerTransform

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AllObjectBrowserTransform.Context	Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo.

Field Summary

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

promptString, promptStringID

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

INCREMENTAL_FETCH_NEXT, INCREMENTAL_FETCH_PREVIOUS, populateChildren, tree

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

_imgCheck, _oeBean, checkImage, displayFormatPickerName, FP_CHECK_IMAGE, FP_DISPLAY_FORMAT_PICKER_NAME, FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, FP_SHOW_CURRENT_IN_ANCESTORS_LIST, ID_POSTFIX, incrementalFetchNavigationType, incrementalFetchPageBlock, showCurrentInAncestorsList

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

_helpTopic, _helpType, applyJS, applyLabel, applyLabelID, canAutoSize, cancelJS, cancelLabel, cancelLabelID, closeEvent, closeImage, closeJS, closeLabel, closeLabelID, dhtmlClose, disableOKButton, editorContentsStyle, editorElements, editorLayoutFile, editorSubType, FP_APPLY_JS, FP_APPLY_LABEL, FP_APPLY_LABEL_ID, FP_CAN_AUTO_SIZE, FP_CANCEL_JS, FP_CANCEL_LABEL, FP_CANCEL_LABEL_ID, FP_CLOSE_EVENT, FP_CLOSE_IMAGE, FP_CLOSE_JS, FP_CLOSE_LABEL, FP_CLOSE_LABEL_ID, FP_DHTML_CLOSE, FP_DISABLE_OK_BUTTON, FP_EDITOR_CONTENTS_STYLE, FP_EDITOR_ELEMENTS, FP_EDITOR_LAYOUT_FILE, FP_EDITOR_SUBTYPE, FP_HELP_PAGE, FP_HELP_TOPIC, FP_HELP_TYPE, FP_INCLUDE_DYNAMIC_SCRIPT, FP_NAVIGATE_ON_SUBMIT, FP_OK_JS, FP_OK_LABEL, FP_OK_LABEL_ID, FP_RENDER_FORM, FP_TITLE_LABEL, FP_TITLE_LABEL_ID, FP_USE_JS_IN_BONE, helpPage, helpTopic, helpType, includeDynamicScript, navigateOnSubmit, okJS, okLabel, okLabelID, renderForm, titleLabel, titleLabelID

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

Method Summary

Modifier and Type	Method	Description
protected TreeNode	constructEntireTree()	This method is used in two scenarios: 1.
protected java.util.ArrayList	getAncestorsOptionTags(java.lang.StringBuffer indentBuffer)
protected SelectTag	getAncestorsSelectTag()	Returns a >select< Tag instance object containing the list\ of the object's ancestors
protected AnchorTag	getBrowseUnitAnchor(WebDisplayUnit du)	Gets the browse event used by the data explorer bean in an anchor tag
protected WebEvent	getChangeDisplayFormatEvent()	Returns a new instance of the event use to toggle the display format
protected TransformContext	getContext()	Extends AbstractAppTransform.getContext() by setting to the context object a reference the current WebObjectInfo
protected ContextMenu	getContextMenu(WebDisplayUnit du)	Return the ContextMenu associated with the object
java.util.Map	getContextMenuAttributes(WebDisplayUnit wdu)	Returns the context-menu specific attributes to assign to the context-menu container
java.lang.String	getDescription()	Return description for this Transform.
protected java.lang.String	getJavascriptTyAttribute(WebObjectInfo object)	Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
protected Tag	getSearchBox()	Returns the search box for the project browser
void	initializeTransform(Transformable data)	Initializes transform formal parameters
protected boolean	isDimension(WebDisplayUnit du)	Determined whether the unit provided represents a dimension in metadata.
protected boolean	isRenderAsTree()	Returns whether the object browser is displayed in List View or Tree View
protected boolean	isStartingFolder(java.lang.String objID)
protected TransformContext	newContext()	Creates a new instance of a TransformContext.
protected TreeNode	newTreeNode(WebDisplayUnit object)	Creates and populates a single tree node
protected TreeNode	newTreeNodeLink(WebDisplayUnit object)	Creates and populates a single tree node
void	renderDisplayFormatIcon(MarkupOutput out)	Renders a link to change the display format of the object browser content
protected void	renderJavascript(MarkupOutput out)	This method should be used by the Editor transforms to generate any javascript necessary.
void	renderOpenParent(MarkupOutput out)	Renders the upFolder button for the Object Browser.
void	renderUnit(MarkupOutput out, WebDisplayUnit du)	Returns the give unit in the component's contents list.
protected boolean	shouldAddLinks()	We should add links only if StartBrowsingFolderID is not specified or if allowAllObjectBrowsing is true
boolean	shouldDisplayObject(WebDisplayUnit du)

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

addLinksAsOption, generateIncrementalFetchNode, generateIncrementalFetchNode, generateSearchNode, getCssName, getFolderRoot, getLinkAttributes, getLinkCssName, getList, getReportViewMode, getSupportedBeanType, getTooltipInfo, getTooltipTitle, getUnitAttributes, getUnitName, getVisualizationMode, getVisualizationMode, isFolder, isTreeRoot, isVisualizationObject, isVisualizationObject, renderLayeredIconInfo, renderPromptString, shouldRenderFolderLinks, shouldRenderLinks

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

addLinks, createNewNode, isRenderEntireTree, populateTreeNodes, populateWithChildren, renderEditorContents, renderTree

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

addAncestorsOptionsToSelectTag, addCurrentFolderToAncestorList, addOpenParentImg, addOpenParentImg, getBlockPosition, getBlockSize, getBrowseEvent, getChildCount, getExplorerClientSideHelper, getExplorerScriptClass, getForm, getGoToArgument, getHiddenInputsEventList, getID, getIncrementalFetchComponent, getOKEvent, getOpenParentEvent, getOption, getSearchButton, getSearchEvent, getUnitAnchor, getUnitDesc, initializeImages, isUseOptionTitle, renderAncestors, renderChangeFormatDropDown, renderDisplayFormatPickers, renderErrorMessage, renderHiddenInputs, renderIncrementalFetch, renderLayeredIconInfo, renderObjectCount, renderSearch, renderSearchBox, renderSearchButton, renderSearchEventArgs, setUseOptionTitle, shouldDisplayErrorMessage, shouldGenerateNewForm, shouldShowDummyFolderOption

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError, 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, 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, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, 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, 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

AllObjectBrowserTransform

public AllObjectBrowserTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class FolderObjectExplorerTransform

Parameters:

data - Transformable instance to be associated with this transform.

renderUnit

public void renderUnit(MarkupOutput out,
                       WebDisplayUnit du)

Description copied from class: AbstractObjectExplorerTransform

Returns the give unit in the component's contents list.

Overrides:

renderUnit in class FolderObjectExplorerTransform

Parameters:

out - MarkupOutput

du - WebDisplayUnit

See Also:

AbstractObjectExplorerTransform.renderUnit(MarkupOutput, WebDisplayUnit)

shouldDisplayObject

public boolean shouldDisplayObject(WebDisplayUnit du)

getDescription

public java.lang.String getDescription()

Return description for this Transform.

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class AbstractObjectExplorerTreeTransform

Returns:

description text.

renderOpenParent

public void renderOpenParent(MarkupOutput out)

Renders the upFolder button for the Object Browser.

Overrides:

renderOpenParent in class FolderObjectExplorerTransform

Parameters:

out - MarkupOutput

renderDisplayFormatIcon

public void renderDisplayFormatIcon(MarkupOutput out)

Renders a link to change the display format of the object browser content

Parameters:

out - MarkupOutput

getContextMenuAttributes

public java.util.Map getContextMenuAttributes(WebDisplayUnit wdu)

Returns the context-menu specific attributes to assign to the context-menu container

Parameters:

wdu - WebObjectInfo

Returns:

Map CX, CXID ....

renderJavascript

protected void renderJavascript(MarkupOutput out)

Description copied from class: AbstractEditorTransform

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Overrides:

renderJavascript in class AbstractEditorTransform

Parameters:

out - MarkupOutput where the output should be rendered.

constructEntireTree

protected TreeNode constructEntireTree()

This method is used in two scenarios: 1. Every time when we bring up the editor bean by clicking on the link (in this case the whole tree needs to be constructed for sure) 2. when the user switches from a list view to a tree view, the tree needs to be re-constructed possibly from a sub-node all the way to the root folder specified in the configuration

Overrides:

constructEntireTree in class FolderObjectExplorerTransform

Returns:

TreeNode the root of the fully constructed tree

getAncestorsSelectTag

protected SelectTag getAncestorsSelectTag()

Returns a >select< Tag instance object containing the list\ of the object's ancestors

Overrides:

getAncestorsSelectTag in class FolderObjectExplorerTransform

Returns:

SelectTag

See Also:

AbstractObjectExplorerTransform.getAncestorsSelectTag()

isStartingFolder

protected boolean isStartingFolder(java.lang.String objID)
                            throws WebObjectsException

Returns:

identify whether a given ID of a WebDisplayUnit is the root of the all object browsing for a certain report.

Throws:

WebObjectsException

getAncestorsOptionTags

protected java.util.ArrayList getAncestorsOptionTags(java.lang.StringBuffer indentBuffer)

Overrides:

getAncestorsOptionTags in class AbstractObjectExplorerTransform

getBrowseUnitAnchor

protected AnchorTag getBrowseUnitAnchor(WebDisplayUnit du)

Gets the browse event used by the data explorer bean in an anchor tag

Parameters:

du -

Returns:

AnchorTag

newContext

protected TransformContext newContext()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

Overrides:

newContext in class AbstractAppTransform

isDimension

protected boolean isDimension(WebDisplayUnit du)

Determined whether the unit provided represents a dimension in metadata.

Parameters:

du - WebDisplayUnit

Returns:

boolean true if is a dimension.

isRenderAsTree

protected boolean isRenderAsTree()

Returns whether the object browser is displayed in List View or Tree View

Overrides:

isRenderAsTree in class AbstractObjectExplorerTreeTransform

Returns:

boolean

shouldAddLinks

protected boolean shouldAddLinks()

We should add links only if StartBrowsingFolderID is not specified or if allowAllObjectBrowsing is true

Overrides:

shouldAddLinks in class FolderObjectExplorerTransform

Returns:

boolean

newTreeNode

protected TreeNode newTreeNode(WebDisplayUnit object)

Creates and populates a single tree node

Overrides:

newTreeNode in class AbstractObjectExplorerTreeTransform

Parameters:

object -

Returns:

TreeNode

getContext

protected TransformContext getContext()

Extends AbstractAppTransform.getContext() by setting to the context object a reference the current WebObjectInfo

Overrides:

getContext in class AbstractAppTransform

See Also:

AbstractAppTransform.getContextMenu(java.lang.String)

getJavascriptTyAttribute

protected java.lang.String getJavascriptTyAttribute(WebObjectInfo object)

Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.

Parameters:

object - The WebObjectInfo for which it's ty attribute name is requested.

Returns:

The Javascript TY attribute to use for the generation of the HTML tag related with this object. If none is found given the object type, null will be returned.

getContextMenu

protected ContextMenu getContextMenu(WebDisplayUnit du)

Return the ContextMenu associated with the object

Parameters:

du - WebObjectInfo

Returns:

ContextMenu ContextMenu

newTreeNodeLink

protected TreeNode newTreeNodeLink(WebDisplayUnit object)

Creates and populates a single tree node

Overrides:

newTreeNodeLink in class AbstractObjectExplorerTreeTransform

Parameters:

object - WebDisplayUnit

getSearchBox

protected Tag getSearchBox()

Returns the search box for the project browser

Overrides:

getSearchBox in class AbstractObjectExplorerTransform

getChangeDisplayFormatEvent

protected WebEvent getChangeDisplayFormatEvent()

Returns a new instance of the event use to toggle the display format

Overrides:

getChangeDisplayFormatEvent in class AbstractObjectExplorerTransform

Returns:

WebEvent