Package com.microstrategy.web.app.transforms

Class TreeTabManagerTransform

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

com.microstrategy.web.app.transforms.TreeTabManagerTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class TreeTabManagerTransform
extends TabManagerTransform

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
FormalParameter	expandAll	Determine whether all nodes should be expanded by default.
static java.lang.String	FP_EXPAND_ALL	Used by formal parameter expandAll.
static java.lang.String	FP_NODE_ACTION	Used by formal parameter nodeAction.
static java.lang.String	FP_TREE_STYLE	Used by formal parameter normTabManager;
FormalParameter	nodeAction	Determine whether all non-leaf nodes should expand or collapse.
FormalParameter	treeStyle	Determine whether to use tree style of TreeTabManager, instead of back to normal tab manager.

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

_tabManagerBean, autoSubmitJS, FP_AUTO_SUBMIT_JS, FP_HIDE_UNAVAILABLE, FP_IGNORE_SINGLE_TAB, FP_PRIMARY_BONE, FP_TAB_HEIGHT, hideUnavailable, ignoreSingleTab, primaryBone, tabHeight

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

Method Summary

Modifier and Type	Method	Description
protected TreeNode	createNode(TabBean tab)	Create a tree node corresponding to the TabBean.
protected void	generateTabBeanTree(TabBean parentTab, TreeNode parentNode)	Generate the control tree branch under parentTab TabBean.
void	initializeTransform(Transformable data)	Initializes transform formal parameters
protected boolean	isLeaf(TabBean tab)	Determine whether a TabBean is a Leaf or not.
void	renderControlBar(MarkupOutput out)	Renders the tab control HTML for being able to switch from one TabBean child tab to another.
void	renderEditorContents(MarkupOutput out)	Transforms the assosciated TabManagerBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.
void	renderInfosPanel(MarkupOutput out)	Render the panel displaying the path of current selected tab.
protected void	renderJavascript(MarkupOutput out)	Render the javascript for tree tab manager.
void	renderOtherInfosPanel(MarkupOutput out)	Render other informations in the Info Panel, in addition to current selected tab.
protected void	renderTabManagerControlTree(MarkupOutput out)	Render the tree control of tab manager.
protected void	setTreeJavaScript(TreeView tree)	Set the java script class and add javascript for tree control inside tree tab manager.

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

getCurrentTabName, getDescription, getSupportedBeanType, getTitleForChildTab, initHelp, renderChildrenTabBody, renderCurrentTabBody, renderTabContainerBody, renderTabManagerControlBarBody, setAttributesTabSetContainer, setTabSetStyle, transformForRequestSuccessful

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, initEditor, renderEditor, renderEditorElement, setFocusFieldId, transformForRequestInError

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, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, 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, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

FP_EXPAND_ALL

public static final java.lang.String FP_EXPAND_ALL

Used by formal parameter expandAll.

See Also:

Constant Field Values

FP_NODE_ACTION

public static final java.lang.String FP_NODE_ACTION

Used by formal parameter nodeAction.

See Also:

Constant Field Values

FP_TREE_STYLE

public static final java.lang.String FP_TREE_STYLE

Used by formal parameter normTabManager;

See Also:

Constant Field Values

expandAll

public FormalParameter expandAll

Determine whether all nodes should be expanded by default. Default value is false.

nodeAction

public FormalParameter nodeAction

Determine whether all non-leaf nodes should expand or collapse. Default value is 1.

treeStyle

public FormalParameter treeStyle

Determine whether to use tree style of TreeTabManager, instead of back to normal tab manager. Default value is false.

Constructor Detail

TreeTabManagerTransform

public TreeTabManagerTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class TabManagerTransform

Parameters:

data - the bean being transformed by this class

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Transforms the assosciated TabManagerBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.

Overrides:

renderEditorContents in class TabManagerTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

renderInfosPanel

public void renderInfosPanel(MarkupOutput out)

Render the panel displaying the path of current selected tab.

Parameters:

out - MarkupOutput instance where the HTML to render will be saved

renderOtherInfosPanel

public void renderOtherInfosPanel(MarkupOutput out)

Render other informations in the Info Panel, in addition to current selected tab.

Parameters:

out - MarkupOutput instance where the HTML to render will be saved

renderControlBar

public void renderControlBar(MarkupOutput out)

Renders the tab control HTML for being able to switch from one TabBean child tab to another. Generates a tree style control panel for holding the different TabBean titles of the tabs that are available for this TabManagerBean instance. The structure of the tree is determined by the structure the different TabBeans are organized in pageconfig.xml.

Overrides:

renderControlBar in class TabManagerTransform

Parameters:

out - MarkupOutput instance where the HTML to render will be saved

renderJavascript

protected void renderJavascript(MarkupOutput out)

Render the javascript for tree tab manager.

Overrides:

renderJavascript in class TabManagerTransform

Parameters:

out - MarkupOutput instance where the HTML to render will be saved

renderTabManagerControlTree

protected void renderTabManagerControlTree(MarkupOutput out)

Render the tree control of tab manager.

Parameters:

out - MarkupOutput instance where the HTML to render will be saved

setTreeJavaScript

protected void setTreeJavaScript(TreeView tree)

Set the java script class and add javascript for tree control inside tree tab manager.

Parameters:

tree - The tree view instance for tree tab manager.

generateTabBeanTree

protected void generateTabBeanTree(TabBean parentTab,
                                   TreeNode parentNode)

Generate the control tree branch under parentTab TabBean.

Parameters:

parentTab - The TabBean of which the control tree branch would be rendered.

parentNode - The corresponding node of the parentTab TabBean.

createNode

protected TreeNode createNode(TabBean tab)

Create a tree node corresponding to the TabBean.

Parameters:

tab - The TabBean of which a tree node would be created.

Returns:

A TreeNode corresponding to the TabBean.

isLeaf

protected boolean isLeaf(TabBean tab)

Determine whether a TabBean is a Leaf or not.

Parameters:

tab - The TabBean to be determined.

Returns:

A boolean value.