public class

TabPropertiesLayoutTransform

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

Class Overview

Title: TabPropertiesLayoutTransform.

This class transforms a TabBean allowing users to view/modify the layout of a control (for example, position, size, visibility). 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 the following sections:

  • Visible
  • PageBreak
  • Position Section
  • Size Section
    Each one Each one of these sections has its own render method. Furthermore each section generates individual settings which might be 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 changes depending on the selection. By default is as:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  Position Section                 |
         |                                   |
         -------------------------------------
         |                                   |
         |  Size Section                     |
         |                                   |
         -------------------------------------
     
    For sub-sections we have:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  SubSection Size Section          |
         |                                   |
         -------------------------------------
         |                                   |
         |  PageBreak Section                |
         |                                   |
         -------------------------------------
     
    And for grids, the default layout is:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  Position Section                 |
         |                                   |
         -------------------------------------
         |                                   |
         |  Size Section                     |
         |                                   |
         -------------------------------------
         |                                   |
         |  Grid 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
    TabPropertiesLayoutTransform()
    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.
    boolean isControl()
    boolean isCrossTab()
    Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unit RWUNIT_GRIDGRAPH)
    boolean isSubSection()
    Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)
    void renderContentsBody(MarkupOutput out)

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

    void renderDataSourceOptions(MarkupOutput out)
    If the targetBean of the TabBean is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.
    void renderGridSection(MarkupOutput out)
    Generates the HTML output for the Grid section on this properties tab instance.
    void renderGridSectionDetails(MarkupOutput out)
    Generates the HTML output for the grid section details in the Grid section on this properties tab instance.
    void renderItemSection(MarkupOutput out)
    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderLeftAndTopSection(MarkupOutput out)
    Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.
    void renderLengthSection(MarkupOutput out)
    Generates the HTML output for the Length section in the Size section on this properties tab instance.
    void renderPageBreakSection(MarkupOutput out)
    Generates the HTML output for the Page Break section on this properties tab instance.
    void renderPositionSection(MarkupOutput out)
    Generates the HTML output for the Position section on this properties tab instance.
    void renderResizeSection(MarkupOutput out)
    Generates the HTML output for the resize section of the object in the size section on this properties tab instance.
    void renderSizeSection(MarkupOutput out)
    Generates the HTML output for the Size section on this properties tab instance.
    void renderSubSectionSizeSection(MarkupOutput out)
    Generates the HTML output for the Size section on this properties tab instance.
    void renderTitleHeightSection(MarkupOutput out)
    void renderWidthandHeightSection(MarkupOutput out)
    Generates the HTML output for the Width and Height section in the Size section on this properties tab instance.
    Protected Methods
    TabBean getTabBean()
    Returns the TabBean for this tab.
    [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 TabPropertiesLayoutTransform ()

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

    Parameters
    data Transformable instance to be transformed.

    public boolean isControl ()

    public boolean isCrossTab ()

    Returns true if the selection in the report-writing document whose properties are being edited is a template or a cross-tab unit RWUNIT_GRIDGRAPH)

    Returns
    • true if the selection is a template or a cross-tab unit.

    public boolean isSubSection ()

    Returns true if the selection in the report-writing document whose properties are being edited is a subsection or not (of type EnumRWUnitTypes.RWUNIT_SUBSECTION)

    Returns
    • true if the selection is a subsection

    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 renderSubSectionSizeSection(), renderPageBreakSection(), renderGridSection(), renderPositionSection(), renderResizeSection() and/or renderSizeSection() based on what object the user is trying to set properties to.

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

    public void renderDataSourceOptions (MarkupOutput out)

    If the targetBean of the TabBean is a RWBean, it renders a comboBox that allows users the change the dataset for the current control.

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

    public void renderGridSection (MarkupOutput out)

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

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

    public void renderGridSectionDetails (MarkupOutput out)

    Generates the HTML output for the grid section details in the Grid section on this properties tab instance.

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

    public void renderItemSection (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 renderLeftAndTopSection (MarkupOutput out)

    Generates the HTML output for the Left and Top section in the Position section on this properties tab instance.

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

    public void renderLengthSection (MarkupOutput out)

    Generates the HTML output for the Length section in the Size section on this properties tab instance.

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

    public void renderPageBreakSection (MarkupOutput out)

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

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

    public void renderPositionSection (MarkupOutput out)

    Generates the HTML output for the Position section on this properties tab instance. Calls renderPositionSectionTitle(), renderLeftAndTopSection.

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

    public void renderResizeSection (MarkupOutput out)

    Generates the HTML output for the resize section of the object in the size section on this properties tab instance.

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

    public void renderSizeSection (MarkupOutput out)

    Generates the HTML output for the Size section on this properties tab instance. Calls renderSizeSectionTitle(), renderWidthandHeightSection

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

    public void renderSubSectionSizeSection (MarkupOutput out)

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

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

    public void renderTitleHeightSection (MarkupOutput out)

    public void renderWidthandHeightSection (MarkupOutput out)

    Generates the HTML output for the Width and Height section in the Size section on this properties tab instance.

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

    Protected Methods

    protected TabBean getTabBean ()

    Returns the TabBean for this tab.

    Returns
    • TabBean for this tab.