com.microstrategy.web.app.beans.PrintBean |
This interface is deprecated.
not used anymore since printing is done via PDF
The interface PrintBean is representing the export web component.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | HEADER_FOOTER_PATTERN_CURRENT_PAGE | Constant representing the page macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_DATE | Constant representing the date macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_DETAILS | Constant representing the details macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_FILTER | Constant representing the filter macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_PROJECT | Constant representing the project macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_REPORT | Constant representing the report macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_TEMPLATE | Constant representing the template macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_TIME | Constant representing the time macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_TOTAL_PAGES | Constant representing the total pages macro pattern | |||||||||
String | HEADER_FOOTER_PATTERN_USER_NAME | Constant representing the user name macro pattern | |||||||||
String | PAPER_ORIENTATION_LANDSCAPE_OPTION | Constant representing the paper orientation landscape option | |||||||||
String | PAPER_ORIENTATION_PORTRAIT_OPTION | Constant representing the paper orientation portrait option | |||||||||
int | PrintSectionDisplayAdminFooter | Constant representing the admin footer section | |||||||||
int | PrintSectionDisplayAdminHeader | Constant representing the admin header section | |||||||||
int | PrintSectionDisplayCoverPage | Constant representing the cover page section | |||||||||
int | PrintSectionDisplayPagebyInfoHeader | Constant representing the page by info header section | |||||||||
int | PrintSectionDisplayUserFooter | Constant representing the user footer section | |||||||||
int | PrintSectionDisplayUserHeader | Constant representing the user header section | |||||||||
String | SCALING_FIT_TO_PAGE_OPTION | Constant representing the fit to page scaling option | |||||||||
String | SCALING_SHRINK_FONT_OPTION | Constant representing the shrink font scaling option |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract String |
getAdminFooterFilePath()
Returns the current administrator's footer file path
| ||||||||||
abstract String |
getAdminHeaderFilePath()
Returns the current administrator's header file path
| ||||||||||
abstract String |
getCellsPerBlock()
Returns the current cells per block.
| ||||||||||
abstract int |
getCurrentPagebyOrdinal(ReportBean rb)
Returns the current pageby ordinal indicated by the report bean.
| ||||||||||
abstract boolean |
getDisplayCoverPage()
Returns a boolean value that indicates whether to display the cover page
| ||||||||||
abstract boolean |
getDisplayGridAndGraphSamePage()
Returns a boolean value that determines whether to display the grid and graph on the same page.
| ||||||||||
abstract boolean |
getDisplayPopupPrintDialog()
Returns a boolean value that determine whether to display the popup print dialog when printing.
| ||||||||||
abstract boolean |
getExpandPageByFields()
Returns a boolean value that indicates whether to expand the page=by fields
| ||||||||||
abstract boolean |
getFitColsToPage()
Returns a boolean value that determines whether to fit the columns to page.
| ||||||||||
abstract boolean |
getFitRowsToPage()
Returns a boolean value that determines whether to fit the rows to page.
| ||||||||||
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 (only DHTML mode)
| ||||||||||
abstract String |
getGraphColsPerPage()
Returns the current graph columns per page
| ||||||||||
abstract String |
getGraphRowsPerPage()
Returns the current the current graph rows per page
| ||||||||||
abstract String |
getGraphSize()
Returns the user's graph size.
| ||||||||||
abstract String |
getGraphsPerBlock()
Returns the current graphs per block.
| ||||||||||
abstract String |
getGridColsPerPage()
Returns the current grid columns per page (only HTML mode)
| ||||||||||
abstract String |
getGridRowsPerPage()
Returns the current grid rows per page (only HTML mode)
| ||||||||||
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 (only DHTML mode)
| ||||||||||
abstract String |
getMarginSizeBottom()
Returns the current bottom margin size in inches (only DHTML mode)
| ||||||||||
abstract String |
getMarginSizeLeft()
returns the current left margin size in inches (only DHTML mode)
| ||||||||||
abstract String |
getMarginSizeRight()
Returns the current right margin size in inches (only DHTML mode)
| ||||||||||
abstract String |
getMarginSizeTop()
Returns the current top margin size in inches (only DHTML mode)
| ||||||||||
abstract String |
getPagebyOrdinal()
Returns the current page by ordinal
| ||||||||||
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 int |
getPrintSectionFlags()
Returns the current print section flags
(a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
| ||||||||||
abstract ReportBean | getReportBean() | ||||||||||
abstract int |
getRowsPerBlock(ReportBean rb)
Returns the total number of rows per printing block.
| ||||||||||
abstract int |
getRowsToShow(ReportBean rb)
Returns the total number of rows to show on the current print block
| ||||||||||
abstract String |
getScalingOption()
Returns the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
| ||||||||||
abstract String |
getShrinkFontPercentage()
Returns the current shrink font percentage.
| ||||||||||
abstract String |
getStartRow()
Returns the block's start row
| ||||||||||
abstract String |
getStyleGraphs()
Returns the current style used when transforming the report bean to generate graphs
| ||||||||||
abstract String |
getStyleGrids()
Returns the current style used when transforming the report bean to generate grids
| ||||||||||
abstract String |
getStylePagebyInfo()
Returns the current style used when transforming the report bean to generate the page by information
| ||||||||||
abstract String |
getUserGraphHeight()
Returns the user's graph height.
| ||||||||||
abstract String |
getUserGraphWidth()
Returns the user's graph width.
| ||||||||||
abstract void |
setAdminFooterFilePath(String adminFooterFilePath)
Sets the current administrator's footer file path
| ||||||||||
abstract void |
setAdminHeaderFilePath(String adminHeaderFilePath)
Sets the current administrator's header file path
| ||||||||||
abstract void |
setCellsPerBlock(String cellsPerBlock)
Sets the current cells per block.
| ||||||||||
abstract void |
setDisplayCoverPage(boolean displayCoverPage)
Sets the boolean value that indicates whether to display the cover page
| ||||||||||
abstract void |
setDisplayGridAndGraphSamePage(boolean displayGridAndGraphSamePage)
Sets the boolean value that determine whether to display the grid and graph on the same page.
| ||||||||||
abstract void |
setDisplayPopupPrintDialog(boolean displayPopupPrintDialog)
Sets the boolean value that determine whether to display the popup print dialog when printing.
| ||||||||||
abstract void |
setExpandPageByFields(boolean expandPageByFields)
Sets the boolean value that indicates whether to expand the page=by fields
| ||||||||||
abstract void |
setFitColsToPage(boolean fitColsToPage)
Sets the boolean value that determines whether to fit the columns to page.
| ||||||||||
abstract void |
setFitRowsToPage(boolean fitRowsToPage)
Sets the boolean value that determines whether to fit the rows to page.
| ||||||||||
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 (only DHTML mode)
| ||||||||||
abstract void |
setGraphColsPerPage(String graphColsPerPage)
Sets the current graph columns per page
| ||||||||||
abstract void |
setGraphRowsPerPage(String graphRowsPerPage)
Sets the current the current graph rows per page
| ||||||||||
abstract void |
setGraphSize(String graphSize)
Sets the user's graph size.
| ||||||||||
abstract void |
setGraphsPerBlock(String graphsPerBlock)
Sets the current graphs per block.
| ||||||||||
abstract void |
setGridColsPerPage(String gridColsPerPage)
Sets the current grid columns per page (only HTML mode)
| ||||||||||
abstract void |
setGridRowsPerPage(String gridRowsPerPage)
Sets the current grid rows per page (only HTML mode)
| ||||||||||
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 (only DHTML mode)
| ||||||||||
abstract void |
setMarginSizeBottom(String marginSizeBottom)
Sets the current bottom margin size in inches (only DHTML mode)
| ||||||||||
abstract void |
setMarginSizeLeft(String marginSizeLeft)
Sets the current left margin size in inches (only DHTML mode)
| ||||||||||
abstract void |
setMarginSizeRight(String marginSizeRight)
Sets the current right margin size in inches (only DHTML mode)
| ||||||||||
abstract void |
setMarginSizeTop(String marginSizeTop)
Sets the current top margin size in inches (only DHTML mode)
| ||||||||||
abstract void |
setPagebyOrdinal(String pagebyOrdinal)
Sets the current page by ordinal
| ||||||||||
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 |
setPrintSectionFlags(int printSectionFlags)
Sets the current print section flags
(a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
| ||||||||||
abstract void |
setReportBean(ReportBean rb)
Sets the report bean associated with this print bean.
| ||||||||||
abstract void |
setScalingOption(String scalingOption)
Sets the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
| ||||||||||
abstract void |
setShrinkFontPercentage(String shrinkFontPercentage)
Sets the current shrink font percentage.
| ||||||||||
abstract void |
setStartRow(String startRow)
Sets the block's start row
| ||||||||||
abstract void |
setStyleGraphs(String styleGraphs)
Sets the current style used when transforming the report bean to generate graphs
| ||||||||||
abstract void |
setStyleGrids(String styleGrids)
Sets the current style used when transforming the report bean to generate grids
| ||||||||||
abstract void |
setStylePagebyInfo(String stylePagebyInfo)
Sets the current style used when transforming the report bean to generate the page by information
| ||||||||||
abstract void |
setUserGraphHeight(String userGraphHeight)
Sets the user's graph height.
| ||||||||||
abstract void |
setUserGraphWidth(String userGraphWidth)
Sets the user's graph width.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constant representing the page macro pattern
Constant representing the date macro pattern
Constant representing the details macro pattern
Constant representing the filter macro pattern
Constant representing the project macro pattern
Constant representing the report macro pattern
Constant representing the template macro pattern
Constant representing the time macro pattern
Constant representing the total pages macro pattern
Constant representing the user name macro pattern
Constant representing the paper orientation landscape option
Constant representing the paper orientation portrait option
Constant representing the admin footer section
Constant representing the admin header section
Constant representing the cover page section
Constant representing the page by info header section
Constant representing the user footer section
Constant representing the user header section
Constant representing the fit to page scaling option
Constant representing the shrink font scaling option
Returns the current administrator's footer file path
Returns the current administrator's header file path
Returns the current cells per block. This limits the amount of HTML sent the the client.
Returns the current pageby ordinal indicated by the report bean.
rb | ReportBean to print |
---|
Returns a boolean value that indicates whether to display the cover page
Returns a boolean value that determines whether to display the grid and graph on the same page.
Returns a boolean value that determine whether to display the popup print dialog when printing. (only DHTML)
Returns a boolean value that indicates whether to expand the page=by fields
Returns a boolean value that determines whether to fit the columns to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
Returns a boolean value that determines whether to fit the rows to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
Returns the current footer center section content
Returns the current footer left section content
Returns the current footer right section content
Returns the current footer size in inches (only DHTML mode)
Returns the current graph columns per page
Returns the current the current graph rows per page
Returns the user's graph size. Determines the size of graphs (PreferencesGraphTransform.GRAPH_USE_USER_SIZE or PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE
)
Returns the current graphs per block. This limits the amount of HTML sent the the client.
Returns the current grid columns per page (only HTML mode)
Returns the current grid rows per page (only HTML mode)
Returns the current header center section content
Returns the current header left section content
Returns the current header right section content
Returns the current header size in inches (only DHTML mode)
Returns the current bottom margin size in inches (only DHTML mode)
returns the current left margin size in inches (only DHTML mode)
Returns the current right margin size in inches (only DHTML mode)
Returns the current top margin size in inches (only DHTML mode)
Returns the current page by ordinal
Returns the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
Returns the current paper size (a key from paperSizes.xml)
Returns the current print section flags (a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
Returns the total number of rows per printing block.
rb | ReportBean to print |
---|
Returns the total number of rows to show on the current print block
rb | ReportBean to print |
---|
Returns the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
Returns the current shrink font percentage. Applied if scalingOption equals SCALING_SHRINK_FONT (only DHTML mode)
Returns the block's start row
Returns the current style used when transforming the report bean to generate graphs
Returns the current style used when transforming the report bean to generate grids
Returns the current style used when transforming the report bean to generate the page by information
Returns the user's graph height. Determines the size of graphs
Returns the user's graph width. Determines the size of graphs
Sets the current administrator's footer file path
adminFooterFilePath | the current administrator's footer file path |
---|
Sets the current administrator's header file path
adminHeaderFilePath | the current administrator's header file path |
---|
Sets the current cells per block. This limits the amount of HTML sent the the client.
cellsPerBlock | the current cells per block |
---|
Sets the boolean value that indicates whether to display the cover page
displayCoverPage | true if the cover page is to be displayed |
---|
Sets the boolean value that determine whether to display the grid and graph on the same page.
displayGridAndGraphSamePage | true if the Grid and Graph are to be displayed on the same page |
---|
Sets the boolean value that determine whether to display the popup print dialog when printing. (only DHTML)
displayPopupPrintDialog | true is the popup print dialog is to be displayed |
---|
Sets the boolean value that indicates whether to expand the page=by fields
expandPageByFields | true if the page-by fields are to be expanded |
---|
Sets the boolean value that determines whether to fit the columns to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
fitColsToPage | true if fit columns to page |
---|
Sets the boolean value that determines whether to fit the rows to page. Applied if scaling equals to SCALING_FIT_TO_PAGE_OPTION (only DHTML mode)
fitRowsToPage | true if fit the rows to page |
---|
Sets the current footer center section content
footerCenterSection | the current footer center section |
---|
Sets the current footer left section content
footerLeftSection | the current footer left section |
---|
Sets the current footer right section content
footerRightSection | the current footer right section |
---|
Sets the current footer size in inches (only DHTML mode)
footerSize | the current footer size |
---|
Sets the current graph columns per page
graphColsPerPage | graph columns per page |
---|
Sets the current the current graph rows per page
graphRowsPerPage | the current graph rows per page |
---|
Sets the user's graph size. Determines the size of graphs (PreferencesGraphTransform.GRAPH_USE_USER_SIZE or PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE
)
graphSize | the user's graph size |
---|
Sets the current graphs per block. This limits the amount of HTML sent the the client.
graphsPerBlock | the current graphs per block |
---|
Sets the current grid columns per page (only HTML mode)
gridColsPerPage | the current grid columns per page |
---|
Sets the current grid rows per page (only HTML mode)
gridRowsPerPage | the current grid rows per page |
---|
Sets the current header center section content
headerCenterSection | the current header center section |
---|
Sets the current header left section content
headerLeftSection | the current header left section |
---|
Sets the current header right section content
headerRightSection | the current header right section |
---|
Sets the current header size in inches (only DHTML mode)
headerSize | the current header size |
---|
Sets the current bottom margin size in inches (only DHTML mode)
marginSizeBottom | the current bottom margin size |
---|
Sets the current left margin size in inches (only DHTML mode)
marginSizeLeft | the current left margin size |
---|
Sets the current right margin size in inches (only DHTML mode)
marginSizeRight | the current right margin size |
---|
Sets the current top margin size in inches (only DHTML mode)
marginSizeTop | the current top margin size |
---|
Sets the current page by ordinal
pagebyOrdinal | the current page by ordinal |
---|
Sets the current paper orientation (PAPER_ORIENTATION_PORTRAIT_OPTION or PAPER_ORIENTATION_LANDSCAPE_OPTION)
paperOrientationOption | the current paper orientation |
---|
Sets the current paper size (a key from paperSizes.xml)
paperSize | the current paper size |
---|
Sets the current print section flags (a value from combining PrintSectionDisplay flags (PrintSectionDisplayGrid, PrintSectionDisplayHeader, etc.))
printSectionFlags | the current print section flags |
---|
Sets the report bean associated with this print bean.
rb | Report Bean |
---|
Sets the current scaling option (SCALING_SHRINK_FONT_OPTION or SCALING_FIT_TO_PAGE_OPTION)
scalingOption | the current scaling option |
---|
Sets the current shrink font percentage. Applied if scalingOption equals SCALING_SHRINK_FONT (only DHTML mode)
shrinkFontPercentage | the current shrink font percentage |
---|
Sets the block's start row
startRow | the block's start row |
---|
Sets the current style used when transforming the report bean to generate graphs
styleGraphs | the current style used when transforming the report bean to generate graphs |
---|
Sets the current style used when transforming the report bean to generate grids
styleGrids | the current style used when transforming the report bean to generate grids |
---|
Sets the current style used when transforming the report bean to generate the page by information
stylePagebyInfo | the current style used when transforming the report bean to generate the page by information |
---|
Sets the user's graph height. Determines the size of graphs
userGraphHeight | the user's graph height |
---|
Sets the user's graph width. Determines the size of graphs
userGraphWidth | the user's graph width |
---|