Package com.microstrategy.web.app.transforms

Class DerivedElementsEditorTransform

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

All Implemented Interfaces:

EnumDerivedElementsEditorEvents, AppTransform, LayoutTransform, Transform

public class DerivedElementsEditorTransform
extends AbstractEditorTransform
implements LayoutTransform, EnumDerivedElementsEditorEvents

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
protected FormalParameterImpl	_calculationStyle
protected FormalParameterImpl	_filterStyle
protected FormalParameterImpl	_listStyle

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

Fields inherited from interface com.microstrategy.web.app.beans.EnumDerivedElementsEditorEvents

WebEventArgumentCloseParentEditor, WebEventArgumentDEAggregationType, WebEventArgumentDEApplyToAllOthers, WebEventArgumentDEBehavior, WebEventArgumentDEFormatType, WebEventArgumentDEFormatValues, WebEventArgumentDEId, WebEventArgumentDEName, WebEventArgumentDonotAskAgain, WebEventDEAddCalculationElement, WebEventDEAddElement, WebEventDEAddFilterElement, WebEventDEAddListElement, WebEventDEOpenFormatEditor, WebEventDEOpenImportDialog, WebEventDEOpenSaveAsDialog, WebEventDERemove, WebEventDERemoveAll, WebEventDESetCurrentElement, WebEventDESetName, WebEventDEToggleShowChildren, WebEventDEToggleShowParent, WebEventDEToggleVisible, WebEventDEUpdateFormat

Constructor Summary

Constructors

Constructor	Description
DerivedElementsEditorTransform()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
protected java.lang.String	getEditorTitle()
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
boolean	hasValidationError()
protected void	initEditor(Editor editor)	Initializes the editor with the global settings.
void	initializeTransform(Transformable data)	This method initializes the private and protected fields of the transform.
boolean	isIFrameDisplayMode()	Determines if the display mode should consider iframe request or not.
void	renderCurrentElement(MarkupOutput out)
void	renderEditorContents(MarkupOutput out)	Transforms the associated DerivedElementsEditorBean.
protected void	renderNoCurrentElement(MarkupOutput out)
void	renderValidationErrorMessage(MarkupOutput out)
protected void	setBoneProperties(JsonGenerator boneProps)	Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
void	setShellAttributeOnClosedComponent(java.util.HashMap __result)
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, 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, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, 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

_listStyle

protected FormalParameterImpl _listStyle

_calculationStyle

protected FormalParameterImpl _calculationStyle

_filterStyle

protected FormalParameterImpl _filterStyle

Constructor Detail

DerivedElementsEditorTransform

public DerivedElementsEditorTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

This method initializes 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)

Initializes the editor with the global settings.

Overrides:

initEditor in class AbstractEditorTransform

Parameters:

editor - the Editor to modify.

getEditorTitle

protected java.lang.String getEditorTitle()

Overrides:

getEditorTitle in class AbstractEditorTransform

setShellAttributeOnClosedComponent

public void setShellAttributeOnClosedComponent(java.util.HashMap __result)

Overrides:

setShellAttributeOnClosedComponent in class AbstractAppTransform

isIFrameDisplayMode

public boolean isIFrameDisplayMode()

Description copied from class: AbstractAppTransform

Determines if the display mode should consider iframe request or not. A sample application of this logic will be to determine if the COMMENT HTML tags have to be generated in order for the response to be processed correctly by the iframe in the page. If the logic is to be specialized for the application, please overwrite AbstractAppTransform.localIsIFrameDisplayMode().

Specified by:

isIFrameDisplayMode in interface AppTransform

Overrides:

isIFrameDisplayMode in class AbstractAppTransform

Returns:

boolean value indicating if the display mode of this transform should be generated for iframe manipulation or not

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)

Transforms the associated DerivedElementsEditorBean. Calls renderMetricInfo() and renderSlider()

Specified by:

renderEditorContents in class AbstractEditorTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

renderCurrentElement

public void renderCurrentElement(MarkupOutput out)

renderNoCurrentElement

protected void renderNoCurrentElement(MarkupOutput out)

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Returns:

the description of the transform

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Description copied from class: AbstractAppTransform

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a root class/interface supported by this transform.

hasValidationError

public boolean hasValidationError()

renderValidationErrorMessage

public void renderValidationErrorMessage(MarkupOutput out)

setBoneProperties

protected void setBoneProperties(JsonGenerator boneProps)

Description copied from class: AbstractAppTransform

Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter)
Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Overrides:

setBoneProperties in class AbstractAppTransform

Parameters:

boneProps - the JsonGenerator object that contains the collection of bone properties.