public class

TabGraphAxesTransform

extends AbstractTabTransform
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.AbstractTabTransform
           ↳ com.microstrategy.web.app.transforms.TabGraphAxesTransform

Class Overview

This class transforms a TabBean allowing users to modify axis properties (like max/min values) of a graph. As with other tab transforms, this one assumes its TabManagerBean will take care of rendering the required HTML & Javascript allowing users to switch between different formatting TabBean instances.

The axis list is specified through the axisList Formal Parameter. For each axis, the renderAxisInformation(MarkupOutput, Integer) method is called. This method receives an axisId which is an integer value. Valid values are those from the EnumDSSXMLGraphAttributeID enumeration.

Before we start generating output for each axis, the method checks whether the axis is available for the current major graph type, if it is not, nothing is rendered for that axis.

This Transform implements LayoutTransform, therefore its render methods can be invoked using a custom layout-xml. When this is the case, the layout-xml specified in the style-catalog controls which methods are called and in which order. Otherwise, the default output of this transform is divided as follows:
     Contents / ContentsBody
     -----------------------------------------------------
     |    AxisInformation (1)                            |
     -----------------------------------------------------
     |                                                   |
     |      Manual Axis Settings (if applicable)         |
     |                                                   |
     -----------------------------------------------------
     |    AxisInformation (2)                            |
     -----------------------------------------------------
     |                                                   |
     |      Manual Axis Settings (if applicable)         |
     |                                                   |
     - - - - - - - - - - - - - - - - - - - - - - - - - - -
     |  ...                                              |
     |                                                   |
     - - - - - - - - - - - - - - - - - - - - - - - - - - -
 

Summary

Constants
String FP_AXIS_LIST Constant specifying the name of the formal parameter for defining the list of axes that will be rendered by this transform as possible format options.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter axisList Indicates which axes that will be rendered by this format tab as options, as long as the current graph major type supports them.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractTabTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
TabGraphAxesTransform()
Default no-argument constructor.
Public Methods
List getAxes()
The List of axes to generate settings for.
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css Classes to use.
void initializeJavaScriptAttributes()
For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderAxisInformation(MarkupOutput out, Integer showAxisId)

Method that renders the available settings for a given axis, rendering its show check box as well as manual formatting settings if applicable.

void renderContentsBody(MarkupOutput out)

This is the entry point for the Tranform, and generates the body of the Tab.

void renderJavascriptLinks(MarkupOutput out)
Render any JavaScript information required for this tab to work correctly on client side.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractTabTransform
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

Constants

public static final String FP_AXIS_LIST

Constant specifying the name of the formal parameter for defining the list of axes that will be rendered by this transform as possible format options. Value is axisList.

Constant Value: "axisList"

Fields

public FormalParameter axisList

Indicates which axes that will be rendered by this format tab as options, as long as the current graph major type supports them.
Value is a series of attribute identifiers (from EnumDSSXMLGraphAttributeID) of their show property, separated by comma.

Public Constructors

public TabGraphAxesTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public List getAxes ()

The List of axes to generate settings for. This list is set through the axisList formal parameter. The axis are saved in the list as Integer.

Returns
  • an Integer list with the axes to generate properties for.

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 transform supports any of the TabBean instances

Returns
  • the class of the bean supported by this transform.

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void initializeJavaScriptAttributes ()

For JavaScript, certain properties are required to be added to the HTML tags to generate for its integration with the code generated for the feature to work in DHTML environments. This method assigns values to these attributes, so they can be displayed together with the tags they represent. If a value is set to be null, it won't be included on the HTML tag definition. By default, it includes the definition of values for properties such as styFrame, tyFrame and scriptClassFrame.

public void initializeTransform (Transformable data)

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

Parameters
data Transformable instance to be transformed.

public void renderAxisInformation (MarkupOutput out, Integer showAxisId)

Method that renders the available settings for a given axis, rendering its show check box as well as manual formatting settings if applicable.

Axis id valid values are those from the EnumDSSXMLGraphAttributeID enumeration.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.
showAxisId axis id.

public void renderContentsBody (MarkupOutput out)

This is the entry point for the Tranform, and generates the body of the Tab.

If a layout-xml is specified, this method will delegate the output generation to the Layout parser, otherwise it calls renderAxisInformation() for each axis in returned by the getAxes list.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

public void renderJavascriptLinks (MarkupOutput out)

Render any JavaScript information required for this tab to work correctly on client side.

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.