public interface

PDFBean

implements AppComponent
com.microstrategy.web.app.beans.PDFBean

Class Overview

The interface PDFBean is representing the pdf web component.

Summary

Constants
String COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS
String COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS
String COVER_PAGE_LOCATION_AFTER_REPORT
String COVER_PAGE_LOCATION_BEFORE_REPORT
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract AppBeanError getBeanError()
Get PDF bean error
abstract boolean getDisplayCoverPage()
Return whether to display a cover page with the filter details.
abstract boolean getExpandPageByFields()
Returns whether to expand the page-by fields
abstract int getExportSection()
Returns the export section of the export bean (a value from EnumExportSection)
abstract String getFitToPagesTall()
Gets the current fit to pages tall property
abstract String getFitToPagesWide()
Gets the current fit to pages wide property
abstract String getFooterCenterSection()
Returns the current footer center section content
abstract String getFooterLeftSection()
Returns the current footer left section content
abstract String getFooterRightSection()
Returns the current footer right section content
abstract String getFooterSize()
Returns the current footer size in inches
abstract String getGraphHeight()
Returns the graph's height
abstract String getGraphWidth()
Returns the graph's width
abstract String getHeaderCenterSection()
Returns the current header center section content
abstract String getHeaderLeftSection()
Returns the current header left section content
abstract String getHeaderRightSection()
Returns the current header right section content
abstract String getHeaderSize()
Returns the current header size in inches
abstract String getMarginSizeBottom()
Returns the current bottom margin size in inches
abstract String getMarginSizeLeft()
returns the current left margin size in inches
abstract String getMarginSizeRight()
Returns the current right margin size in inches
abstract String getMarginSizeTop()
Returns the current top margin size in inches
abstract String getMaxCells()
This method is deprecated. not used anymore
abstract String getOutlineModeState()
Returns the current outline mode expansion state
abstract String getPaperHeight()
Returns the paper height depending on the paper size an paper orientation
abstract String getPaperOrientationOption()
Returns the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
abstract String getPaperSize()
Returns the current paper size (a key from paperSizes.xml)
abstract String getPaperWidth()
Returns the paper width
abstract ReportBean getReportBean()
abstract String getScalingOption()
Gets the scaling option the user has decided to use
abstract boolean getShowAttributeFormNames()
Returns whether to show the attribute forms
abstract String getShrinkFontPercentage()
Returns the current shrink font percentage.
abstract String getStylePagebyInfo()
Returns the current style used when transforming the report bean to generate the page by information
abstract void setDisplayCoverPage(boolean displayCoverPage)
Sets whether to display a cover page with the filter details.
abstract void setExpandPageByFields(boolean expandPageByFields)
Sets whether to expand the page-by fields
abstract void setExportSection(int exportSection)
Sets the export section of the export bean (a value from EnumExportSection)
abstract void setFitToPagesTall(String fitToPagesTall)
Sets the current fit to pages tall property
abstract void setFitToPagesWide(String fitToPagesWide)
Sets the current fit to pages wide property
abstract void setFooterCenterSection(String footerCenterSection)
Sets the current footer center section content
abstract void setFooterLeftSection(String footerLeftSection)
Sets the current footer left section content
abstract void setFooterRightSection(String footerRightSection)
Sets the current footer right section content
abstract void setFooterSize(String footerSize)
Sets the current footer size in inches
abstract void setGraphHeight(String graphHeight)
Sets the graph's height
abstract void setGraphWidth(String graphWidth)
Sets the graph's width
abstract void setHeaderCenterSection(String headerCenterSection)
Sets the current header center section content
abstract void setHeaderLeftSection(String headerLeftSection)
Sets the current header left section content
abstract void setHeaderRightSection(String headerRightSection)
Sets the current header right section content
abstract void setHeaderSize(String headerSize)
Sets the current header size in inches
abstract void setMarginSizeBottom(String marginSizeBottom)
Sets the current bottom margin size in inches
abstract void setMarginSizeLeft(String marginSizeLeft)
Sets the current left margin size in inches
abstract void setMarginSizeRight(String marginSizeRight)
Sets the current right margin size in inches
abstract void setMarginSizeTop(String marginSizeTop)
Sets the current top margin size in inches
abstract void setMaxCells(String maxCells)
This method is deprecated. not used anymore
abstract void setOutlineModeState(String outlineModeState)
Sets the current outline mode expansion state
abstract void setPaperOrientationOption(String paperOrientationOption)
Sets the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
abstract void setPaperSize(String paperSize)
Sets the current paper size (a key from paperSizes.xml)
abstract void setScalingOption(String scalingOption)
Sets the scaling option the user has decided to use
abstract void setShowAttributeFormNames(boolean showAttributeFormNames)
Sets whether to show the attribute forms
abstract void setShrinkFontPercentage(String shrinkFontPercentage)
Sets the current shrink font percentage.
abstract void setStylePagebyInfo(String stylePagebyInfo)
Sets the current style used when transforming the report bean to generate the page by information
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final String COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS

