All Superinterfaces:

AppComponent, Transformable, WebComponent
```
public interface PDFBean
extends AppComponent
```
The interface PDFBean is representing the pdf web component.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS`
`static java.lang.String`	`COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS`
`static java.lang.String`	`COVER_PAGE_LOCATION_AFTER_REPORT`
`static java.lang.String`	`COVER_PAGE_LOCATION_BEFORE_REPORT`

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

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

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

- Field Detail
  - COVER_PAGE_LOCATION_BEFORE_REPORT
```
static final java.lang.String COVER_PAGE_LOCATION_BEFORE_REPORT
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - COVER_PAGE_LOCATION_AFTER_REPORT
```
static final java.lang.String COVER_PAGE_LOCATION_AFTER_REPORT
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS
```
static final java.lang.String COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS
```
static final java.lang.String COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getReportBean
```
ReportBean getReportBean()
```
    Returns:
    
    the report bean associated with this pdf bean
  - getExportSection
```
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)
  - setExportSection
```
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)
  - getShrinkFontPercentage
```
java.lang.String getShrinkFontPercentage()
```
    Returns the current shrink font percentage.
    
    Returns:
    
    the current shrink font percentage.
  - setShrinkFontPercentage
```
void setShrinkFontPercentage(java.lang.String shrinkFontPercentage)
```
    Sets the current shrink font percentage.
    
    Parameters:
    
    shrinkFontPercentage - the current shrink font percentage
  - getFitToPagesWide
```
java.lang.String getFitToPagesWide()
```
    Gets the current fit to pages wide property
    
    Returns:
    
    the current fit to pages wide property
  - setFitToPagesWide
```
void setFitToPagesWide(java.lang.String fitToPagesWide)
```
    Sets the current fit to pages wide property
    
    Parameters:
    
    fitToPagesWide - the current fit to pages wide property
  - getFitToPagesTall
```
java.lang.String getFitToPagesTall()
```
    Gets the current fit to pages tall property
    
    Returns:
    
    the current fit to pages tall property
  - setFitToPagesTall
```
void setFitToPagesTall(java.lang.String fitToPagesTall)
```
    Sets the current fit to pages tall property
    
    Parameters:
    
    fitToPagesTall - the current fit to pages tall property
  - getScalingOption
```
java.lang.String getScalingOption()
```
    Gets the scaling option the user has decided to use
    
    Returns:
    
    a string value corresponding to PrintBean.SCALING_SHRINK_FONT_OPTION or PrintBean.SCALING_FIT_TO_PAGE_OPTION
  - setScalingOption
```
void setScalingOption(java.lang.String scalingOption)
```
    Sets the scaling option the user has decided to use
    
    Parameters:
    
    scalingOption - a string value corresponding to PrintBean.SCALING_SHRINK_FONT_OPTION or PrintBean.SCALING_FIT_TO_PAGE_OPTION
  - getHeaderLeftSection
```
java.lang.String getHeaderLeftSection()
```
    Returns the current header left section content
    
    Returns:
    
    the current header left section
  - setHeaderLeftSection
```
void setHeaderLeftSection(java.lang.String headerLeftSection)
```
    Sets the current header left section content
    
    Parameters:
    
    headerLeftSection - the current header left section
  - getHeaderCenterSection
```
java.lang.String getHeaderCenterSection()
```
    Returns the current header center section content
    
    Returns:
    
    the current header center section
  - setHeaderCenterSection
```
void setHeaderCenterSection(java.lang.String headerCenterSection)
```
    Sets the current header center section content
    
    Parameters:
    
    headerCenterSection - the current header center section
  - getHeaderRightSection
```
java.lang.String getHeaderRightSection()
```
    Returns the current header right section content
    
    Returns:
    
    the current header right section
  - setHeaderRightSection
```
void setHeaderRightSection(java.lang.String headerRightSection)
```
    Sets the current header right section content
    
    Parameters:
    
    headerRightSection - the current header right section
  - getFooterLeftSection
```
java.lang.String getFooterLeftSection()
```
    Returns the current footer left section content
    
    Returns:
    
    the current footer left section
  - setFooterLeftSection
```
void setFooterLeftSection(java.lang.String footerLeftSection)
```
    Sets the current footer left section content
    
    Parameters:
    
    footerLeftSection - the current footer left section
  - getFooterCenterSection
```
java.lang.String getFooterCenterSection()
```
    Returns the current footer center section content
    
    Returns:
    
    the current footer center section
  - setFooterCenterSection
```
void setFooterCenterSection(java.lang.String footerCenterSection)
```
    Sets the current footer center section content
    
    Parameters:
    
    footerCenterSection - the current footer center section
  - getFooterRightSection
```
java.lang.String getFooterRightSection()
```
    Returns the current footer right section content
    
    Returns:
    
    the current footer right section
  - setFooterRightSection
```
void setFooterRightSection(java.lang.String footerRightSection)
```
    Sets the current footer right section content
    
    Parameters:
    
    footerRightSection - the current footer right section
  - getPaperSize
```
java.lang.String getPaperSize()
```
    Returns the current paper size (a key from paperSizes.xml)
    
    Returns:
    
    the current paper size
  - setPaperSize
```
void setPaperSize(java.lang.String paperSize)
```
    Sets the current paper size (a key from paperSizes.xml)
    
    Parameters:
    
    paperSize - the current paper size
  - getPaperOrientationOption
```
java.lang.String getPaperOrientationOption()
```
    Returns the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
    
    Returns:
    
    the current paper orientation
  - setPaperOrientationOption
```
void setPaperOrientationOption(java.lang.String paperOrientationOption)
```
    Sets the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
    
    Parameters:
    
    paperOrientationOption - the current paper orientation
  - getMarginSizeLeft
```
java.lang.String getMarginSizeLeft()
```
    returns the current left margin size in inches
    
    Returns:
    
    the current left margin size
  - setMarginSizeLeft
```
void setMarginSizeLeft(java.lang.String marginSizeLeft)
```
    Sets the current left margin size in inches
    
    Parameters:
    
    marginSizeLeft - the current left margin size
  - getMarginSizeRight
```
java.lang.String getMarginSizeRight()
```
    Returns the current right margin size in inches
    
    Returns:
    
    the current right margin size
  - setMarginSizeRight
```
void setMarginSizeRight(java.lang.String marginSizeRight)
```
    Sets the current right margin size in inches
    
    Parameters:
    
    marginSizeRight - the current right margin size
  - getMarginSizeTop
```
java.lang.String getMarginSizeTop()
```
    Returns the current top margin size in inches
    
    Returns:
    
    the current top margin size
  - setMarginSizeTop
```
void setMarginSizeTop(java.lang.String marginSizeTop)
```
    Sets the current top margin size in inches
    
    Parameters:
    
    marginSizeTop - the current top margin size
  - getMarginSizeBottom
```
java.lang.String getMarginSizeBottom()
```
    Returns the current bottom margin size in inches
    
    Returns:
    
    the current bottom margin size
  - setMarginSizeBottom
```
void setMarginSizeBottom(java.lang.String marginSizeBottom)
```
    Sets the current bottom margin size in inches
    
    Parameters:
    
    marginSizeBottom - the current bottom margin size
  - getHeaderSize
```
java.lang.String getHeaderSize()
```
    Returns the current header size in inches
    
    Returns:
    
    the current header size
  - setHeaderSize
```
void setHeaderSize(java.lang.String headerSize)
```
    Sets the current header size in inches
    
    Parameters:
    
    headerSize - the current header size
  - getFooterSize
```
java.lang.String getFooterSize()
```
    Returns the current footer size in inches
    
    Returns:
    
    the current footer size
  - setFooterSize
```
void setFooterSize(java.lang.String footerSize)
```
    Sets the current footer size in inches
    
    Parameters:
    
    footerSize - the current footer size
  - getMaxCells
```
@Deprecated
java.lang.String getMaxCells()
```
    Deprecated.
    not used anymore
    
    Returns the maximum number of cells to export
    
    Returns:
    
    the maximum number of cells to export
  - setMaxCells
```
@Deprecated
void setMaxCells(java.lang.String maxCells)
```
    Deprecated.
    not used anymore
    
    Sets the maximum number of cells to export
    
    Parameters:
    
    maxCells - the maximum number of cells to export
  - getDisplayCoverPage
```
boolean getDisplayCoverPage()
```
    Return whether to display a cover page with the filter details.
    
    Returns:
    
    whether to display a cover page with the filter details.
  - setDisplayCoverPage
```
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.
  - getStylePagebyInfo
