Package com.microstrategy.web.app.transforms

Class AbstractObjectExplorerTreeTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

FolderObjectExplorerTransform

public abstract class AbstractObjectExplorerTreeTransform
extends AbstractObjectExplorerTransform

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	INCREMENTAL_FETCH_NEXT
protected static int	INCREMENTAL_FETCH_PREVIOUS
protected boolean	populateChildren
protected TreeView	tree	TreeView that is used to render the tree once it's populated

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

Method Summary

Modifier and Type	Method	Description
protected void	addLinks(TreeNode node)	Method adds the standard shortcut links that have to be displayed after the contents of the object browser.
protected abstract TreeNode	constructEntireTree()
protected TreeNode	createNewNode(java.lang.Object childObj, boolean isExpanded)	Creates a new tree node for the tree view.
protected TreeNode	generateIncrementalFetchNode(int direction)
java.lang.String	getDescription()	Return description for this Transform.
protected abstract java.lang.String	getLinkCssName(WebDisplayUnit wdu)
void	initializeTransform(Transformable data)	Initializes transform formal parameters
protected boolean	isRenderAsTree()	Returns whether the object browser has been rendered in list view or tree view
protected boolean	isRenderEntireTree()	Indicates whether it's necessary to render the entire tree
protected TreeNode	newTreeNode(WebDisplayUnit object)	Creates and populates a single tree node
protected TreeNode	newTreeNodeLink(WebDisplayUnit object)	Creates and populates a single tree node
protected void	populateTreeNodes(java.util.List children, TreeNode parentNode)	Method populates a tree node with its contents.
protected java.util.List	populateWithChildren(WebDisplayUnit webFolder)	Method returns a list populated with the folder's children.
void	renderEditorContents(MarkupOutput out)	Method that renders the editor contents corresponding to this Wizard.
void	renderTree(MarkupOutput out)	Method renders the object browser in the tree view.
protected abstract boolean	shouldRenderLinks(TreeNode node)

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

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

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, initHelp, renderEditor, renderEditorElement, renderJavascript, 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, getContext, 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, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, 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, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

tree

protected TreeView tree

TreeView that is used to render the tree once it's populated

populateChildren

protected boolean populateChildren

INCREMENTAL_FETCH_PREVIOUS

protected static final int INCREMENTAL_FETCH_PREVIOUS

See Also:

Constant Field Values

INCREMENTAL_FETCH_NEXT

protected static final int INCREMENTAL_FETCH_NEXT

See Also:

Constant Field Values

Constructor Detail

AbstractObjectExplorerTreeTransform

public AbstractObjectExplorerTreeTransform()

Method Detail

isRenderEntireTree

protected boolean isRenderEntireTree()

Indicates whether it's necessary to render the entire tree

Returns:

true if need to render the entire tree; false otherwise

isRenderAsTree

protected boolean isRenderAsTree()

Returns whether the object browser has been rendered in list view or tree view

Returns:

boolean

initializeTransform

public void initializeTransform(Transformable data)

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractObjectExplorerTransform

Parameters:

data - Transformable instance to be associated with this transform.

getDescription

public java.lang.String getDescription()

Return description for this Transform.

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class AbstractObjectExplorerTransform

Returns:

description text.

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Method that renders the editor contents corresponding to this Wizard.

Overrides:

renderEditorContents in class AbstractObjectExplorerTransform

Parameters:

out - MarkupOutput instance where the HTML contents to render are to be saved.

renderTree

public void renderTree(MarkupOutput out)

Method renders the object browser in the tree view.

Parameters:

out -

populateTreeNodes

protected void populateTreeNodes(java.util.List children,
                                 TreeNode parentNode)

Method populates a tree node with its contents.

Parameters:

children -

parentNode -

createNewNode

protected TreeNode createNewNode(java.lang.Object childObj,
                                 boolean isExpanded)

Creates a new tree node for the tree view.

Parameters:

childObj -

isExpanded -

generateIncrementalFetchNode

protected TreeNode generateIncrementalFetchNode(int direction)

newTreeNode

protected TreeNode newTreeNode(WebDisplayUnit object)

Creates and populates a single tree node

newTreeNodeLink

protected TreeNode newTreeNodeLink(WebDisplayUnit object)

Creates and populates a single tree node

Parameters:

object - WebDisplayUnit

populateWithChildren

protected java.util.List populateWithChildren(WebDisplayUnit webFolder)

Method returns a list populated with the folder's children.

Parameters:

webFolder -

addLinks

protected void addLinks(TreeNode node)

Method adds the standard shortcut links that have to be displayed after the contents of the object browser. These links are shortcuts to the Attributes, Metrics, Hierarchies ... folders

Parameters:

node -

constructEntireTree

protected abstract TreeNode constructEntireTree()

getLinkCssName

protected abstract java.lang.String getLinkCssName(WebDisplayUnit wdu)

shouldRenderLinks

protected abstract boolean shouldRenderLinks(TreeNode node)