public class

TabDocumentWatermarkTransform

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

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 watermark 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
     -------------------------------------
     |                                   |
     |  Watermark 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
TabDocumentWatermarkTransform()
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 renderImageWatermark(MarkupOutput out)
void renderImageWatermarkContent(MarkupOutput out)
void renderNoWatermark(MarkupOutput out)
void renderOrientationOptions(MarkupOutput out)
void renderTextInputBox(MarkupOutput out)
void renderTextWatermark(MarkupOutput out)
void renderTextWatermarkOptions(MarkupOutput out)
void renderUseProjectWatermark(MarkupOutput out)
void renderWatermarkSection(MarkupOutput out)
Renders the watermark section
[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 TabDocumentWatermarkTransform ()

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

public void renderImageWatermarkContent (MarkupOutput out)

public void renderNoWatermark (MarkupOutput out)

public void renderOrientationOptions (MarkupOutput out)

public void renderTextInputBox (MarkupOutput out)

public void renderTextWatermark (MarkupOutput out)

public void renderTextWatermarkOptions (MarkupOutput out)

public void renderUseProjectWatermark (MarkupOutput out)

public void renderWatermarkSection (MarkupOutput out)

Renders the watermark section

Parameters
out MarkupOutput