public class

ExportOptionsEditorTransform

extends AbstractEditorTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.ExportOptionsEditorTransform

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.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public static final String PROPERTY_EXPORT_RANGE_ALL
public static final String PROPERTY_EXPORT_RANGE_CURRENT
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ExportOptionsEditorTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderEditorContents(MarkupOutput out)
Generates the output for the Export Options Editor Bean
Protected Methods
String getBeanPath()
Returns the path within the application of the WebBean being transformed.
String getScriptClass()

Returns the name of the javaScript class (if any) to be associated with the component.

void initHelp(Editor editor)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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.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"

Fields

public static final String PROPERTY_EXPORT_RANGE_ALL

public static final String PROPERTY_EXPORT_RANGE_CURRENT

Public Constructors

public ExportOptionsEditorTransform ()

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 abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public void renderEditorContents (MarkupOutput out)

Generates the output for the Export Options Editor Bean

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected String getBeanPath ()

Returns the path within the application of the WebBean being transformed.
When submitting an WebEvent, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by the renderRegisterBone method to inform the javascript bone the bean to whom it should send its server-side requests.

Returns
  • String

protected String getScriptClass ()

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Returns
  • String representing the name of a javaScript class

protected void initHelp (Editor editor)