public class

TabDocumentTableOfContentsTransform

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

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

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

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

void renderEnableTOC(MarkupOutput out)
Renders the input for enable table of contents
void renderJavascriptLinks(MarkupOutput out)
Used to dynamically include links to js files.
void renderTOCBeforeLayout(MarkupOutput out, RWDefinition rwDef)
Renders the input for before layout for the Table of contents
void renderTOCFont(MarkupOutput out)
Renders the font properties and button for the Table of contents
void renderTOCSection(MarkupOutput out)
Renders the Table of contents section
void renderTOCTabLeader(MarkupOutput out)
Renders the input for tab leader for the Table of contents
void renderTOCTitle(MarkupOutput out)
Renders the input for title for the Table of contents
[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 TabDocumentTableOfContentsTransform ()

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

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

public void renderEnableTOC (MarkupOutput out)

Renders the input for enable table of contents

Parameters
out MarkupOutput

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 renderTOCBeforeLayout (MarkupOutput out, RWDefinition rwDef)

Renders the input for before layout for the Table of contents

Parameters
out MarkupOutput

public void renderTOCFont (MarkupOutput out)

Renders the font properties and button for the Table of contents

Parameters
out MarkupOutput

public void renderTOCSection (MarkupOutput out)

Renders the Table of contents section

Parameters
out MarkupOutput

public void renderTOCTabLeader (MarkupOutput out)

Renders the input for tab leader for the Table of contents

Parameters
out MarkupOutput

public void renderTOCTitle (MarkupOutput out)

Renders the input for title for the Table of contents

Parameters
out MarkupOutput