Package com.microstrategy.web.app.transforms

Class SaveObjectAsDialogTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class SaveObjectAsDialogTransform
extends AbstractEditorTransform
implements LayoutTransform

Title: SaveObjectAsDialogTransform.

Description: Transform class for parsing SaveObjectAsDialogBean and generating its output.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

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.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
SaveObjectAsDialogTransform()	Default no-args constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getApplyEvent()	Returns an instance of the event responsible for processing the editor's actions
java.lang.String	getDescription()	Returns the textual description of current transform class.
java.lang.String	getEditorTitle()
protected java.lang.String	getObjectDescription()
protected java.lang.String	getObjectName()
java.lang.String	getObjectTypeName()
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
protected void	initEditor(Editor editor)	Initialize the editor with the global settings.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderDescriptionField(MarkupOutput out)	Renders the text input for the formula name section
void	renderDescriptionLabel(MarkupOutput out)	Renders the title label that appears before the formula name section
void	renderDescriptionProperty(MarkupOutput out)
void	renderEditorContents(MarkupOutput out)	Generates the graphical output for the Projects Bean
void	renderErrorMessage(MarkupOutput out)	The method renders an error message if an error has ocurred.
void	renderHeader(MarkupOutput out)
void	renderNameField(MarkupOutput out)
void	renderNameLabel(MarkupOutput out)
void	renderNameProperty(MarkupOutput out)
void	renderProjectBrowser(MarkupOutput out)
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for the Projects Bean

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

generateForm, getDivTagAroundContents, getOnSubmitJS, getWebBeanErrorInfo, initHelp, renderEditor, renderEditorElement, renderJavascript, 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

Constructor Detail

SaveObjectAsDialogTransform

public SaveObjectAsDialogTransform()

Default no-args constructor, initialize formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractEditorTransform

Parameters:

data - bean that will be transformed

initEditor

protected void initEditor(Editor editor)

Initialize the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

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

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractEditorTransform

Generates the graphical output for the Projects Bean

Overrides:

transformForRequestSuccessful in class AbstractEditorTransform

Parameters:

out - MarkupOutputinstance where to create the HTML output

See Also:

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

renderEditorContents

public void renderEditorContents(MarkupOutput out)

Generates the graphical output for the Projects Bean

Specified by:

renderEditorContents in class AbstractEditorTransform

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderNameProperty

public void renderNameProperty(MarkupOutput out)

renderNameLabel

public void renderNameLabel(MarkupOutput out)

renderNameField

public void renderNameField(MarkupOutput out)

renderDescriptionProperty

public void renderDescriptionProperty(MarkupOutput out)

renderDescriptionLabel

public void renderDescriptionLabel(MarkupOutput out)

Renders the title label that appears before the formula name section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderDescriptionField

public void renderDescriptionField(MarkupOutput out)

Renders the text input for the formula name section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderProjectBrowser

public void renderProjectBrowser(MarkupOutput out)

getEditorTitle

public java.lang.String getEditorTitle()
                                throws java.lang.IllegalArgumentException

Overrides:

getEditorTitle in class AbstractEditorTransform

Throws:

java.lang.IllegalArgumentException

getObjectTypeName

public java.lang.String getObjectTypeName()

renderErrorMessage

public void renderErrorMessage(MarkupOutput out)

The method renders an error message if an error has ocurred.

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderHeader

public void renderHeader(MarkupOutput out)

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports SaveObjectAsDialogBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

SaveObjectAsDialogBean instance.

getDescription

public java.lang.String getDescription()

Returns the textual description of current transform class.

Specified by:

getDescription in interface Transform

Returns:

String the description of the transform.

getApplyEvent

protected WebEvent getApplyEvent()

Returns an instance of the event responsible for processing the editor's actions

Returns:

a WebEvent instance with the information needed for submitting an apply request.

getObjectName

protected java.lang.String getObjectName()

getObjectDescription

protected java.lang.String getObjectDescription()