public class

TabPageMarginTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify the page margins. 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 generated by a single sections:

  • Paper margin section.
    This section has its 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 as follows:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  Paper Margin Section             |
         |                                   |
         -------------------------------------
     

  • Summary

    Constants
    String PROPERTYSET_NAME_FORMATTING_PAGE
    String PROPERTY_NAME_MARGIN_BOTTOM
    String PROPERTY_NAME_MARGIN_LEFT
    String PROPERTY_NAME_MARGIN_RIGHT
    String PROPERTY_NAME_MARGIN_TOP
    [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
    TabPageMarginTransform()
    Default empty 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 renderContentsBody(MarkupOutput out)

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

    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderMarginSection(MarkupOutput out)
    Generates the HTML output for the margin section on this 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

    Constants

    public static final String PROPERTYSET_NAME_FORMATTING_PAGE

    Constant Value: "FormattingPage"

    public static final String PROPERTY_NAME_MARGIN_BOTTOM

    Constant Value: "MarginBottom"

    public static final String PROPERTY_NAME_MARGIN_LEFT

    Constant Value: "MarginLeft"

    public static final String PROPERTY_NAME_MARGIN_RIGHT

    Constant Value: "MarginRight"

    public static final String PROPERTY_NAME_MARGIN_TOP

    Constant Value: "MarginTop"

    Public Constructors

    public TabPageMarginTransform ()

    Default empty constructor.
    Initialize 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 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 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 renderMarginSection().

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

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

    Generates the HTML output for the margin section on this tab instance.

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