```
java.lang.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
  - setStylePagebyInfo
```
void setStylePagebyInfo(java.lang.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
  - getShowAttributeFormNames
```
boolean getShowAttributeFormNames()
```
    Returns whether to show the attribute forms
    
    Returns:
    
    whether to show the attribute forms
  - setShowAttributeFormNames
```
void setShowAttributeFormNames(boolean showAttributeFormNames)
```
    Sets whether to show the attribute forms
    
    Parameters:
    
    showAttributeFormNames - whether to show the attribute forms
  - getPaperWidth
```
java.lang.String getPaperWidth()
```
    Returns the paper width
    
    Returns:
    
    the paper width
  - getPaperHeight
```
java.lang.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
  - getGraphHeight
```
java.lang.String getGraphHeight()
```
    Returns the graph's height
    
    Returns:
    
    the graph's height
  - setGraphHeight
```
void setGraphHeight(java.lang.String graphHeight)
```
    Sets the graph's height
    
    Parameters:
    
    graphHeight - the graph's height
  - getGraphWidth
```
java.lang.String getGraphWidth()
```
    Returns the graph's width
    
    Returns:
    
    the graph's width
  - setGraphWidth
```
void setGraphWidth(java.lang.String graphWidth)
```
    Sets the graph's width
    
    Parameters:
    
    graphWidth - the graph's width
  - getOutlineModeState
```
java.lang.String getOutlineModeState()
```
    Returns the current outline mode expansion state
    
    Returns:
    
    the current outline mode expansion state
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setOutlineModeState
```
void setOutlineModeState(java.lang.String outlineModeState)
```
    Sets the current outline mode expansion state
    
    Parameters:
    
    outlineModeState - the current outline mode expansion state
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getExpandPageByFields
```
boolean getExpandPageByFields()
```
    Returns whether to expand the page-by fields
    
    Returns:
    
    whether to expand the page-by fields
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setExpandPageByFields
```
void setExpandPageByFields(boolean expandPageByFields)
```
    Sets whether to expand the page-by fields
    
    Parameters:
    
    expandPageByFields - whether to expand the page-by fields
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getBeanError
```
AppBeanError getBeanError()
```
    Get PDF bean error
    
    Returns:
    
    bean error

Interface PDFBean

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

Method Summary

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

Methods inherited from interface com.microstrategy.web.beans.Transformable

Methods inherited from interface com.microstrategy.web.beans.WebComponent

Field Detail

COVER_PAGE_LOCATION_BEFORE_REPORT

COVER_PAGE_LOCATION_AFTER_REPORT

COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS

COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS

Method Detail

getReportBean

getExportSection

setExportSection

getShrinkFontPercentage

setShrinkFontPercentage

getFitToPagesWide

setFitToPagesWide

getFitToPagesTall

setFitToPagesTall

getScalingOption

setScalingOption

getHeaderLeftSection

setHeaderLeftSection

getHeaderCenterSection

setHeaderCenterSection

getHeaderRightSection

setHeaderRightSection

getFooterLeftSection

setFooterLeftSection

getFooterCenterSection

setFooterCenterSection

getFooterRightSection

setFooterRightSection

getPaperSize

setPaperSize

getPaperOrientationOption

setPaperOrientationOption

getMarginSizeLeft

setMarginSizeLeft

getMarginSizeRight

setMarginSizeRight

getMarginSizeTop

setMarginSizeTop

getMarginSizeBottom

setMarginSizeBottom

getHeaderSize

setHeaderSize

getFooterSize

setFooterSize

getMaxCells

setMaxCells

getDisplayCoverPage

setDisplayCoverPage

getStylePagebyInfo

setStylePagebyInfo

getShowAttributeFormNames

setShowAttributeFormNames

getPaperWidth

getPaperHeight

getGraphHeight

setGraphHeight

getGraphWidth

setGraphWidth

getOutlineModeState

setOutlineModeState

getExpandPageByFields

setExpandPageByFields

getBeanError