public class

TabPropertiesGridTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify properties of a grid (like header options, shows thresholds, etc). 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 is divided into two sections:

  • Headers Section
  • View Section
    Each one of these sections has its own render method. Furthermore each section generates individual settings which are generated in 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
         -------------------------------------
         |                                   |
         |  Headers Section                  |
         |                                   |
         -------------------------------------
         |                                   |
         |  View Section                     |
         |                                   |
         -------------------------------------
     

  • Summary

    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    [Expand]
    Inherited Fields
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    TabPropertiesGridTransform()
    Default constructor.
    Public Methods
    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 renderAttributeFormsOption(MarkupOutput out)
    Generates the HTML output for Show Attribute Forms option.
    void renderBandingOption(MarkupOutput out)
    Generates the HTML output for Show Banding option.
    void renderColumnOptions(MarkupOutput out)
    Generates the HTML output for the column headers section options.
    void renderContentsBody(MarkupOutput out)
    Generates the HTML output for the Generic section on this properties tab instance.
    void renderDrillSection(MarkupOutput out)
    Generates the HTML output for the Drill section on this properties tab instance.
    void renderExecutionFullScreenMode(MarkupOutput out)
    void renderHeadersSection(MarkupOutput out)
    Generates the HTML output for the Headers section on this properties tab instance.
    void renderHideNullsOption(MarkupOutput out)
    void renderIncrementalFetchSection(MarkupOutput out)
    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderOutlineOption(MarkupOutput out)
    Generates the HTML output for Show Outline mode option.
    void renderRowOptions(MarkupOutput out)
    Generates the HTML output for the row headers section options.
    void renderThresholdsOption(MarkupOutput out)
    Generates the HTML output for Show Thresholds option.
    void renderTitleOverlapOption(MarkupOutput out)
    Generates the HTML output for Title Overlap option.
    void renderViewSection(MarkupOutput out)
    Generates the HTML output for the View section on this properties tab instance.
    [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

    Public Constructors

    public TabPropertiesGridTransform ()

    Default constructor. Initializes the formal parameters.

    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 transform supports a TabBean instance

    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. In particular it invokes the initializeJavaScriptAttribute() method.

    Parameters
    data Transformable instance to be transformed.

    public void renderAttributeFormsOption (MarkupOutput out)

    Generates the HTML output for Show Attribute Forms option.

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

    public void renderBandingOption (MarkupOutput out)

    Generates the HTML output for Show Banding option.

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

    public void renderColumnOptions (MarkupOutput out)

    Generates the HTML output for the column headers section options.

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

    public void renderContentsBody (MarkupOutput out)

    Generates the HTML output for the Generic section on this properties tab instance. Calls renderHeadersSection() and renderViewSection().

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

    public void renderDrillSection (MarkupOutput out)

    Generates the HTML output for the Drill section on this properties tab instance.

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

    public void renderExecutionFullScreenMode (MarkupOutput out)

    public void renderHeadersSection (MarkupOutput out)

    Generates the HTML output for the Headers section on this properties tab instance.

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

    public void renderHideNullsOption (MarkupOutput out)

    public void renderIncrementalFetchSection (MarkupOutput out)

    public void renderJavascriptLinks (MarkupOutput out)

    Used to dynamically include links to js files. Extend with the list of files your transform requires.

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

    public void renderOutlineOption (MarkupOutput out)

    Generates the HTML output for Show Outline mode option.

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

    public void renderRowOptions (MarkupOutput out)

    Generates the HTML output for the row headers section options.

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

    public void renderThresholdsOption (MarkupOutput out)

    Generates the HTML output for Show Thresholds option.

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

    public void renderTitleOverlapOption (MarkupOutput out)

    Generates the HTML output for Title Overlap option.

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

    public void renderViewSection (MarkupOutput out)

    Generates the HTML output for the View section on this properties tab instance.

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