public class

TabPageSetupTransform

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

Class Overview

This class transforms a TabBean allowing users to view/modify general page output properties (like graphs format, PDF settings, horizontal fit). 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:

  • Paper size section.
  • Scaling Section
    Each one of these sections 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 divided as follows: 
         Contents / ContentsBody
     -------------------------------------
     |                                   |
     |  Paper size Section               |
     |                                   |
     -------------------------------------
     |                                   |
     |  Scaling Section                  |
     |                                   |
     -------------------------------------

    • Summary

    Constants
    String LAYOUT_WIDTH_MODE_AUTO_OPTION
    String LAYOUT_WIDTH_MODE_FIXED_OPTION
    String PROPERTYSET_NAME_FORMATTING_PAGE
    String PROPERTY_NAME_LAYOUT_WIDTH_MODE
    String PROPERTY_NAME_PAPER_HEIGHT
    String PROPERTY_NAME_PAPER_ORIENTATION
    String PROPERTY_NAME_PAPER_TYPE
    String PROPERTY_NAME_PAPER_WIDTH
    String PROPERTY_NAME_SCALE_HEADER_FOOTER
    String PROPERTY_NAME_SCALE_PAGES_TALL
    String PROPERTY_NAME_SCALE_PAGES_WIDE
    String PROPERTY_NAME_SCALE_PERCENTAGE
    String PROPERTY_NAME_SCALING
    String PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW
    String PROPERTY_NAME_USE_PAGEWIDTH_AS_LAYOUTWIDTH
    String SCALING_FIT_TO_PAGE_OPTION
    String SCALING_SHRINK_FONT_OPTION
    [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
    TabPageSetupTransform()
    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 renderHorizontalFitSection(MarkupOutput out)
    Generates the HTML output for the horizontal fit section on this tab instance.
    static void renderHorizontalFitSection(MarkupOutput out, AbstractTabTransform t, String cssPrefix, String beanName, String propValue)
    Generates the HTML output for the horizontal fit section on this tab instance.
    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderPaperSizeSection(MarkupOutput out)
    Generates the HTML output for the Page setup section on this tab instance.
    void renderScalingSection(MarkupOutput out)
    Generates the HTML output for the Scaling 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 LAYOUT_WIDTH_MODE_AUTO_OPTION

    Constant Value: "0"

    public static final String LAYOUT_WIDTH_MODE_FIXED_OPTION

    Constant Value: "1"

    public static final String PROPERTYSET_NAME_FORMATTING_PAGE

    Constant Value: "FormattingPage"

    public static final String PROPERTY_NAME_LAYOUT_WIDTH_MODE

    Constant Value: "LayoutWidthMode"

    public static final String PROPERTY_NAME_PAPER_HEIGHT

    Constant Value: "PageHeight"

    public static final String PROPERTY_NAME_PAPER_ORIENTATION

    Constant Value: "Orientation"

    public static final String PROPERTY_NAME_PAPER_TYPE

    Constant Value: "PaperType"

    public static final String PROPERTY_NAME_PAPER_WIDTH

    Constant Value: "PageWidth"

    public static final String PROPERTY_NAME_SCALE_HEADER_FOOTER

    Constant Value: "ScalePageHeaderFooter"

    public static final String PROPERTY_NAME_SCALE_PAGES_TALL

    Constant Value: "ScalePagesTall"

    public static final String PROPERTY_NAME_SCALE_PAGES_WIDE

    Constant Value: "ScalePagesWide"

    public static final String PROPERTY_NAME_SCALE_PERCENTAGE

    Constant Value: "ScalePercentage"

    public static final String PROPERTY_NAME_SCALING

    Constant Value: "Scaling"

    public static final String PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW

    Constant Value: "SectionHorizontalOverflow"

    public static final String PROPERTY_NAME_USE_PAGEWIDTH_AS_LAYOUTWIDTH

    Constant Value: "UsePageWidthAsLayoutWidth"

    public static final String SCALING_FIT_TO_PAGE_OPTION

    Constant Value: "1"

    public static final String SCALING_SHRINK_FONT_OPTION

    Constant Value: "0"

    Public Constructors

    public TabPageSetupTransform ()

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

    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 renderPaperSizeSection() and renderScalingSection().

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

    public void renderHorizontalFitSection (MarkupOutput out)

    Generates the HTML output for the horizontal fit section on this tab instance.

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

    public static void renderHorizontalFitSection (MarkupOutput out, AbstractTabTransform t, String cssPrefix, String beanName, String propValue)

    Generates the HTML output for the horizontal fit section on this tab instance.

    Parameters
    out MarkupOutput instance where the HTML contents to render will be saved.
    t AbstractTabTransform to be used for rendering html.
    cssPrefix String the css prefix
    beanName String the name to be used for acessing the client-side bone.
    propValue String the value of the PROPERTY_NAME_SECTION_HORIZONTAL_OVERFLOW property.

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

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

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

    public void renderScalingSection (MarkupOutput out)

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

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