public class

DerivedElementsEditorTransform

extends AbstractEditorTransform
implements EnumDerivedElementsEditorEvents 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.DerivedElementsEditorTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.app.beans.EnumDerivedElementsEditorEvents
Fields
protected FormalParameterImpl _calculationStyle
protected FormalParameterImpl _filterStyle
protected FormalParameterImpl _listStyle
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
DerivedElementsEditorTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
boolean hasValidationError()
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.
void renderValidationErrorMessage(MarkupOutput out)
void setShellAttributeOnClosedComponent(HashMap __result)
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for the Projects Bean
Protected Methods
String getEditorTitle()
void initEditor(Editor editor)
Initializes the editor with the global settings.
void renderNoCurrentElement(MarkupOutput out)
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

protected FormalParameterImpl _calculationStyle

protected FormalParameterImpl _filterStyle

protected FormalParameterImpl _listStyle

Public Constructors

public DerivedElementsEditorTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

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;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public boolean hasValidationError ()

public void initializeTransform (Transformable data)

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

Parameters
data bean that will be transformed

public boolean isIFrameDisplayMode ()

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 localIsIFrameDisplayMode().

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

public void renderCurrentElement (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

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

Parameters
out MarkupOutput instance where to create the HTML output

public void renderValidationErrorMessage (MarkupOutput out)

public void setShellAttributeOnClosedComponent (HashMap __result)

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutputinstance where to create the HTML output

Protected Methods

protected String getEditorTitle ()

protected void initEditor (Editor editor)

Initializes the editor with the global settings.

Parameters
editor the Editor to modify.

protected void renderNoCurrentElement (MarkupOutput out)

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.