public class

SubtotalsEditorTransform

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

Class Overview

This transform renders the subtotals editor.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter propertiesFile Indicates name of the properties file that defines the supported subtotals.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SubtotalsEditorTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
String getDescription()
Returns the textual description of the transform
ArrayList getSubtotalsDefinitions()
ArrayList getSubtotalsDefinitions_OldIServer()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeFormalParameters()
Initialize the css classes to be used by this transform.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderCheckbox(MarkupOutput out, SubtotalDefinition subtotalDef, int subtotalType, int subtotalStyle)
Renders the checkbox for the subtotals events
void renderContentsBody(MarkupOutput out)
Generates the graphical output for the Projects Bean
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
void renderHiddenInputs(MarkupOutput out)
Renders the list of hidden inputs required by the editor
void renderSubtotalCheckbox(MarkupOutput out, SubtotalDefinition subtotalDef)
Renders the Subtotals Checkbox of the current subtotal
void renderSubtotalCheckbox_OldIServer(MarkupOutput out, SubtotalDefinition subtotalDef)
Renders the Subtotals Checkbox of the current subtotal if it's old iserver
void renderSubtotalName(MarkupOutput out, SubtotalDefinition subtotalDef)
Renders the description of the subtotal.
void renderTotalCheckbox(MarkupOutput out, SubtotalDefinition subtotalDef)
Renders the Grand Total Checkbox of the current subtotal
void renderTotalCheckbox_OldIServer(MarkupOutput out, SubtotalDefinition subtotalDef)
Renders the Grand Total Checkbox of the current subtotal if it's old iserver
Protected Methods
String getCheckboxTitle(SubtotalDefinition subtotalDef, int subtotalStyle)
String getOnSubmitJS()
Provides JS code to be executed on the "onsubmit" event of the HTML form.
WebEvent getSubtotalsProcessEvent()
[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 propertiesFile

Indicates name of the properties file that defines the supported subtotals.

Public Constructors

public SubtotalsEditorTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public ArrayList getSubtotalsDefinitions ()

Returns
  • an ArrayList of SubtotalDefinition objects for all the subtotals supported by the editor

public ArrayList getSubtotalsDefinitions_OldIServer ()

Returns
  • an ArrayList of SubtotalDefinition objects for all the subtotals supported by the editor

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports SubtotalsEditorBean instances

Returns
  • SubtotalsEditorBean.class

public void initializeFormalParameters ()

Initialize the css classes 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 renderCheckbox (MarkupOutput out, SubtotalDefinition subtotalDef, int subtotalType, int subtotalStyle)

Renders the checkbox for the subtotals events

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal
subtotalType from EnumSubtotalsEditorEvents
subtotalStyle from EnumDSSXMLSubtotalStyle

public void renderContentsBody (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutput instance where to create the HTML output

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderHiddenInputs (MarkupOutput out)

Renders the list of hidden inputs required by the editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderSubtotalCheckbox (MarkupOutput out, SubtotalDefinition subtotalDef)

Renders the Subtotals Checkbox of the current subtotal

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal

public void renderSubtotalCheckbox_OldIServer (MarkupOutput out, SubtotalDefinition subtotalDef)

Renders the Subtotals Checkbox of the current subtotal if it's old iserver

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal

public void renderSubtotalName (MarkupOutput out, SubtotalDefinition subtotalDef)

Renders the description of the subtotal.

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal

public void renderTotalCheckbox (MarkupOutput out, SubtotalDefinition subtotalDef)

Renders the Grand Total Checkbox of the current subtotal

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal

public void renderTotalCheckbox_OldIServer (MarkupOutput out, SubtotalDefinition subtotalDef)

Renders the Grand Total Checkbox of the current subtotal if it's old iserver

Parameters
out MarkupOutput instance where to create the HTML output
subtotalDef SubtotalDefinition object containing the definition of the subtotal

Protected Methods

protected String getCheckboxTitle (SubtotalDefinition subtotalDef, int subtotalStyle)

protected String getOnSubmitJS ()

Provides JS code to be executed on the "onsubmit" event of the HTML form.
Used for customizations where an action is needed before the form is submitted.
Note: this is only used when the editor uses an event and not JS on the OK/Apply buttons. For those cases use the "okJS" or "applyJS" formal parameters

Returns
  • JS code to be executed on the "onsubmit" event of the HTML form.

protected WebEvent getSubtotalsProcessEvent ()

Returns
  • an intance of the Subtotals Editor Process event the editor uses