public class

PreferencesPDFTransform

extends AbstractOptionsTransform
implements EnumWebPreferences
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPreferencesTransform
           ↳ com.microstrategy.web.app.transforms.PreferencesGenericTransform
             ↳ com.microstrategy.web.app.transforms.AbstractOptionsTransform
               ↳ com.microstrategy.web.app.transforms.PreferencesPDFTransform

Class Overview

This is the transform that renders the PDF Preferences and the PDF Options page.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
Fields
protected FormalParameter PDFHeaderFooterGroupName Specifies the preferences group name of the PDF header/footer editor.
protected FormalParameter landscapeImage Specifies the image used for the landscape option on the paper orientation PDF setting.
protected FormalParameter portraitImage Specifies the image used for the portrait option on the paper orientation PDF setting.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
Public Constructors
PreferencesPDFTransform()
Default empty constructor.
Public Methods
WebEvent getPDFSavePropertiesEvent()
This method is deprecated. use getSaveReportPropertiesEvent()
String getTitle()
Generates the Header of the Preferences dialog.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderAdvancedPDFButton(MarkupOutput out)
Renders button for advanced options section.
void renderCoverPageDetailsContents(MarkupOutput out)
Renders the cover page contents options (With Filter Details, With Report Details)
void renderCoverPageFilterDetails(MarkupOutput out)
Renders checkbox for displaying the cover page with filter details.
void renderCoverPageLocation(MarkupOutput out)
Renders the cover page location options (Before report, After report)
void renderDoNotPrompt(MarkupOutput out)
Generates a checkbox to allow the user to save the "do not prompt me again" preferences in the options page.
void renderEmbedFonts(MarkupOutput out)
Renders Embed Fonts option
void renderExpandPageBy(MarkupOutput out)
Renders Expand Page by option
void renderExportButton(MarkupOutput out)
Generates the submit input and related hidden inputs used to submit the information to display the report in PDF.
void renderExportSection(MarkupOutput out)
Renders pulldown list for selecting whether to export the 'whole report' or the 'portion displayed'.
void renderFormEnd(MarkupOutput out, WebEvent event)
Renders the Form end tag
void renderGridGraphSamePage(MarkupOutput out)
Render checkbox to display the grid and graph on the same page.
void renderHeaderAndFooter(MarkupOutput out)
This method is deprecated. use renderHeaderAndFooterButton(MarkupOutput, String)
void renderMargin(MarkupOutput out)
Renders textboxes for the margins.
void renderMarginBottom(MarkupOutput out)
Renders textboxes for the margins.
void renderMarginLeft(MarkupOutput out)
Renders textboxes for the margins.
void renderMarginRight(MarkupOutput out)
Renders textboxes for the margins.
void renderMarginTitle(MarkupOutput out)
Renders the title for the margin options.
void renderMarginTop(MarkupOutput out)
Renders textboxes for the margins.
void renderMaxCells(MarkupOutput out)
This method is deprecated. this preference is not used anymore
void renderMaxFooterSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderMaxHeaderAndFooterSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderMaxHeaderSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderOptions(MarkupOutput out)
Renders checkbox for showing the options page before exporting.
void renderOrientation(MarkupOutput out)
Renders orientation radio buttons.
void renderPDFReportHeaderButton(MarkupOutput out)
Renders link to edit the report header.
void renderPaperSize(MarkupOutput out)
Renders pulldown list with paper sizes.
void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void renderProjectHeaderAndFooter(MarkupOutput out)
Renders link to edit the project header and footer.
void renderScaling(MarkupOutput out)
Renders scaling section.
void renderUseBMPGraphs(MarkupOutput out)
Renders Use BMP Graphs option
void transformBody(MarkupOutput out)
Generates the content for the PDF Preference's dialog.
Protected Methods
String getActionType()
String getExportEventID()
Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print)
This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.
void renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.
void transformFooter(MarkupOutput out)
Generates the footer of the Preferences dialog
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractOptionsTransform
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
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

Fields

protected FormalParameter PDFHeaderFooterGroupName

Specifies the preferences group name of the PDF header/footer editor. Used to create the link to the Header/Footer editor.
Allowed Values:
The available preferences groups are specified in the preferencesGroups file.
Usage:
Changing this value will make the link to the Header/Footer editor point to another preferences group.

protected FormalParameter landscapeImage

Specifies the image used for the landscape option on the paper orientation PDF setting.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter portraitImage

Specifies the image used for the portrait option on the paper orientation PDF setting.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Public Constructors

public PreferencesPDFTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public WebEvent getPDFSavePropertiesEvent ()

This method is deprecated.
use getSaveReportPropertiesEvent()

