public class

PreferencesPrintTransform

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

Class Overview

This is the transform that renders the Print Preferences and the Print 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 landscapeImage Specifies the image used for the landscape option on the paper orientation print setting.
protected FormalParameter portraitImage Specifies the image used for the portrait option on the paper orientation print setting.
protected FormalParameter printHeaderFooterGroupName Specifies the preferences group name of the print header/footer editor.
[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
PreferencesPrintTransform()
Default empty constructor.
Public Methods
boolean canShowPaperOptions()
Determines if paper orientation and paper size options need to be displayed.
WebEvent getPrintEvent()
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.

boolean isDhtmlPrintingEnabled()
Determines if the DHTML printing is enabled.
void renderAdvancedPrintButton(MarkupOutput out)
Renders button to display the advanced options.
void renderCoverPageFilterDetails(MarkupOutput out)
Renders checkbox for displaying the cover page with filter details.
void renderDefaultColsPerPage(MarkupOutput out)
Renders textboxes for the default columns per page.
void renderDefaultRowsPerPage(MarkupOutput out)
Renders textboxes for the default rows per page.
void renderDisableDHTMLPrinting(MarkupOutput out)
Renders checkbox to disable DHTML printing.
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 renderExpandPageBy(MarkupOutput out)
Renders checkbox to expand pageby fields.
void renderFooterFile(MarkupOutput out)
Renders textboxes for Administrator's header and footer files.
void renderGridColsPerPrintedPage(MarkupOutput out)
Renders textbox for grid columns per page.
void renderGridGraphSamePage(MarkupOutput out)
Render checkbox to display the grid and graph on the same page.
void renderGridRowsPerPrintedPage(MarkupOutput out)
Renders textbox for grid rows per page.
void renderHeaderAndFooter(MarkupOutput out)
This method is deprecated. use renderHeaderAndFooterButton(MarkupOutput, String)
void renderHeaderAndFooterFile(MarkupOutput out)
Renders textboxes for Administrator's header and footer files.
void renderHeaderFile(MarkupOutput out)
Renders textboxes for Administrator's header and footer files.
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 renderMaxAndDefaultColsPerPage(MarkupOutput out)
Renders textboxes for the maximum and default columns per page.
void renderMaxAndDefaultRowsPerPage(MarkupOutput out)
Renders textboxes for the maximum and default rows per page.
void renderMaxCellsAndGraphsPerBlock(MarkupOutput out)
Renders maximum number of cells and graphs per block.
void renderMaxCellsPerBlock(MarkupOutput out)
Renders maximum number of cells and graphs per block.
void renderMaxColsPerPage(MarkupOutput out)
Renders textboxes for the maximum columns per page.
void renderMaxFooterSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderMaxGraphsPerBlock(MarkupOutput out)
Renders maximum number of cells and graphs per block.
void renderMaxHeaderAndFooterSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderMaxHeaderSize(MarkupOutput out)
Renders maximum header and footer textboxes.
void renderMaxRowsPerPage(MarkupOutput out)
Renders textboxes for the maximum rows per page.
void renderOpenNewWindow(MarkupOutput out)
This method is deprecated. This preference has been moved to General Preferences
void renderOptionsWhenPrint(MarkupOutput out)
Renders checkbox for showing the options page before printing.
void renderOrientation(MarkupOutput out)
Renders orientation radio buttons.
void renderPaperSize(MarkupOutput out)
Renders pulldown list with paper sizes.
void renderPopUpPrintDialog(MarkupOutput out)
Renders checkbox for popup print dialog.
void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void renderPrintButton(MarkupOutput out)
Generates the submit input and related hidden inputs used to submit the information and print the report.
void renderScaling(MarkupOutput out)
Renders scaling section.
void transformBody(MarkupOutput out)
Generates the content for the Print 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 landscapeImage

Specifies the image used for the landscape option on the paper orientation print 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 print 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 printHeaderFooterGroupName

Specifies the preferences group name of the print 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.

Public Constructors

public PreferencesPrintTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public boolean canShowPaperOptions ()

Determines if paper orientation and paper size options need to be displayed.

Returns
  • true is in DHTML mode or if displaying advanced options.

public WebEvent getPrintEvent ()

This method is deprecated.
use getSaveReportPropertiesEvent()

Returns the event used to show the printable version of the report.

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 boolean isDhtmlPrintingEnabled ()

Determines if the DHTML printing is enabled.

Returns
  • true if the preference is on, if DHTML is on and not using Netscape.

public void renderAdvancedPrintButton (MarkupOutput out)

Renders button to display the advanced options. Displayed only on the options page.

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

Renders textboxes for the default columns per page.

Parameters
out the output object

public void renderDefaultRowsPerPage (MarkupOutput out)

Renders textboxes for the default rows per page.

Parameters
out the output object

public void renderDisableDHTMLPrinting (MarkupOutput out)

Renders checkbox to disable DHTML printing.

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

Renders checkbox to expand pageby fields.

Parameters
out the output object

public void renderFooterFile (MarkupOutput out)

Renders textboxes for Administrator's header and footer files.

Parameters
out the output object

public void renderGridColsPerPrintedPage (MarkupOutput out)

Renders textbox for grid columns per page.

Parameters
out the output object

public void renderGridGraphSamePage (MarkupOutput out)

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

Parameters
out the output object

public void renderGridRowsPerPrintedPage (MarkupOutput out)

Renders textbox for grid rows per 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 renderHeaderAndFooterFile (MarkupOutput out)

Renders textboxes for Administrator's header and footer files.

Parameters
out the output object

public void renderHeaderFile (MarkupOutput out)

Renders textboxes for Administrator's header and footer files.

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

Renders textboxes for the maximum and default columns per page.

Parameters
out the output object

public void renderMaxAndDefaultRowsPerPage (MarkupOutput out)

Renders textboxes for the maximum and default rows per page.

Parameters
out the output object

public void renderMaxCellsAndGraphsPerBlock (MarkupOutput out)

Renders maximum number of cells and graphs per block.

Parameters
out the output object

public void renderMaxCellsPerBlock (MarkupOutput out)

Renders maximum number of cells and graphs per block.

Parameters
out the output object

public void renderMaxColsPerPage (MarkupOutput out)

Renders textboxes for the maximum columns per page.

Parameters
out the output object

public void renderMaxFooterSize (MarkupOutput out)

Renders maximum header and footer textboxes.

Parameters
out the output object

public void renderMaxGraphsPerBlock (MarkupOutput out)

Renders maximum number of cells and graphs per block.

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

Renders textboxes for the maximum rows per page.

Parameters
out the output object

public void renderOpenNewWindow (MarkupOutput out)

This method is deprecated.
This preference has been moved to General Preferences

Renders checkbox for opening a new window when printing. Displayed only in the preferences page.

Parameters
out the output object

public void renderOptionsWhenPrint (MarkupOutput out)

Renders checkbox for showing the options page before printing.

Parameters
out the output object

public void renderOrientation (MarkupOutput out)

Renders orientation radio buttons.

Parameters
out the output object

public void renderPaperSize (MarkupOutput out)

Renders pulldown list with paper sizes.

Parameters
out the output object

public void renderPopUpPrintDialog (MarkupOutput out)

Renders checkbox for popup print dialog.

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

Generates the submit input and related hidden inputs used to submit the information and print the report.

public void renderScaling (MarkupOutput out)

Renders scaling section.

Parameters
out the output object

public void transformBody (MarkupOutput out)

Generates the content for the Print 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. Over ride the method in AbstractPreferenceTransform

Parameters
out where to create the output