public class

FormulaBarTransform

extends AbstractEditorTransform
implements LayoutTransform
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

Class Overview

Title: FormulaBarTransform.

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

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter boneSubType Indicates the name the formula bar subtype used in RW's Bone framework.
public FormalParameter formulaBarID Indicates the ID for the formula bar used in Javascript functions.
public FormalParameter goImage Indicates name of the GO image to be used in HTML mode.
public FormalParameter imgError Indicates the name of error image.
public FormalParameter insertNewMetricTitleId Indicates the ID for the descriptor to be used as title for new Metric Editor.
public FormalParameter onChangeJSfunction Indicates the name of the JS function to be executed when pull-down menu has been manipulated.
public FormalParameter renameEditObjTitleId Indicates the ID for the descriptor to be used as title for Rename/edit Objects Editor.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FormulaBarTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
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
Class getSupportedBeanType()
Returns the supported bean type.
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
boolean showAggFromBaseCheckBox()
boolean showDatasetsList()
Protected Methods
void initEditor(Editor editor)
Initialize the editor with the global settings.
void initHelp(Editor editor)
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

public FormalParameter boneSubType

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

public FormalParameter formulaBarID

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

public FormalParameter goImage

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

public FormalParameter imgError

Indicates the name of error image.

public FormalParameter insertNewMetricTitleId

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

public FormalParameter onChangeJSfunction

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

public FormalParameter renameEditObjTitleId

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

Public Constructors

public FormulaBarTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of current transform class.

Returns
  • String the description of the transform.

public WebEvent getFormulaBarProcessEvent ()

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

Returns
  • the EnumFormulaBarEvents.WebEventFormulaBarProcess event

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports FormulaBarBean instances

Returns
  • FormulaBarBean.class instance.

public void initializeFormalParameters ()

Initialize the css classes to be used by this transform.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

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

Parameters
data bean that will be transformed

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutput instance where to create the HTML output.

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.

public void renderFormulaAggregateFromBaseInput (MarkupOutput out)

public void renderFormulaAggregateFromBaseTitle (MarkupOutput out)

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.

public void renderFormulaDynamicAliasInput (MarkupOutput out)

Renders the check box for the dynamic alias section

Parameters
out MarkupOutput instance where to create the HTML output.

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.

public void renderFormulaNameText (MarkupOutput out)

Renders the text input for the formula name section

Parameters
out MarkupOutput instance where to create the HTML output.

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.

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.

public void renderFormulaUnitsList (MarkupOutput out)

Renders a select box containing the formulas associated with the report

Parameters
out MarkupOutput to be used

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.

public boolean showAggFromBaseCheckBox ()

public boolean showDatasetsList ()

Protected Methods

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

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

protected void initHelp (Editor editor)

protected void setBoneProperties (JsonGenerator boneProps)

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

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