public class

FunctionEditorTransform

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

Class Overview

Transform which renders the Function Editor.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FunctionEditorTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
Iterator<WebFunctionProperty> getFunctionExposedPropertyList()
Iterator getFunctionParameterList()
Iterator getFunctionPropertyList()
Class getSupportedBeanType()
Returns the supported bean type.
boolean hasBreakBySection()
boolean hasSortBySection()
void initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.
boolean isStepOne()
boolean isStepTwo()
void populateTemplateUnitsPulldown(SelectTag pulldown)
void renderAttrFormOption(SelectTag pulldown, BeanContext context, ArrayList<RWDataSetItem> list, WebWorkingSet wrkSet)
Render the attribute form which is from all the datasets
void renderAttrMetricOption(SelectTag pulldown, ArrayList<RWDataSetItem> list, boolean hideDatasetPrefix)
Render the given attribute/metric list from all datasets in order
void renderAvailableCategory(MarkupOutput out)
Render methods***
void renderAvailableFunction(MarkupOutput out)
void renderBreakBySectionInput(MarkupOutput out)
void renderBreakBySectionName(MarkupOutput out)
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
void renderFunctionDescription(MarkupOutput out)
void renderFunctionName(MarkupOutput out)
void renderParamInput(MarkupOutput out, WebFunctionParameter param)
void renderParamName(MarkupOutput out, WebFunctionParameter param)
void renderPropInput(MarkupOutput out, WebFunctionProperty prop)
void renderPropName(MarkupOutput out, WebFunctionProperty prop)
void renderSortByDirectionAsRadioButtons(MarkupOutput out)
void renderSortBySectionInput(MarkupOutput out)
void renderSortBySectionName(MarkupOutput out)
Protected Methods
String getEditorTitle()
void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
[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

Public Constructors

public FunctionEditorTransform ()

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public Iterator<WebFunctionProperty> getFunctionExposedPropertyList ()

public Iterator getFunctionParameterList ()

public Iterator getFunctionPropertyList ()

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 hasBreakBySection ()

public boolean hasSortBySection ()

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 isStepOne ()

public boolean isStepTwo ()

public void populateTemplateUnitsPulldown (SelectTag pulldown)

public void renderAttrFormOption (SelectTag pulldown, BeanContext context, ArrayList<RWDataSetItem> list, WebWorkingSet wrkSet)

Render the attribute form which is from all the datasets

public void renderAttrMetricOption (SelectTag pulldown, ArrayList<RWDataSetItem> list, boolean hideDatasetPrefix)

Render the given attribute/metric list from all datasets in order

Parameters
list is the given attribute/metric list
hideDatasetPrefix specify if the dataset name as a prefix should be hidden

public void renderAvailableCategory (MarkupOutput out)

Render methods***

public void renderAvailableFunction (MarkupOutput out)

public void renderBreakBySectionInput (MarkupOutput out)

public void renderBreakBySectionName (MarkupOutput out)

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderFunctionDescription (MarkupOutput out)

public void renderFunctionName (MarkupOutput out)

public void renderParamInput (MarkupOutput out, WebFunctionParameter param)

public void renderParamName (MarkupOutput out, WebFunctionParameter param)

public void renderPropInput (MarkupOutput out, WebFunctionProperty prop)

public void renderPropName (MarkupOutput out, WebFunctionProperty prop)

public void renderSortByDirectionAsRadioButtons (MarkupOutput out)

public void renderSortBySectionInput (MarkupOutput out)

public void renderSortBySectionName (MarkupOutput out)

Protected Methods

protected String getEditorTitle ()

protected void renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Parameters
out MarkupOutput where the output should be rendered.