Package com.microstrategy.web.app.transforms

Class ObjectBrowserManagerTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class ObjectBrowserManagerTransform
extends TabManagerTransform

Title: ObjectBrowserManagerTransform.

Description: Used to render the object browser in the report page

Company: Microstrategy, Inc.

Since:

MicroStrategy Web 8.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 ObjectBrowserManagerBean	_objMngr

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
ObjectBrowserManagerTransform()	Default no argument constructor.

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getCloseEvent()
java.lang.String	getStyleShellDiv()	Returns the style (that is, the style attribute used for css formatting) of the shell's div.
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
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.
void	initializeTransform(Transformable data)	Initializes transform formal parameters
void	renderEditorContents(MarkupOutput out)	Transforms the assosciated TabManagerBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.
protected void	renderJavascript(MarkupOutput out)	Generate the JavaScript code required by this editor manager for the proper behavior on the client.
void	renderTabContainerBody(MarkupOutput out)	Generates the HTML that represents the body of the TabManagerBean instance being rendered, consisting on all the current available TabBean instances.
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.

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

getCurrentTabName, getDescription, getTitleForChildTab, initHelp, renderChildrenTabBody, renderControlBar, renderCurrentTabBody, setAttributesTabSetContainer, setTabSetStyle, transformForRequestSuccessful

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, 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, 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, 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

_objMngr

protected ObjectBrowserManagerBean _objMngr

Constructor Detail

ObjectBrowserManagerTransform

public ObjectBrowserManagerTransform()

Default no argument constructor.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: TabManagerTransform

Initializes transform formal parameters

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class TabManagerTransform

Parameters:

data - bean that will be transformed

See Also:

AbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Transforms the assosciated TabManagerBean when its status is EnumRequestStatus.WebBeanRequestSuccessful. Calls renderTabManagerFrame()

Overrides:

renderEditorContents in class TabManagerTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

renderJavascript

protected void renderJavascript(MarkupOutput out)

Description copied from class: TabManagerTransform

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.

initHeightAndWidthFromPreferences

protected void initHeightAndWidthFromPreferences()

Description copied from class: AbstractAppTransform

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

renderTabContainerBody

public void renderTabContainerBody(MarkupOutput out)

Generates the HTML that represents the body of the TabManagerBean instance being rendered, consisting on all the current available TabBean instances. HTML contents of the individual TabBean instances will then be hidden with css styles and JavaScript, for only showing one at the time (the currently selected by the user).

Overrides:

renderTabContainerBody in class TabManagerTransform

Parameters:

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

getStyleShellDiv

public java.lang.String getStyleShellDiv()

Returns the style (that is, the style attribute used for css formatting) of the shell's div.

Overrides:

getStyleShellDiv in class AbstractAppTransform

See Also:

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

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

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

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Description copied from class: TabManagerTransform

Returns the supported bean type. This transform supports TabManagerBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class TabManagerTransform

Returns:

the ObjectBrowserManagerBean Class

See Also:

Transform.getSupportedBeanType()