public class

PreferencesExportTransform

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

Class Overview

This is the transform that renders the Export Preferences and the Export 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
[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
PreferencesExportTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
WebEvent getExportEvent()
int getExportFormatsCount()
This method is deprecated. not used anymore
WebEvent getExportSavePropertiesEvent()
This method is deprecated. use getSaveReportPropertiesEvent()
String getTitle()
Generates the Header of the Preferences dialog.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
boolean isCellsLimitExceeded()
boolean isNotExcel2000()
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 renderEmbedImages(MarkupOutput out)
Renders checkbox for embedding images
void renderEnableExportPDF(MarkupOutput out)
This method is deprecated. No replacement.
void renderEncodeCSVForExportingToExcel(MarkupOutput out)
Whether to encode the exporting CSV results as ISO8859_1 so they can be read using Excel.
void renderExcelVersion(MarkupOutput out)
Renders option for the Excel version
void renderExpandPageByFields(MarkupOutput out)
Renders checkbox for expanding page by fields.
void renderExportAdminHeaderFooterButton(MarkupOutput out)
Renders link to edit the export admin header and footer.
void renderExportButton(MarkupOutput out)
Generates the submit input and related hidden inputs used to submit the information to export the report.
void renderExportFilterDetails(MarkupOutput out)
Renders checkbox for exporting the filter details.
void renderExportFooterTextArea(MarkupOutput out)
This method is deprecated. we now use display this on a separate page
void renderExportFormatDocuments(MarkupOutput out)
Renders list of radio buttons with the possible export formats for documents.
void renderExportFormatGraphs(MarkupOutput out)
Renders list of radio buttons with the possible export formats for graphs.
void renderExportFormatGrids(MarkupOutput out)
Renders list of radio buttons with the possible export formats for grids.
void renderExportHeaderAsText(MarkupOutput out)
Renders checkboxes for exporting headers and metric values as text.
void renderExportHeaderTextArea(MarkupOutput out)
This method is deprecated. we now use display this on a separate page
void renderExportLimitsMessage(MarkupOutput out)
Renders section that shows the export limits message :'You cannot export this report..'.
void renderExportMetricValuesAsText(MarkupOutput out)
Renders checkboxes for exporting headers and metric values as text.
void renderExportPageByInfo(MarkupOutput out)
Renders checkbox for exporting the filter details.
void renderExportReportTitle(MarkupOutput out)
Renders checkbox for exporting the filter details.
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 renderFormStart(MarkupOutput out, WebEvent event)
Renders the start of the Preference's Form.
void renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.
void renderMaxCells(MarkupOutput out)
Renders textboxes to enter the maximum number of cells to export.
void renderMaxCellsHTML(MarkupOutput out)
Renders textboxes to enter the maximum number of cells to export to HTML.
void renderMaxCellsPlainText(MarkupOutput out)
Renders textboxes to enter the maximum number of cells to export to plaintext.
void renderNewWindow(MarkupOutput out)
This method is deprecated. This preference has been moved to General Preferences
void renderOptions(MarkupOutput out)
Renders checkbox for showing the options page before exporting.
void renderOverlapGridTitles(MarkupOutput out)
Renders checkbox for overlap the grid titles when exporting.
void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void renderReportOfficeRefresh(MarkupOutput out)
Allow MicroStrategy Office to refresh Reports after exporting to Excel
void renderUseLiveChartGraphs(MarkupOutput out)
Renders checkbox for using bitmaps for graphs when exporting.
void renderUseSeparateSheets(MarkupOutput out)
Renders checkbox for using separate sheets when exporting.
void transformBody(MarkupOutput out)
Generates the content for the PreferencesExportTransform 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.
String getUniqueID()
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

Public Constructors

public PreferencesExportTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the textual description of the transform

public WebEvent getExportEvent ()

Returns
  • the event used to export the report.

public int getExportFormatsCount ()

This method is deprecated.
not used anymore

Returns
  • the number of formats available for exporting

public WebEvent getExportSavePropertiesEvent ()

This method is deprecated.
use getSaveReportPropertiesEvent()

Returns
  • the event used to save the corresponding report properties.

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 initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. In particular it initialize the indent field based on the value of the initialIndent formal parameter, and the isDhtml() based on the bean's OutputFormat. It also invokes the initializeImages and initializeCss methods. This method is call from the transform method of the Transform instance.

Parameters
data the bean to transform.

public boolean isCellsLimitExceeded ()

Returns
  • true if the number of rows in the report has exceeded the limit imposed by the administrator's preferences to use when exporting reports.

public boolean isNotExcel2000 ()

Returns
  • true if the version used is not Excel 2000 SR1 (set through preferences).

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.

Parameters
out the markup output object
Throws
UnmodifiableException
UnmodifiableException

public void renderEmbedImages (MarkupOutput out)

Renders checkbox for embedding images

Parameters
out the output object

public void renderEnableExportPDF (MarkupOutput out)

This method is deprecated.
No replacement.

Renders checkbox for enabling export to PDF.

Parameters
out the output object

public void renderEncodeCSVForExportingToExcel (MarkupOutput out)

Whether to encode the exporting CSV results as ISO8859_1 so they can be read using Excel.

Parameters
out the output object

public void renderExcelVersion (MarkupOutput out)

Renders option for the Excel version

Parameters
out the output object

public void renderExpandPageByFields (MarkupOutput out)

Renders checkbox for expanding page by fields.

Parameters
out the output object

public void renderExportAdminHeaderFooterButton (MarkupOutput out)

Renders link to edit the export admin header and footer.

Parameters
out the output object

public void renderExportButton (MarkupOutput out)

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

Parameters
out the markup output object

public void renderExportFilterDetails (MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters
out the output object

public void renderExportFooterTextArea (MarkupOutput out)

This method is deprecated.
we now use display this on a separate page

Renders the text area for Export Footer in the Export tab of the Admin(Project Defaults) Preference page

public void renderExportFormatDocuments (MarkupOutput out)

Renders list of radio buttons with the possible export formats for documents. The export formats are initialized from a configuration file and are passed on exportFormatList.

Parameters
out the output object

public void renderExportFormatGraphs (MarkupOutput out)

Renders list of radio buttons with the possible export formats for graphs. The export formats are initialized from a configuration file and are passed on exportFormatList.

Parameters
out the output object

public void renderExportFormatGrids (MarkupOutput out)

Renders list of radio buttons with the possible export formats for grids. The export formats are initialized from a configuration file and are passed on exportFormatList

Parameters
out the output object

public void renderExportHeaderAsText (MarkupOutput out)

Renders checkboxes for exporting headers and metric values as text.

Parameters
out the output object

public void renderExportHeaderTextArea (MarkupOutput out)

This method is deprecated.
we now use display this on a separate page

Renders the text area for Export Header in the Export tab of the Admin(Project Defaults) Preference page

public void renderExportLimitsMessage (MarkupOutput out)

Renders section that shows the export limits message :'You cannot export this report..'. Used only in the options page.

Parameters
out the output object

public void renderExportMetricValuesAsText (MarkupOutput out)

Renders checkboxes for exporting headers and metric values as text.

Parameters
out the output object

public void renderExportPageByInfo (MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters
out the output object

public void renderExportReportTitle (MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters
out the output object

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 renderFormStart (MarkupOutput out, WebEvent event)

Renders the start of the Preference's Form. This method also renders the hidden inputs associated with the event

Parameters
out the output object
event the WebEvent to render

public void renderJavascript (MarkupOutput out)

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

public void renderMaxCells (MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export. Displayed only on the preferences page on the Project Defaults section.

Parameters
out the output object

public void renderMaxCellsHTML (MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export to HTML. Displayed only on the preferences page on the Project Defaults section.

Parameters
out the output object

public void renderMaxCellsPlainText (MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export to plaintext. Displayed only on the preferences page on the Project Defaults section.

Parameters
out the output object

public void renderNewWindow (MarkupOutput out)

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

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

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

Renders checkbox for overlap the grid titles when exporting.

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
out the Markup output

public void renderReportOfficeRefresh (MarkupOutput out)

Allow MicroStrategy Office to refresh Reports after exporting to Excel

Parameters
out the output object

public void renderUseLiveChartGraphs (MarkupOutput out)

Renders checkbox for using bitmaps for graphs when exporting.

Parameters
out the output object

public void renderUseSeparateSheets (MarkupOutput out)

Renders checkbox for using separate sheets when exporting.

Parameters
out the output object

public void transformBody (MarkupOutput out)

Generates the content for the PreferencesExportTransform Preference's dialog.

Parameters
out the output object

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 String getUniqueID ()

Returns
  • a unique ID used to be appended to the target of the URL generated for exporting

protected void transformFooter (MarkupOutput out)

Generates the footer of the Preferences dialog

Parameters
out the output object