Package com.microstrategy.web.app.transforms

Class PromptEditorTabManagerTransform

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

com.microstrategy.web.app.transforms.PromptEditorTabManagerTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class PromptEditorTabManagerTransform
extends HelpOnCBTabManagerTransform

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

_editorInstance

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

Method Summary

Modifier and Type	Method	Description
java.util.List	getAttForms(WebAttribute att)
java.lang.String	getCssName(WebObjectInfo object)
java.util.List	getFlattenedContexFolderList(int contextId)
java.lang.String	getFlattenedContextFolderPath(int contextId)
java.util.List	getObjectBrowserContextFolders(int contextId)	Return a list of WebObjectInfo objects, which are the browser starting folders, according to the contextId.
protected java.lang.String	getProjectID()	Private method that gets the Project ID from the session manager
WebObjectInfo	getRootFolder(int contextId)
java.lang.Object	getSelf(java.lang.Object obj)	Returns the input argument as return value.
boolean	includeOwnerInfo()
boolean	includeTimeInfo()
protected void	initHelp(Editor editor)	Initialize help type and topic for specific dialog.
boolean	isNull(java.lang.Object obj)	Returns whether the input argument is null.
boolean	isShowObjectTags()
void	renderConfirmationSuccessfulMessage(PromptDefinitionAppBean pBean, MarkupOutput out)
void	renderEditorContents(MarkupOutput out)	Transforms the assosciated TabManagerBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.
void	renderHelpPath(MarkupOutput out)
protected void	renderJavascript(MarkupOutput out)	Generate the JavaScript code required by this editor manager for the proper behavior on the client.
void	renderPreferenceValue(MarkupOutput out, java.lang.String prefName)
void	renderPreferenceValueReplaceNull(MarkupOutput out, java.lang.String prefName, java.lang.String nullReplace)
protected boolean	shouldRenderHelpButton()

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

renderControlBar, renderHelpButton

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

getCurrentTabName, getDescription, getSupportedBeanType, getTitleForChildTab, initializeTransform, 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, 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

Constructor Detail

PromptEditorTabManagerTransform

public PromptEditorTabManagerTransform()

Method Detail

shouldRenderHelpButton

protected boolean shouldRenderHelpButton()

Overrides:

shouldRenderHelpButton in class HelpOnCBTabManagerTransform

renderConfirmationSuccessfulMessage

public void renderConfirmationSuccessfulMessage(PromptDefinitionAppBean pBean,
                                                MarkupOutput out)

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Description copied from class: TabManagerTransform

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 HelpOnCBTabManagerTransform

Parameters:

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

initHelp

protected void initHelp(Editor editor)

Initialize help type and topic for specific dialog.

Overrides:

initHelp in class HelpOnCBTabManagerTransform

Parameters:

editor - Editor instance, abstraction of the container where output is rendered.

getObjectBrowserContextFolders

public java.util.List getObjectBrowserContextFolders(int contextId)

Return a list of WebObjectInfo objects, which are the browser starting folders, according to the contextId.

Parameters:

contextId - an id from EnumObjectBrowserContexts

Returns:

a list of WebObjectInfo objects.

getProjectID

protected java.lang.String getProjectID()

Private method that gets the Project ID from the session manager

Overrides:

getProjectID in class AbstractAppTransform

Returns:

String projectID

getRootFolder

public WebObjectInfo getRootFolder(int contextId)

getFlattenedContexFolderList

public java.util.List getFlattenedContexFolderList(int contextId)

getFlattenedContextFolderPath

public java.lang.String getFlattenedContextFolderPath(int contextId)

renderPreferenceValue

public void renderPreferenceValue(MarkupOutput out,
                                  java.lang.String prefName)

renderPreferenceValueReplaceNull

public void renderPreferenceValueReplaceNull(MarkupOutput out,
                                             java.lang.String prefName,
                                             java.lang.String nullReplace)

getSelf

public java.lang.Object getSelf(java.lang.Object obj)

Returns the input argument as return value. This method is used in layout when one base value needs to assign to another base value. For example, we have base "obj", then when the type of "obj" is a certain value, we would like base "obj2" equals to "obj". Then in layout we can have . After this, obj2 points to the same object as "obj" points to.

Parameters:

obj - object to return

Returns:

Returns the input argument.

isNull

public boolean isNull(java.lang.Object obj)

Returns whether the input argument is null.

Parameters:

obj - The object to check again null

Returns:

true if the input is null, otherwise false is returned.

getCssName

public java.lang.String getCssName(WebObjectInfo object)

getAttForms

public java.util.List getAttForms(WebAttribute att)

includeTimeInfo

public boolean includeTimeInfo()

isShowObjectTags

public boolean isShowObjectTags()

includeOwnerInfo

public boolean includeOwnerInfo()

renderHelpPath

public void renderHelpPath(MarkupOutput out)