public class

SurveyVisualizationPropertiesTransform

extends VisualizationPropertiesTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.VisualizationPropertiesTransform
           ↳ com.microstrategy.web.app.transforms.SurveyVisualizationPropertiesTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.VisualizationPropertiesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected HashList<String, String> attributeForms
protected HashList<String, String> attributeMap
protected HashList<String, String> attributes
protected HashList<String, String> metrics
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.VisualizationPropertiesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SurveyVisualizationPropertiesTransform()
Public Methods
ArrayList<SurveyObject> getSurveyObjects()
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

boolean isValidGrid()
void renderAttributeSelectBox(MarkupOutput out, SurveyObject so)
void renderColorThemeSelectBox(MarkupOutput out, String propName)
void renderIsRequired(MarkupOutput out, SurveyObject so)
void renderSurveySemanticsTitle(MarkupOutput out, SurveyObject so)
void renderValidationError(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.
Protected Methods
HashList<String, String> getAttributes()
HashList<String, String> getMetrics()
String getScriptClass()

Returns the name of the javaScript class (if any) to be associated with the component.

[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.VisualizationPropertiesTransform
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 HashList<String, String> attributeForms

protected HashList<String, String> attributeMap

protected HashList<String, String> attributes

protected HashList<String, String> metrics

Public Constructors

public SurveyVisualizationPropertiesTransform ()

Public Methods

public ArrayList<SurveyObject> getSurveyObjects ()

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public boolean isValidGrid ()

public void renderAttributeSelectBox (MarkupOutput out, SurveyObject so)

public void renderColorThemeSelectBox (MarkupOutput out, String propName)

public void renderIsRequired (MarkupOutput out, SurveyObject so)

public void renderSurveySemanticsTitle (MarkupOutput out, SurveyObject so)

public void renderValidationError (MarkupOutput out)

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

Protected Methods

protected HashList<String, String> getAttributes ()

protected HashList<String, String> getMetrics ()

protected String getScriptClass ()

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Returns
  • String representing the name of a javaScript class