public interface

WebPDFSettings

com.microstrategy.web.objects.WebPDFSettings

This interface is deprecated.
not used anymore

Class Overview

The WebPDFSettings class contains methods which determine the exact format of the data exported to PDF

Summary

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.

Public Methods

public abstract int getAttributeFormNamesDisplay ()

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.

public abstract double getBottomMargin ()

Returns the bottom margin distance.

Returns
  • The bottom margin.

public abstract boolean getCollectPerformanceData ()

Returns whether the collectPerformanceData debug setting is set.

Returns
  • The corresponding debug setting.

public abstract boolean getCompressPageOutput ()

Returns whether the output will be compressed as per the current PDF setting.

Returns
  • The corresponding PDF setting.

public abstract boolean getExpandToFill ()

Returns the pagination setting corresponding to expandToFill.

Returns
  • The corresponding pagination setting.

public abstract boolean getHandleStyles ()

Returns whether the handleStyles debug setting is set.

Returns
  • The corresponding debug setting.

public abstract int getHorizontalFitTo ()

returns the number of pages wide to zoom to. The -1 means no restriction.

Returns
  • the number of pages wide to zoom to.

public abstract double getLeftMargin ()

Returns the left margin distance.

Returns
  • The left margin.

public abstract double getMaxFooterHeight ()

Returns the maximum footer height.

Returns
  • The maximum footer height.

public abstract double getMaxHeaderHeight ()

Returns the maximum header height.

Returns
  • The maximum header height.

public abstract boolean getMergeColumnHeaders ()

returns the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.

Returns
  • the value of the mergeColumnHeaders setting.

public abstract String getOutlineModeSettings ()

public abstract double getPageHeight ()

Returns the page height.

Returns
  • The page height.

public abstract double getPageWidth ()

Returns the page width .

Returns
  • The page width.

public abstract double getPercentageZoomFactor ()

returns the percentage zoom factor.

Returns
  • the percentage zoom factor.

public abstract boolean getRepeatColumnHeadersAcrossPages ()

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
  • The corresponding pagination setting.

public abstract boolean getRepeatRowHeadersAcrossPages ()

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 corresponding pagination setting.

public abstract double getRightMargin ()

Returns the right margin distance.

Returns
  • The right margin.

public abstract double getTopMargin ()

Returns the top margin.

Returns
  • The top margin.

public abstract int getVerticalFitTo ()

returns the number of pages high to zoom to. The -1 means no restriction.

Returns
  • the number of pages high to zoom to.

public abstract void setAttributeFormNamesDisplay (int attributeFormNamesDisplay)

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

public abstract void setBottomMargin (double bottomMargin)

Sets the bottom margin. Default value = 0.5. Unit = inches.

Parameters
bottomMargin The bottom margin to be set.

public abstract void setCollectPerformanceData (boolean collectPerformanceData)

Sets the collectPerformanceData debug setting. Default value is False.

Parameters
collectPerformanceData Specifies whether to collect the performance data.

public abstract void setCompressPageOutput (boolean compressPageOutput)

Sets the compressPageOutput PDF setting. Default value is True.

Parameters
compressPageOutput Specifies whether to compress the page output.

public abstract void setExpandToFill (boolean expandToFill)

Sets the expandToFill pagination setting. Default value = False.

Parameters
expandToFill Specifies whether to expand to fill.

public abstract void setHandleStyles (boolean handleStyles)

Sets the handleStyles debug setting. Default value is True.

Parameters
handleStyles Specifies whether to handle styles.

public abstract void setHorizontalFitTo (int horizontalFitTo)

sets the number of pages wide to zoom to. Default value is -1. The -1 means no restriction.

Parameters
horizontalFitTo the number of pages wide to zoom to.

public abstract void setLeftMargin (double leftMargin)

Sets the left margin. Default value = 0.5 Unit = inches.

Parameters
leftMargin The left margin to be set.

public abstract void setMaxFooterHeight (double maxFooterHeight)

Sets the Max Footer Height. Default value = 0.5 Unit = inches.

Parameters
maxFooterHeight The maximum footer height.

public abstract void setMaxHeaderHeight (double maxHeaderHeight)

Sets the Max Header height. Default value = 0.5 Unit = inches.

Parameters
maxHeaderHeight The maximum header height to be set.

public abstract void setMergeColumnHeaders (boolean mergeColumnHeaders)

sets the mergeColumnHeaders property. This setting determines whether the column headers should be merged in the resulting PDF or not.

public abstract void setOutlineModeSettings (String settings)

public abstract void setPageHeight (double pageHeight)

Sets the page height. Default value = 11. Unit = inches.

Parameters
pageHeight The page height to be set.

public abstract void setPageWidth (double pageWidth)

Sets the page width. Default value = 8.5. Unit = inches.

Parameters
pageWidth The page width to be set.

public abstract void setPercentageZoomFactor (double percentageZoomFactor)

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.

Parameters
percentageZoomFactor the percentage zoom factor.

public abstract void setRepeatColumnHeadersAcrossPages (boolean repeatColumnHeaders)

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.

Parameters
repeatColumnHeaders Specifies whether to repeat the column headers.

public abstract void setRepeatRowHeadersAcrossPages (boolean repeatRowHeaders)

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.

Parameters
repeatRowHeaders Specifies whether to repeat the row headers.

public abstract void setRightMargin (double rightMargin)

Sets the right margin. Defalue value = 1.0 Unit inches.

Parameters
rightMargin The right margin to be set.

public abstract void setTopMargin (double topMargin)

Sets the top margin. Default value = 0.5. Unit = inches.

Parameters
topMargin The top margin to be set.

public abstract void setVerticalFitTo (int verticalFitTo)

sets the number of pages high to zoom to. Default value is -1. The -1 means no restriction.

Parameters
verticalFitTo the number of pages high to zoom to.