public class

TabDocumentOtherTransform

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

This class is deprecated.
- Since we now use the JUIL architecture, these transforms are no longer being used.

Class Overview

This class transforms a TabBean allowing users to view/modify general properties of a dodument (for example, default grid's autostyles and exporting options). 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 three sections:

  • Miscellaneous section.
  • Export options Section
  • Conditional Formatting 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 changes depending on the selection. By default is as:
         Contents / ContentsBody
         -------------------------------------
         |                                   |
         |  Misc Section                     |
         |                                   |
         -------------------------------------
         |                                   |
         |  Mobile Section           |
         |                                   |
         -------------------------------------
         |                                   |
         |  Conditional Formatting 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
    TabDocumentOtherTransform()
    Public Methods
    int getAvailableViewMedia()
    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 renderAutowire(MarkupOutput out, TabBean otherTabBean)
    void renderAvailableViewModes(MarkupOutput out, int availableViewModes, TabBean otherTabBean)
    void renderConditionalFormattingSection(MarkupOutput out, TabBean otherTabBean)
    void renderContentsBody(MarkupOutput out)

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

    void renderCtlAutoSubmit(MarkupOutput out, TabBean otherTabBean)
    void renderDefaultRunMode(MarkupOutput out)
    void renderDefaultRunModeCombo(MarkupOutput out)
    void renderDefaultViewMode(MarkupOutput out, int defaultViewMode, TabBean otherTabBean)
    This method is deprecated. Please use renderDefaultRunModeCombo(MarkupOutput) instead
    void renderDocumentWidthMode(MarkupOutput out)
    void renderExecutionFullScreenMode(MarkupOutput out, TabBean otherTabBean)
    void renderExportModeBlock(MarkupOutput out, TabBean otherTabBean)
    void renderExportModeLabel(MarkupOutput out)
    void renderJavascriptLinks(MarkupOutput out)
    Used to dynamically include links to js files.
    void renderMiscSection(MarkupOutput out, TabBean otherTabBean)
    Generates the HTML output for the Misc section on this tab instance.
    void renderMobileSection(MarkupOutput out, TabBean layoutBean)
    This method is deprecated. this section has been moved to the TabDocumentExportTransform.
    void renderShowFloatingToolbars(MarkupOutput out, TabBean otherTabBean)
    void renderViewModeBlock(MarkupOutput out, TabBean otherTabBean)
    void renderViewModeLabel(MarkupOutput out)
    void renderViewModeSection(MarkupOutput out, TabBean otherTabBean)
    [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 TabDocumentOtherTransform ()

    Public Methods

    public int getAvailableViewMedia ()

    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 renderAutowire (MarkupOutput out, TabBean otherTabBean)

    public void renderAvailableViewModes (MarkupOutput out, int availableViewModes, TabBean otherTabBean)

    public void renderConditionalFormattingSection (MarkupOutput out, TabBean otherTabBean)

    Parameters
    out MarkupOutput
    otherTabBean TabBean

    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 renderMiscSection() and renderConditionalFormattingSection().

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

    public void renderCtlAutoSubmit (MarkupOutput out, TabBean otherTabBean)

    public void renderDefaultRunMode (MarkupOutput out)

    public void renderDefaultRunModeCombo (MarkupOutput out)

    public void renderDefaultViewMode (MarkupOutput out, int defaultViewMode, TabBean otherTabBean)

    This method is deprecated.
    Please use renderDefaultRunModeCombo(MarkupOutput) instead

    public void renderDocumentWidthMode (MarkupOutput out)

    public void renderExecutionFullScreenMode (MarkupOutput out, TabBean otherTabBean)

    public void renderExportModeBlock (MarkupOutput out, TabBean otherTabBean)

    public void renderExportModeLabel (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 renderMiscSection (MarkupOutput out, TabBean otherTabBean)

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

    Parameters
    out MarkupOutput instance where the HTML contents to render will be saved.
    otherTabBean TabBean being transformed

    public void renderMobileSection (MarkupOutput out, TabBean layoutBean)

    This method is deprecated.
    this section has been moved to the TabDocumentExportTransform.

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

    Parameters
    out MarkupOutput instance where the HTML contents to render will be saved.
    layoutBean TabBean being transformed

    public void renderShowFloatingToolbars (MarkupOutput out, TabBean otherTabBean)

    public void renderViewModeBlock (MarkupOutput out, TabBean otherTabBean)

    public void renderViewModeLabel (MarkupOutput out)

    public void renderViewModeSection (MarkupOutput out, TabBean otherTabBean)