Constant Value: "0"

public static final String COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS

Constant Value: "1"

public static final String COVER_PAGE_LOCATION_AFTER_REPORT

Constant Value: "1"

public static final String COVER_PAGE_LOCATION_BEFORE_REPORT

Constant Value: "0"

Public Methods

public abstract AppBeanError getBeanError ()

Get PDF bean error

Returns
  • bean error

public abstract boolean getDisplayCoverPage ()

Return whether to display a cover page with the filter details.

Returns
  • whether to display a cover page with the filter details.

public abstract boolean getExpandPageByFields ()

Returns whether to expand the page-by fields

Returns
  • whether to expand the page-by fields

public abstract int getExportSection ()

Returns the export section of the export bean (a value from EnumExportSection)

Returns
  • the export section of the export bean (a value from EnumExportSection)

public abstract String getFitToPagesTall ()

Gets the current fit to pages tall property

Returns
  • the current fit to pages tall property

public abstract String getFitToPagesWide ()

Gets the current fit to pages wide property

Returns
  • the current fit to pages wide property

public abstract String getFooterCenterSection ()

Returns the current footer center section content

Returns
  • the current footer center section

public abstract String getFooterLeftSection ()

Returns the current footer left section content

Returns
  • the current footer left section

public abstract String getFooterRightSection ()

Returns the current footer right section content

Returns
  • the current footer right section

public abstract String getFooterSize ()

Returns the current footer size in inches

Returns
  • the current footer size

public abstract String getGraphHeight ()

Returns the graph's height

Returns
  • the graph's height

public abstract String getGraphWidth ()

Returns the graph's width

Returns
  • the graph's width

public abstract String getHeaderCenterSection ()

Returns the current header center section content

Returns
  • the current header center section

public abstract String getHeaderLeftSection ()

Returns the current header left section content

Returns
  • the current header left section

public abstract String getHeaderRightSection ()

Returns the current header right section content

Returns
  • the current header right section

public abstract String getHeaderSize ()

Returns the current header size in inches

Returns
  • the current header size

public abstract String getMarginSizeBottom ()

Returns the current bottom margin size in inches

Returns
  • the current bottom margin size

public abstract String getMarginSizeLeft ()

returns the current left margin size in inches

Returns
  • the current left margin size

public abstract String getMarginSizeRight ()

Returns the current right margin size in inches

Returns
  • the current right margin size

public abstract String getMarginSizeTop ()

Returns the current top margin size in inches

Returns
  • the current top margin size

public abstract String getMaxCells ()

This method is deprecated.
not used anymore

Returns the maximum number of cells to export

Returns
  • the maximum number of cells to export

public abstract String getOutlineModeState ()

Returns the current outline mode expansion state

Returns
  • the current outline mode expansion state

public abstract String getPaperHeight ()

Returns the paper height depending on the paper size an paper orientation

Returns
  • the paper height depending on the paper size an paper orientation

public abstract String getPaperOrientationOption ()

Returns the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)

Returns
  • the current paper orientation

public abstract String getPaperSize ()

Returns the current paper size (a key from paperSizes.xml)

Returns
  • the current paper size

public abstract String getPaperWidth ()

Returns the paper width

Returns
  • the paper width

public abstract ReportBean getReportBean ()

Returns
  • the report bean associated with this pdf bean

public abstract String getScalingOption ()

Gets the scaling option the user has decided to use

Returns

public abstract boolean getShowAttributeFormNames ()

Returns whether to show the attribute forms

Returns
  • whether to show the attribute forms

public abstract String getShrinkFontPercentage ()

