public class

TabGraphGeneralTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify general graph properties (like graph type, subtype, categories, etc) of a graph. As with other TabTransforms, this one assumes its TabManagerBean will take care of rendering the required HTML & Javascript allowing users to switch between different formatting TabBean instances.

The output of this transform can be divided into thre main sections:

  • Graph Styles (type and subtype)
  • Maximum Settings (for categories and series)
  • Other (like settings for fonts and series orientation)
    Each one of these sections has its own render method. Furthermore each section generates individual settings which have been divided into their own render method.

    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
         -----------------------------------------------------
         |                                                   |
         |         Graph Styles                              |
         |                                                   |
         |                                                   |
         -----------------------------------------------------
         |                                                   |
         |         Maximum Settings                          |
         |                                                   |
         |                                                   |
         -----------------------------------------------------
         |                                                   |
         |         Other Settings                            |
         |                                                   |
         |                                                   |
         -----------------------------------------------------
     

  • Summary

    Constants
    String FP_SUB_TYPES_PICKER_NAME Constant specifying the name of the subTypesPickerName formal parameter.
    String FP_TYPES_PICKER_NAME Constant specifying the name of the typesPickerName formal parameter.
    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Fields
    public FormalParameter subTypesPickerName Indicates the name of the system picker (defined in the page-config) that contains the list graph sub-types that shall be displayed to the user.
    public FormalParameter typesPickerName Indicates the name of the system picker (defined in the page-config) that contains the list graph types that shall be displayed to the user.
    [Expand]
    Inherited Fields
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    TabGraphGeneralTransform()
    Default no-argument constructor.
    Public Methods
    String getDescription()
    Returns the textual description of the transform
    ShortcutList getSubTypesPicker()
    Returns the graph sub-types picker.
    Class getSupportedBeanType()
    Returns the supported bean type.
    ShortcutList getTypesPicker()
    Returns the graph types picker.
    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 renderAntiAliasing(MarkupOutput out)
    void renderContentsBody(MarkupOutput out)

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

    void renderCurvedLines(MarkupOutput out)
    void renderDropdown(MarkupOutput out, String cmdId, String cmdValue, ShortcutList picker, String value)
    This method renders a single dropdown list to be used within a tab.
    void renderGraphStyles(MarkupOutput out)
    Generates the HTML output for the Graph Styles section on this format tab instance.
    void renderJavascriptLinks(MarkupOutput out)
    Render any JavaScript information required for this tab to work correctly on client side.
    void renderMaximumSettings(MarkupOutput out)
    Generates the HTML output for the Maximum Settings section on this format tab instance.
    void renderRoundedEffect(MarkupOutput out)
    void setSubTypesPicker(ShortcutList picker)

    Register the sub-types picker.

    void setTypesPicker(ShortcutList picker)

    Register the major types picker.

    Protected Methods
    WebGraphProperties getGraphProperties()
    [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_SUB_TYPES_PICKER_NAME

    Constant specifying the name of the subTypesPickerName formal parameter.

    Constant Value: "subTypesPickerName"

    public static final String FP_TYPES_PICKER_NAME

    Constant specifying the name of the typesPickerName formal parameter.

    Constant Value: "typesPickerName"

    Fields

    public FormalParameter subTypesPickerName

    Indicates the name of the system picker (defined in the page-config) that contains the list graph sub-types that shall be displayed to the user.

    public FormalParameter typesPickerName

    Indicates the name of the system picker (defined in the page-config) that contains the list graph types that shall be displayed to the user.

    Public Constructors

    public TabGraphGeneralTransform ()

    Default no-argument constructor. Initializes formal parameters.

    Public Methods

    public String getDescription ()

    Returns the textual description of the transform

    Returns
    • the description of the transform

    public ShortcutList getSubTypesPicker ()

    Returns the graph sub-types picker. If a non-null instance have been registered through the setSubTypesPicker(ShortcutList) method, it will return that one, otherwise, it will search for a system picker with the name specified in subTypesPickerName.

    Returns
    • ShortcutList to use for the graph sub-types picker.

    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 ShortcutList getTypesPicker ()

    Returns the graph types picker. If a non-null instance have been registered through the setTypesPicker method, it will return that one, otherwise, it will search for a system picker with the name specified in typesPickerName.

    Returns

    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 renderAntiAliasing (MarkupOutput out)

    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 renderGraphStyles(), renderMaximumSettings() and renderOtherSettings().

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

    public void renderCurvedLines (MarkupOutput out)

    public void renderDropdown (MarkupOutput out, String cmdId, String cmdValue, ShortcutList picker, String value)

    This method renders a single dropdown list to be used within a tab.

    Parameters
    out MarkupOutput where the content should be generated
    cmdId the dropdown's command id
    cmdValue the dropdown's current command value.
    picker the ShortcutList for the picker.
    value the dropdown current value.

    public void renderGraphStyles (MarkupOutput out)

    Generates the HTML output for the Graph Styles section on this format tab instance. Includes major and subtype option combo boxes.

    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.

    public void renderMaximumSettings (MarkupOutput out)

    Generates the HTML output for the Maximum Settings section on this format tab instance. Includes categories and series.

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

    public void renderRoundedEffect (MarkupOutput out)

    public void setSubTypesPicker (ShortcutList picker)

    Register the sub-types picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker the minor type picker to set.

    public void setTypesPicker (ShortcutList picker)

    Register the major types picker. This allows the transform to use a ShortcutList that is not defined inside the pageConfig.

    Parameters
    picker the major type picker to set.

    Protected Methods

    protected WebGraphProperties getGraphProperties ()