Package com.microstrategy.web.app.transforms

Class TabDocumentTableOfContentsTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class TabDocumentTableOfContentsTransform
extends AbstractTabTransform
implements LayoutTransform
    Deprecated.
    - Since we now use the JUIL architecture, these transforms are no longer being used.

    This class transforms a TabBean allowing users to view/modify table of contents properties of a document. 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.

    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
     -------------------------------------
     |                                   |
     |  TOC Section                     |
     |                                   |
     -------------------------------------
    Since:
    MicroStrategy Web 9.0.0

    • Constructor Detail

      • TabDocumentTableOfContentsTransform

        public TabDocumentTableOfContentsTransform()
        Deprecated.

    • Method Detail

      • renderContentsBody

        public void renderContentsBody​(MarkupOutput out)
        Deprecated.

        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 renderTOCSection().

        Specified by:
        renderContentsBody in class AbstractTabTransform
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderTOCSection

        public void renderTOCSection​(MarkupOutput out)
        Deprecated.
        Renders the Table of contents section
        Parameters:
        out - MarkupOutput

      • renderTOCTabLeader

        public void renderTOCTabLeader​(MarkupOutput out)
        Deprecated.
        Renders the input for tab leader for the Table of contents
        Parameters:
        out - MarkupOutput

      • renderTOCFont

        public void renderTOCFont​(MarkupOutput out)
        Deprecated.
        Renders the font properties and button for the Table of contents
        Parameters:
        out - MarkupOutput

      • renderTOCTitle

        public void renderTOCTitle​(MarkupOutput out)
        Deprecated.
        Renders the input for title for the Table of contents
        Parameters:
        out - MarkupOutput

      • renderTOCBeforeLayout

        public void renderTOCBeforeLayout​(MarkupOutput out,
                                  RWDefinition rwDef)
        Deprecated.
        Renders the input for before layout for the Table of contents
        Parameters:
        out - MarkupOutput

      • renderEnableTOC

        public void renderEnableTOC​(MarkupOutput out)
        Deprecated.
        Renders the input for enable table of contents
        Parameters:
        out - MarkupOutput

      • initializeCss

        public void initializeCss()
        Deprecated.
        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.
        Overrides:
        initializeCss in class AbstractTabTransform

      • initializeJavaScriptAttributes

        public void initializeJavaScriptAttributes()
        Deprecated.
        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.
        Overrides:
        initializeJavaScriptAttributes in class AbstractTabTransform