Returns the event used to display the PDF version of the report/document.

public String getTitle ()

Generates the Header of the Preferences dialog. Over ride the method in AbstractPreferenceTransform

Returns
  • the Header of the Preferences dialog.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderAdvancedPDFButton (MarkupOutput out)

Renders button for advanced options section. Displayed only in the options page in DHTML mode.

Parameters
out the output object

public void renderCoverPageDetailsContents (MarkupOutput out)

Renders the cover page contents options (With Filter Details, With Report Details)

Parameters
out the output object

public void renderCoverPageFilterDetails (MarkupOutput out)

Renders checkbox for displaying the cover page with filter details.

Parameters
out the output object

public void renderCoverPageLocation (MarkupOutput out)

Renders the cover page location options (Before report, After report)

Parameters
out the output object

public void renderDoNotPrompt (MarkupOutput out)

Generates a checkbox to allow the user to save the "do not prompt me again" preferences in the options page.

public void renderEmbedFonts (MarkupOutput out)

Renders Embed Fonts option

Parameters
out MarkupOutput

public void renderExpandPageBy (MarkupOutput out)

Renders Expand Page by option

Parameters
out MarkupOutput

public void renderExportButton (MarkupOutput out)

Generates the submit input and related hidden inputs used to submit the information to display the report in PDF.

public void renderExportSection (MarkupOutput out)

Renders pulldown list for selecting whether to export the 'whole report' or the 'portion displayed'.

Parameters
out the output object

public void renderFormEnd (MarkupOutput out, WebEvent event)

Renders the Form end tag

Parameters
out where to write the output of the method.

public void renderGridGraphSamePage (MarkupOutput out)

Render checkbox to display the grid and graph on the same page.

Parameters
out the output object

public void renderHeaderAndFooter (MarkupOutput out)

This method is deprecated.
use renderHeaderAndFooterButton(MarkupOutput, String)

Renders link to edit custom header and footer.

Parameters
out the output object

public void renderMargin (MarkupOutput out)

Renders textboxes for the margins.

Parameters
out the output object

public void renderMarginBottom (MarkupOutput out)

Renders textboxes for the margins.

Parameters
out the output object

public void renderMarginLeft (MarkupOutput out)

Renders textboxes for the margins.

Parameters
out the output object

public void renderMarginRight (MarkupOutput out)

Renders textboxes for the margins.

Parameters
out the output object

public void renderMarginTitle (MarkupOutput out)

Renders the title for the margin options.

public void renderMarginTop (MarkupOutput out)

Renders textboxes for the margins.

Parameters
out the output object

public void renderMaxCells (MarkupOutput out)

This method is deprecated.
this preference is not used anymore

Renders textbox for maximum number of cells to export.

Parameters
out the output object

public void renderMaxFooterSize (MarkupOutput out)

Renders maximum header and footer textboxes.

Parameters
out the output object

public void renderMaxHeaderAndFooterSize (MarkupOutput out)

Renders maximum header and footer textboxes.

Parameters
out the output object

public void renderMaxHeaderSize (MarkupOutput out)

Renders maximum header and footer textboxes.

Parameters
out the output object

public void renderOptions (MarkupOutput out)

Renders checkbox for showing the options page before exporting.

Parameters
out the output object

public void renderOrientation (MarkupOutput out)

Renders orientation radio buttons.

Parameters
out the output object

public void renderPDFReportHeaderButton (MarkupOutput out)

Renders link to edit the report header.

Parameters
out the output object

public void renderPaperSize (MarkupOutput out)

Renders pulldown list with paper sizes.

Parameters
out the output object

public void renderPreference (String preferenceName, MarkupOutput out)

This method is deprecated.
Call the corresponding renderXXX method directly.

Render individual preferences based on the name provided

Parameters
preferenceName name id of the preference

public void renderProjectHeaderAndFooter (MarkupOutput out)

Renders link to edit the project header and footer.

Parameters
out the output object

public void renderScaling (MarkupOutput out)

Renders scaling section.

Parameters
out the output object

public void renderUseBMPGraphs (MarkupOutput out)

Renders Use BMP Graphs option

Parameters
out MarkupOutput

public void transformBody (MarkupOutput out)

Generates the content for the PDF Preference's dialog.

Parameters
out the body content

Protected Methods

protected String getActionType ()

Returns

protected String getExportEventID ()

Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print)
This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.

Returns
  • The ID of the final event used when this transform is used for the Options Page (examples are Export, PDF and Print)

protected void renderJavascript (MarkupOutput out)

This method is called to generate all javascript functions related to this transform.

protected void transformFooter (MarkupOutput out)

Generates the footer of the Preferences dialog

Parameters
out the output object