Package com.microstrategy.web.app.transforms

Class AccordionTabManagerTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class AccordionTabManagerTransform
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 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
AccordionTabManagerTransform()

Method Summary

Modifier and Type	Method	Description
java.util.Map	getAttributesShellDiv()	Returns a Map with the list of attributes that the shell div must use.
protected WebEvent	getCloseEvent()
protected java.lang.String	getCurrentTabName()	Obtains the Id/Name of the tab currently selected
protected java.lang.String	getCurrentTabTitle()	Obtains the title of the tab currently selected
protected java.lang.String	getEditorTitle()
WebBeanError	getWebBeanErrorInfo()
protected void	initEditor(Editor editor)	Initializes the editor with the global settings.
protected void	initHeightAndWidthFromPreferences()	Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences.
protected boolean	needToAdjustContainer()
void	renderChildrenTabBody(MarkupOutput out)	Renders each of the TabBeans that are part of the TabManagerBean.
protected void	renderJavascript(MarkupOutput out)	Generate the JavaScript code required by this editor manager for the proper behavior on the client.
void	renderTabManagerControlBarBody(MarkupOutput out)	Generates a table row with individual cells corresponding to each one of the TabBean child tab titles that are available to the user.
protected void	setAttributesTabSetContainer(Tag tabSetContainer)
protected void	setTabSetStyle(Tag tabSetContainer)
protected boolean	shouldDisplay()	Determines whether the transform should render itself or not.

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

getDescription, getSupportedBeanType, getTitleForChildTab, initHelp, initializeTransform, renderControlBar, renderCurrentTabBody, renderEditorContents, renderTabContainerBody, transformForRequestSuccessful

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

generateForm, getDivTagAroundContents, getOnSubmitJS, 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, 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, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, 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, 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

Constructor Detail

AccordionTabManagerTransform

public AccordionTabManagerTransform()

Method Detail

shouldDisplay

protected boolean shouldDisplay()

Description copied from class: AbstractAppTransform

Determines whether the transform should render itself or not. Returns the result of !AbstractAppTransform.isIFrameRequest() or the result of the WebComponent.hasChanged() method.

Overrides:

shouldDisplay in class AbstractAppTransform

Returns:

boolean

renderChildrenTabBody

public void renderChildrenTabBody(MarkupOutput out)

Renders each of the TabBeans that are part of the TabManagerBean. Loops through the list of all the child TabBeans and renders their output. The reason that we have to loop through ALL of them is because the accordion is doing partial update during tab switch. Sometimes it will have new tabs added as a result of iframe request (eg. drill on view report) so we want to have the place holders ready for all the tabs so to guarantee that all the tabs will be iframe update-able.

Overrides:

renderChildrenTabBody in class TabManagerTransform

Parameters:

out - MarkupOutput

renderJavascript

protected void renderJavascript(MarkupOutput out)

Generate the JavaScript code required by this editor manager for the proper behavior on the client. Extends the parent method by adding extra property values as well as the required library for it to work properly.

Overrides:

renderJavascript in class TabManagerTransform

Parameters:

out - MarkupOutput instance where the HTML output will be saved.

setTabSetStyle

protected void setTabSetStyle(Tag tabSetContainer)

Overrides:

setTabSetStyle in class TabManagerTransform

renderTabManagerControlBarBody

public void renderTabManagerControlBarBody(MarkupOutput out)

Generates a table row with individual cells corresponding to each one of the TabBean child tab titles that are available to the user.

Overrides:

renderTabManagerControlBarBody in class TabManagerTransform

Parameters:

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

getEditorTitle

protected java.lang.String getEditorTitle()

Overrides:

getEditorTitle in class AbstractEditorTransform

getCurrentTabName

protected java.lang.String getCurrentTabName()

Description copied from class: TabManagerTransform

Obtains the Id/Name of the tab currently selected

Overrides:

getCurrentTabName in class TabManagerTransform

Returns:

null if not found...

getCurrentTabTitle

protected java.lang.String getCurrentTabTitle()

Obtains the title of the tab currently selected

Returns:

null if not found...

initHeightAndWidthFromPreferences

protected void initHeightAndWidthFromPreferences()

Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences. The format of the preference is : id1:width:heigth@id2:width:height@....

Overrides:

initHeightAndWidthFromPreferences in class AbstractAppTransform

needToAdjustContainer

protected boolean needToAdjustContainer()

initEditor

protected void initEditor(Editor editor)

Initializes the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

editor - the Editor to modify.

getCloseEvent

protected WebEvent getCloseEvent()

setAttributesTabSetContainer

protected void setAttributesTabSetContainer(Tag tabSetContainer)

Overrides:

setAttributesTabSetContainer in class TabManagerTransform

getAttributesShellDiv

public java.util.Map getAttributesShellDiv()

Description copied from class: AbstractAppTransform

Returns a Map with the list of attributes that the shell div must use. The shell is the main div surrounding the Transform's output.
This method can be overriden in case the subclass would like to add or change the value of attributes in the shell.

Overrides:

getAttributesShellDiv in class AbstractAppTransform

See Also:

AbstractAppTransform.renderShell(com.microstrategy.web.beans.MarkupOutput)

getWebBeanErrorInfo

public WebBeanError getWebBeanErrorInfo()

Overrides:

getWebBeanErrorInfo in class AbstractEditorTransform

Returns:

the error info

See Also:

AbstractAppTransform.getWebBeanErrorInfo()