Returns the current shrink font percentage.

Returns
  • the current shrink font percentage.

public abstract String getStylePagebyInfo ()

Returns the current style used when transforming the report bean to generate the page by information

Returns
  • the current style used when transforming the report bean to generate the page by information

public abstract void setDisplayCoverPage (boolean displayCoverPage)

Sets whether to display a cover page with the filter details.

Parameters
displayCoverPage whether to display a cover page with the filter details.

public abstract void setExpandPageByFields (boolean expandPageByFields)

Sets whether to expand the page-by fields

Parameters
expandPageByFields whether to expand the page-by fields

public abstract void setExportSection (int exportSection)

Sets the export section of the export bean (a value from EnumExportSection)

Parameters
exportSection the export section of the export bean (a value from EnumExportSection)

public abstract void setFitToPagesTall (String fitToPagesTall)

Sets the current fit to pages tall property

Parameters
fitToPagesTall the current fit to pages tall property

public abstract void setFitToPagesWide (String fitToPagesWide)

Sets the current fit to pages wide property

Parameters
fitToPagesWide the current fit to pages wide property

public abstract void setFooterCenterSection (String footerCenterSection)

Sets the current footer center section content

Parameters
footerCenterSection the current footer center section

public abstract void setFooterLeftSection (String footerLeftSection)

Sets the current footer left section content

Parameters
footerLeftSection the current footer left section

public abstract void setFooterRightSection (String footerRightSection)

Sets the current footer right section content

Parameters
footerRightSection the current footer right section

public abstract void setFooterSize (String footerSize)

Sets the current footer size in inches

Parameters
footerSize the current footer size

public abstract void setGraphHeight (String graphHeight)

Sets the graph's height

Parameters
graphHeight the graph's height

public abstract void setGraphWidth (String graphWidth)

Sets the graph's width

Parameters
graphWidth the graph's width

public abstract void setHeaderCenterSection (String headerCenterSection)

Sets the current header center section content

Parameters
headerCenterSection the current header center section

public abstract void setHeaderLeftSection (String headerLeftSection)

Sets the current header left section content

Parameters
headerLeftSection the current header left section

public abstract void setHeaderRightSection (String headerRightSection)

Sets the current header right section content

Parameters
headerRightSection the current header right section

public abstract void setHeaderSize (String headerSize)

Sets the current header size in inches

Parameters
headerSize the current header size

public abstract void setMarginSizeBottom (String marginSizeBottom)

Sets the current bottom margin size in inches

Parameters
marginSizeBottom the current bottom margin size

public abstract void setMarginSizeLeft (String marginSizeLeft)

Sets the current left margin size in inches

Parameters
marginSizeLeft the current left margin size

public abstract void setMarginSizeRight (String marginSizeRight)

Sets the current right margin size in inches

Parameters
marginSizeRight the current right margin size

public abstract void setMarginSizeTop (String marginSizeTop)

Sets the current top margin size in inches

Parameters
marginSizeTop the current top margin size

public abstract void setMaxCells (String maxCells)

This method is deprecated.
not used anymore

Sets the maximum number of cells to export

Parameters
maxCells the maximum number of cells to export

public abstract void setOutlineModeState (String outlineModeState)

Sets the current outline mode expansion state

Parameters
outlineModeState the current outline mode expansion state

public abstract void setPaperOrientationOption (String paperOrientationOption)

Sets the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)

Parameters
paperOrientationOption the current paper orientation

public abstract void setPaperSize (String paperSize)

Sets the current paper size (a key from paperSizes.xml)

Parameters
paperSize the current paper size

public abstract void setScalingOption (String scalingOption)

Sets the scaling option the user has decided to use

Parameters
scalingOption a string value corresponding to SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION

public abstract void setShowAttributeFormNames (boolean showAttributeFormNames)

Sets whether to show the attribute forms

Parameters
showAttributeFormNames whether to show the attribute forms

public abstract void setShrinkFontPercentage (String shrinkFontPercentage)

Sets the current shrink font percentage.

Parameters
shrinkFontPercentage the current shrink font percentage

public abstract void setStylePagebyInfo (String stylePagebyInfo)

Sets the current style used when transforming the report bean to generate the page by information

Parameters
stylePagebyInfo the current style used when transforming the report bean to generate the page by information