public class

TabDocumentExportTransform

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

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

Summary

Constants
String PROPERTYSET_NAME_FORMATTING_PAGE
String PROPERTYSET_RWDOCUMENT_PROPERTIES
String PROPERTY_DEFAULT_PAGEBY_EXPORT_MODE
String PROPERTY_NAME_EMBED_FONTS
String PROPERTY_NAME_EMBED_IMAGES
String PROPERTY_NAME_INCLUDE_BOOKMARKS
String PROPERTY_NAME_SHOW_BOOKMARKS
String PROPERTY_PROMPT_USER_FOR_PAGEBY_EXPORT
String PROPERTY_USE_BITMAPS_GRAPH
String PROPERTY_USE_DRAFT_QUALITY_GRAPH
[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
TabDocumentExportTransform()
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 renderExcelSection(MarkupOutput out)
Generates the HTML output for the excel section on this tab instance.
static void renderExportSection(MarkupOutput out, TabBean layoutBean, AbstractTabTransform t, RWBean rwb, String cssPrefix, String _tabId)
Generates the HTML output for the export section on this tab instance.
void renderExportSection(MarkupOutput out)
Generates the HTML output for the export section on this tab instance.
void renderGraphFormatSection(MarkupOutput out)
Generates the HTML output for the graph part of the pdf section on this tab instance.
static void renderGraphFormatSection(MarkupOutput out, AbstractTabTransform t, String cssPrefix, String beanName, String useBitmapsGraph, String useDraftQualityGraph)
Generates the HTML output for the graph part of the pdf section on this tab instance.
void renderJavascriptLinks(MarkupOutput out)
Used to dynamically include links to js files.
static void renderPDFSection(MarkupOutput out, AbstractTabTransform t, String cssPrefix, String includeBookmarks, String showBookmarks, String embedFonts, String tabId)
Generates the HTML output for the pdf section on this tab instance.
void renderPDFSection(MarkupOutput out)
Generates the HTML output for the pdf 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 PROPERTYSET_NAME_FORMATTING_PAGE

Constant Value: "FormattingPage"

public static final String PROPERTYSET_RWDOCUMENT_PROPERTIES

Constant Value: "RWDocumentProperties"

public static final String PROPERTY_DEFAULT_PAGEBY_EXPORT_MODE

Constant Value: "DefaultPageByExportMode"

public static final String PROPERTY_NAME_EMBED_FONTS

Constant Value: "EmbedFonts"

public static final String PROPERTY_NAME_EMBED_IMAGES

Constant Value: "ExcelEmbedImages"

public static final String PROPERTY_NAME_INCLUDE_BOOKMARKS

Constant Value: "IncludeBookmarks"

public static final String PROPERTY_NAME_SHOW_BOOKMARKS

Constant Value: "ShowBookmarks"

public static final String PROPERTY_PROMPT_USER_FOR_PAGEBY_EXPORT

Constant Value: "PromptUserForPagebyExport"

public static final String PROPERTY_USE_BITMAPS_GRAPH

Constant Value: "GraphFormat"

public static final String PROPERTY_USE_DRAFT_QUALITY_GRAPH

Constant Value: "GraphQualityDPI"

Public Constructors

public TabDocumentExportTransform ()

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 renderGeneralSection(), renderExportSection().

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

public void renderExcelSection (MarkupOutput out)

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

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

public static void renderExportSection (MarkupOutput out, TabBean layoutBean, AbstractTabTransform t, RWBean rwb, String cssPrefix, String _tabId)

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

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.
layoutBean TabBean being transformed
t AbstractTabTransform to be used for rendering html.
rwb RWBean to use for getting property values.
cssPrefix String the css prefix

public void renderExportSection (MarkupOutput out)

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

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

public void renderGraphFormatSection (MarkupOutput out)

Generates the HTML output for the graph part of the pdf section on this tab instance.

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

public static void renderGraphFormatSection (MarkupOutput out, AbstractTabTransform t, String cssPrefix, String beanName, String useBitmapsGraph, String useDraftQualityGraph)

Generates the HTML output for the graph part of the pdf 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.
useBitmapsGraph String the value of the PROPERTY_USE_BITMAPS_GRAPH property.
useDraftQualityGraph String the value of the PROPERTY_USE_DRAFT_QUALITY_GRAPH 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 static void renderPDFSection (MarkupOutput out, AbstractTabTransform t, String cssPrefix, String includeBookmarks, String showBookmarks, String embedFonts, String tabId)

Generates the HTML output for the pdf 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
includeBookmarks String the value of the PROPERTY_NAME_INCLUDE_BOOKMARKS property.
showBookmarks String the value of the PROPERTY_NAME_SHOW_BOOKMARKS property.
embedFonts String the value of the PROPERTY_NAME_EMBED_FONTS property.
tabId String the name to be used for acessing the client-side bone.

public void renderPDFSection (MarkupOutput out)

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

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