| com.microstrategy.web.objects.WebPDFSettings |
This interface is deprecated.
not used anymore
The WebPDFSettings class contains methods which determine the exact format of the data exported to PDF
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
getAttributeFormNamesDisplay()
returns the property related to showing attribute forms.
| ||||||||||
| abstract double |
getBottomMargin()
Returns the bottom margin distance.
| ||||||||||
| abstract boolean |
getCollectPerformanceData()
Returns whether the collectPerformanceData debug setting is set.
| ||||||||||
| abstract boolean |
getCompressPageOutput()
Returns whether the output will be compressed as per the current PDF setting.
| ||||||||||
| abstract boolean |
getExpandToFill()
Returns the pagination setting corresponding to expandToFill.
| ||||||||||
| abstract boolean |
getHandleStyles()
Returns whether the handleStyles debug setting is set.
| ||||||||||
| abstract int |
getHorizontalFitTo()
returns the number of pages wide to zoom to.
| ||||||||||
| abstract double |
getLeftMargin()
Returns the left margin distance.
| ||||||||||
| abstract double |
getMaxFooterHeight()
Returns the maximum footer height.
| ||||||||||
| abstract double |
getMaxHeaderHeight()
Returns the maximum header height.
| ||||||||||
| abstract boolean |
getMergeColumnHeaders()
returns the mergeColumnHeaders property.
| ||||||||||
| abstract String | getOutlineModeSettings() | ||||||||||
| abstract double |
getPageHeight()
Returns the page height.
| ||||||||||
| abstract double |
getPageWidth()
Returns the page width .
| ||||||||||
| abstract double |
getPercentageZoomFactor()
returns the percentage zoom factor.
| ||||||||||
| abstract boolean |
getRepeatColumnHeadersAcrossPages()
Returns whether the column headers will be repeated across PDF pages.
| ||||||||||
| abstract boolean |
getRepeatRowHeadersAcrossPages()
Returns whether the row headers will be repeated across PDF pages.
| ||||||||||
| abstract double |
getRightMargin()
Returns the right margin distance.
| ||||||||||
| abstract double |
getTopMargin()
Returns the top margin.
| ||||||||||
| abstract int |
getVerticalFitTo()
returns the number of pages high to zoom to.
| ||||||||||
| abstract void |
setAttributeFormNamesDisplay(int attributeFormNamesDisplay)
sets the property related to showing attribute forms.
| ||||||||||
| abstract void |
setBottomMargin(double bottomMargin)
Sets the bottom margin.
| ||||||||||
| abstract void |
setCollectPerformanceData(boolean collectPerformanceData)
Sets the collectPerformanceData debug setting.
| ||||||||||
| abstract void |
setCompressPageOutput(boolean compressPageOutput)
Sets the compressPageOutput PDF setting.
| ||||||||||
| abstract void |
setExpandToFill(boolean expandToFill)
Sets the expandToFill pagination setting.
| ||||||||||
| abstract void |
setHandleStyles(boolean handleStyles)
Sets the handleStyles debug setting.
| ||||||||||
| abstract void |
setHorizontalFitTo(int horizontalFitTo)
sets the number of pages wide to zoom to.
| ||||||||||
| abstract void |
setLeftMargin(double leftMargin)
Sets the left margin.
| ||||||||||
| abstract void |
setMaxFooterHeight(double maxFooterHeight)
Sets the Max Footer Height.
| ||||||||||
| abstract void |
setMaxHeaderHeight(double maxHeaderHeight)
Sets the Max Header height.
| ||||||||||
| abstract void |
setMergeColumnHeaders(boolean mergeColumnHeaders)
sets the mergeColumnHeaders property.
| ||||||||||
| abstract void | setOutlineModeSettings(String settings) | ||||||||||
| abstract void |
setPageHeight(double pageHeight)
Sets the page height.
| ||||||||||
| abstract void |
setPageWidth(double pageWidth)
Sets the page width.
| ||||||||||
| abstract void |
setPercentageZoomFactor(double percentageZoomFactor)
sets the percentage zoom factor(Default value is 100).
| ||||||||||
| abstract void |
setRepeatColumnHeadersAcrossPages(boolean repeatColumnHeaders)
Sets the repeatColumnHeaders pagination setting.
| ||||||||||
| abstract void |
setRepeatRowHeadersAcrossPages(boolean repeatRowHeaders)
Sets the repeatRowHeaders pagination setting.
| ||||||||||
| abstract void |
setRightMargin(double rightMargin)
Sets the right margin.
| ||||||||||
| abstract void |
setTopMargin(double topMargin)
Sets the top margin.
| ||||||||||
| abstract void |
setVerticalFitTo(int verticalFitTo)
sets the number of pages high to zoom to.
| ||||||||||
returns the property related to showing attribute forms. The returned value would be a value from the
enumeration interface EnumWebAttributeFormNamesDisplay
returns the value of the showAttributeFormNames property.
Returns the bottom margin distance.
Returns whether the collectPerformanceData debug setting is set.
Returns whether the output will be compressed as per the current PDF setting.
Returns the pagination setting corresponding to expandToFill.
Returns whether the handleStyles debug setting is set.
returns the number of pages wide to zoom to. The -1 means no restriction.
Returns the left margin distance.
Returns the maximum footer height.
Returns the maximum header height.
returns the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.
Returns the page height.
Returns the page width .
returns the percentage zoom factor.
Returns whether the column headers will be repeated across PDF pages. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the column headers would be outputted to all PDF pages or just the first one.
Returns whether the row headers will be repeated across PDF pages. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the row headers would be outputted to all PDF pages or just the first one.
Returns the right margin distance.
Returns the top margin.
returns the number of pages high to zoom to. The -1 means no restriction.
sets the property related to showing attribute forms. The setting value should be a value from the
enumeration interface EnumWebAttributeFormNamesDisplay. The default value is
NoDisplay
Sets the bottom margin. Default value = 0.5. Unit = inches.
| bottomMargin | The bottom margin to be set. |
|---|
Sets the collectPerformanceData debug setting. Default value is False.
| collectPerformanceData | Specifies whether to collect the performance data. |
|---|
Sets the compressPageOutput PDF setting. Default value is True.
| compressPageOutput | Specifies whether to compress the page output. |
|---|
Sets the expandToFill pagination setting. Default value = False.
| expandToFill | Specifies whether to expand to fill. |
|---|
Sets the handleStyles debug setting. Default value is True.
| handleStyles | Specifies whether to handle styles. |
|---|
sets the number of pages wide to zoom to. Default value is -1. The -1 means no restriction.
| horizontalFitTo | the number of pages wide to zoom to. |
|---|
Sets the left margin. Default value = 0.5 Unit = inches.
| leftMargin | The left margin to be set. |
|---|
Sets the Max Footer Height. Default value = 0.5 Unit = inches.
| maxFooterHeight | The maximum footer height. |
|---|
Sets the Max Header height. Default value = 0.5 Unit = inches.
| maxHeaderHeight | The maximum header height to be set. |
|---|
sets the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.
Sets the page height. Default value = 11. Unit = inches.
| pageHeight | The page height to be set. |
|---|
Sets the page width. Default value = 8.5. Unit = inches.
| pageWidth | The page width to be set. |
|---|
sets the percentage zoom factor(Default value is 100). A value greater than 0 is expected. When Percentage Zoom Factor is specified (and it is not 100), horizontalFitTo and verticalFitTo will be ignored.
| percentageZoomFactor | the percentage zoom factor. |
|---|
Sets the repeatColumnHeaders pagination setting. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the column headers would be outputted to all PDF pages or just the first one. Default value is True.
| repeatColumnHeaders | Specifies whether to repeat the column headers. |
|---|
Sets the repeatRowHeaders pagination setting. Default value is True. If upon exporting to PDF, the report spans more than one PDF page, this setting determines whether the row headers would be outputted to all PDF pages or just the first one.
| repeatRowHeaders | Specifies whether to repeat the row headers. |
|---|
Sets the right margin. Defalue value = 1.0 Unit inches.
| rightMargin | The right margin to be set. |
|---|
Sets the top margin. Default value = 0.5. Unit = inches.
| topMargin | The top margin to be set. |
|---|
sets the number of pages high to zoom to. Default value is -1. The -1 means no restriction.
| verticalFitTo | the number of pages high to zoom to. |
|---|