Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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

a string value corresponding to SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION

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

Interfaces

Classes

Exceptions

PDFBean

Class Overview

Summary

Constants

public static final String COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS

public static final String COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS

public static final String COVER_PAGE_LOCATION_AFTER_REPORT

public static final String COVER_PAGE_LOCATION_BEFORE_REPORT

Public Methods

public abstract AppBeanError getBeanError ()

Returns

public abstract boolean getDisplayCoverPage ()

Returns

public abstract boolean getExpandPageByFields ()

Returns

public abstract int getExportSection ()

Returns

public abstract String getFitToPagesTall ()

Returns

public abstract String getFitToPagesWide ()

Returns

public abstract String getFooterCenterSection ()

Returns

public abstract String getFooterLeftSection ()

Returns

public abstract String getFooterRightSection ()

Returns

public abstract String getFooterSize ()

Returns

public abstract String getGraphHeight ()

Returns

public abstract String getGraphWidth ()

Returns

public abstract String getHeaderCenterSection ()

Returns

public abstract String getHeaderLeftSection ()

Returns

public abstract String getHeaderRightSection ()

Returns

public abstract String getHeaderSize ()

Returns

public abstract String getMarginSizeBottom ()

Returns

public abstract String getMarginSizeLeft ()

Returns

public abstract String getMarginSizeRight ()

Returns

public abstract String getMarginSizeTop ()

Returns

public abstract String getMaxCells ()

Returns

public abstract String getOutlineModeState ()

Returns

public abstract String getPaperHeight ()

Returns

public abstract String getPaperOrientationOption ()

Returns

public abstract String getPaperSize ()

Returns

public abstract String getPaperWidth ()

Returns

public abstract ReportBean getReportBean ()

Returns

public abstract String getScalingOption ()

Returns

public abstract boolean getShowAttributeFormNames ()

Returns

public abstract String getShrinkFontPercentage ()

Returns

public abstract String getStylePagebyInfo ()

Returns

public abstract void setDisplayCoverPage (boolean displayCoverPage)

Parameters

public abstract void setExpandPageByFields (boolean expandPageByFields)

Parameters

public abstract void setExportSection (int exportSection)

Parameters