Package com.microstrategy.web.app.transforms

Class FormulaBarTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FormulaBarTransform
extends AbstractEditorTransform
implements LayoutTransform

Title: FormulaBarTransform.

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

Copyright: Copyright (c) 2002

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
FormalParameter	boneSubType	Indicates the name the formula bar subtype used in RW's Bone framework.
FormalParameter	formulaBarID	Indicates the ID for the formula bar used in Javascript functions.
FormalParameter	goImage	Indicates name of the GO image to be used in HTML mode.
FormalParameter	imgError	Indicates the name of error image.
FormalParameter	insertNewMetricTitleId	Indicates the ID for the descriptor to be used as title for new Metric Editor.
FormalParameter	onChangeJSfunction	Indicates the name of the JS function to be executed when pull-down menu has been manipulated.
FormalParameter	renameEditObjTitleId	Indicates the ID for the descriptor to be used as title for Rename/edit Objects Editor.

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of current transform class.
WebEvent	getFormulaBarProcessEvent()	Returns an instance of the event responsible for processing the editor's actions
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
protected void	initEditor(Editor editor)	Initialize the editor with the global settings.
protected void	initHelp(Editor editor)
void	initializeFormalParameters()	Initialize the css classes to be used by this transform.
void	initializeImages()	Initialize the images to be used by this transform.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
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	renderFormulaAggregateFromBaseInput(MarkupOutput out)
void	renderFormulaAggregateFromBaseTitle(MarkupOutput out)
void	renderFormulaDefinitionSection(MarkupOutput out)	Renders definition area within Formula Bar editor.
void	renderFormulaDynamicAliasInput(MarkupOutput out)	Renders the check box for the dynamic alias section
void	renderFormulaDynamicAliasTitle(MarkupOutput out)	Renders the title label that appears before the dynamic alias input section
void	renderFormulaNameText(MarkupOutput out)	Renders the text input for the formula name section
void	renderFormulaNameTitle(MarkupOutput out)	Renders the title label that appears before the formula name section
void	renderFormulaTextArea(MarkupOutput out)	Renders definition text area where end-users can enter new derived metric formula.
void	renderFormulaUnitsList(MarkupOutput out)	Renders a select box containing the formulas associated with the report
void	renderFormulaUnitsTitle(MarkupOutput out)	Renders the title label that appears before the units list section
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.
boolean	showAggFromBaseCheckBox()
boolean	showDatasetsList()

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

generateForm, getDivTagAroundContents, getEditorTitle, getOnSubmitJS, getWebBeanErrorInfo, renderEditor, renderEditorElement, renderJavascript, setFocusFieldId, transformForRequestInError, transformForRequestSuccessful

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, 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, 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

goImage

public FormalParameter goImage

Indicates name of the GO image to be used in HTML mode.

onChangeJSfunction

public FormalParameter onChangeJSfunction

Indicates the name of the JS function to be executed when pull-down menu has been manipulated.

boneSubType

public FormalParameter boneSubType

Indicates the name the formula bar subtype used in RW's Bone framework.

formulaBarID

public FormalParameter formulaBarID

Indicates the ID for the formula bar used in Javascript functions.

imgError

public FormalParameter imgError

Indicates the name of error image.

insertNewMetricTitleId

public FormalParameter insertNewMetricTitleId

Indicates the ID for the descriptor to be used as title for new Metric Editor.

renameEditObjTitleId

public FormalParameter renameEditObjTitleId

Indicates the ID for the descriptor to be used as title for Rename/edit Objects Editor.

Constructor Detail

FormulaBarTransform

public FormulaBarTransform()

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

initializeFormalParameters

public void initializeFormalParameters()

Initialize the css classes to be used by this transform.

initializeImages

public void initializeImages()

Initialize the images to be used by this transform.

Overrides:

initializeImages in class AbstractAppTransform

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports FormulaBarBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

FormulaBarBean.class 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.

getFormulaBarProcessEvent

public WebEvent getFormulaBarProcessEvent()

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

Returns:

the EnumFormulaBarEvents.WebEventFormulaBarProcess event

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.

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.

renderFormulaUnitsTitle

public void renderFormulaUnitsTitle(MarkupOutput out)

Renders the title label that appears before the units list section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderFormulaNameTitle

public void renderFormulaNameTitle(MarkupOutput out)

Renders the title label that appears before the formula name section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderFormulaNameText

public void renderFormulaNameText(MarkupOutput out)

Renders the text input for the formula name section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderFormulaDynamicAliasTitle

public void renderFormulaDynamicAliasTitle(MarkupOutput out)

Renders the title label that appears before the dynamic alias input section

Parameters:

out - MarkupOutput instance where to create the HTML output.

renderFormulaDynamicAliasInput

public void renderFormulaDynamicAliasInput(MarkupOutput out)

Renders the check box for the dynamic alias section

Parameters:

out - MarkupOutput instance where to create the HTML output.

showAggFromBaseCheckBox

public boolean showAggFromBaseCheckBox()

renderFormulaAggregateFromBaseTitle

public void renderFormulaAggregateFromBaseTitle(MarkupOutput out)

renderFormulaAggregateFromBaseInput

public void renderFormulaAggregateFromBaseInput(MarkupOutput out)

renderFormulaDefinitionSection

public void renderFormulaDefinitionSection(MarkupOutput out)

Renders definition area within Formula Bar editor.
It breaks this section into HTML list which defines a list of available metrics; also, a formula area is rendered from here where a text area is displayed.

Parameters:

out - MarkupOutput where to write output.

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.

showDatasetsList

public boolean showDatasetsList()

renderFormulaTextArea

public void renderFormulaTextArea(MarkupOutput out)

Renders definition text area where end-users can enter new derived metric formula.

Parameters:

out - MarkupOutput where to write output.

renderFormulaUnitsList

public void renderFormulaUnitsList(MarkupOutput out)

Renders a select box containing the formulas associated with the report

Parameters:

out - MarkupOutput to be used

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.

initHelp

protected void initHelp(Editor editor)

Overrides:

initHelp in class AbstractEditorTransform

Since:

MicroStrategy Web 9.0.0