public class

FormatTabAlignmentTransform

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

Class Overview

This class transforms a FormatTabBean allowing users to modify the corresponding alignment properties of a control. 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 main sections:

  • Text Alignment
  • Text Control
    Each one of these sections has its own render method. Furthermore each section generates individual settings which are 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:
         ContentsBody
         -------------------------------------
         |  TextAlignmentSection             |
         |    - HorizontalAlignmentSection   |
         |    - VerticalAlignmentSection     |
         |                                   |
         |                                   |
         -------------------------------------
         |  TextControlSection               |
         |    - TextControlWordWrapSection   |
         |    - TextControlVerticalTextSection|
         -------------------------------------
         | PaddingSection                    |
         |   - TextPaddingSection            |
         -------------------------------------
     

  • Summary

    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractFormatTabTransform
    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.AbstractFormatTabTransform
    From class com.microstrategy.web.app.transforms.AbstractTabTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    FormatTabAlignmentTransform()
    Default no-argument 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 initializeImages()
    Initializes the name of the images to use on this transform's output.
    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 initializeWebComponent(Transformable data)
    Initialize the web component to be used by the transform.
    void renderBottomPaddingSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the bottom padding setting on the currently selected target object(s).
    void renderContentsBody(MarkupOutput out)

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

    void renderHorizontalAlignmentSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the horizontal alignment setting.
    void renderJavascriptLinks(MarkupOutput out)
    Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.
    void renderLeftPaddingSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the left padding setting on the currently selected target object(s).
    void renderPaddingSection(MarkupOutput out)
    Generates the HTML output for the Padding section on this format tab instance.
    void renderRightPaddingSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the right padding setting on the currently selected target object(s).
    void renderTextAlignmentSection(MarkupOutput out)

    Generates the HTML output for the Text Alignment section.

    void renderTextControlSection(MarkupOutput out)
    Generates the HTML output for the Text Control section on this format tab instance.
    void renderTextControlVerticalTextSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the vertical text setting.
    void renderTextControlWordWrapSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the word wrap setting.
    void renderTopPaddingSection(MarkupOutput out)
    Displays the interface for allowing the user to modify the top padding setting on the currently selected target object(s).
    void renderVerticalAlignmentSection(MarkupOutput out)
    Generates the HTML that allows the user to modify the vertical alignment setting .
    Protected Methods
    FormatTabBean getFormatTabBean()
    Obtain the FormatTabBean instance currently being transformed.
    [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 FormatTabAlignmentTransform ()

    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 Class getSupportedBeanType ()

    Returns the supported bean type. This transform supports any of the FormatTabBean instances

    Returns
    • FormatTabBean.class

    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 initializeImages ()

    Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

    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 initializeWebComponent (Transformable data)

    Initialize the web component to be used by the transform.

    Parameters
    data the bean to transform.

    public void renderBottomPaddingSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the bottom padding setting on the currently selected target object(s).

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

    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 renderTextAlignmentSection(MarkupOutput) and renderTextControlSection(MarkupOutput).

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderHorizontalAlignmentSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the horizontal alignment setting.

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderJavascriptLinks (MarkupOutput out)

    Extends the parent method by adding the JavaScript file this transform needs for its correct behavior on the client side.

    Parameters
    out MarkupOutput instance where the HTML generated will be saved.

    public void renderLeftPaddingSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the left padding setting on the currently selected target object(s).

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

    public void renderPaddingSection (MarkupOutput out)

    Generates the HTML output for the Padding section on this format tab instance. Calls renderTabSectionTitle(), renderLeftPaddingSection(), renderRightPaddingSection(), renderTopPaddingSection() and renderBottomPaddingSection().

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

    public void renderRightPaddingSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the right padding setting on the currently selected target object(s).

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

    public void renderTextAlignmentSection (MarkupOutput out)

    Generates the HTML output for the Text Alignment section.

    It calls renderTabSectionTitle(MarkupOutput, String), renderHorizontalAlignmentSection(MarkupOutput) and if it's a crossTab object renderVerticalAlignmentSection(MarkupOutput).

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderTextControlSection (MarkupOutput out)

    Generates the HTML output for the Text Control section on this format tab instance. Calls renderTextControlWordWrapSection().

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderTextControlVerticalTextSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the vertical text setting.

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderTextControlWordWrapSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the word wrap setting.

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    public void renderTopPaddingSection (MarkupOutput out)

    Displays the interface for allowing the user to modify the top padding setting on the currently selected target object(s).

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

    public void renderVerticalAlignmentSection (MarkupOutput out)

    Generates the HTML that allows the user to modify the vertical alignment setting .

    Parameters
    out MarkupOutput instance where the HTML contents gets generated.

    Protected Methods

    protected FormatTabBean getFormatTabBean ()

    Obtain the FormatTabBean instance currently being transformed.

    Returns