PdfFormattingOptions
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
All Implemented Interfaces: java.io.Serializable
public final class PdfFormattingOptions extends ValueObject implements Serializable
Defines Pdf formatting options.
Constructors
| Constructor | Description |
|---|---|
| PdfFormattingOptions() |
Methods
| Method | Description |
|---|---|
| getCenterWindow() | Specifies whether position of the document’s window will be centered on the screen. |
| setCenterWindow(boolean value) | Specifies whether position of the document’s window will be centered on the screen. |
| getDirection() | Sets reading order of text: L2R (left to right) or R2L (right to left). |
| setDirection(PdfDirection value) | Sets reading order of text: L2R (left to right) or R2L (right to left). |
| getDisplayDocTitle() | Specifies whether document’s window title bar should display document title. |
| setDisplayDocTitle(boolean value) | Specifies whether document’s window title bar should display document title. |
| getFitWindow() | Specifies whether document window must be resized to fit the first displayed page. |
| setFitWindow(boolean value) | Specifies whether document window must be resized to fit the first displayed page. |
| getHideMenuBar() | Specifies whether menu bar should be hidden when document is active. |
| setHideMenuBar(boolean value) | Specifies whether menu bar should be hidden when document is active. |
| getHideToolBar() | Specifies whether toolbar should be hidden when document is active. |
| setHideToolBar(boolean value) | Specifies whether toolbar should be hidden when document is active. |
| getHideWindowUI() | Specifies whether user interface elements should be hidden when document is active. |
| setHideWindowUI(boolean value) | Specifies whether user interface elements should be hidden when document is active. |
| getNonFullScreenPageMode() | Sets page mode, specifying how to display the document on exiting full-screen mode. |
| setNonFullScreenPageMode(PdfPageMode value) | Sets page mode, specifying how to display the document on exiting full-screen mode. |
| getPageLayout() | Sets page layout which shall be used when the document is opened. |
| setPageLayout(PdfPageLayout value) | Sets page layout which shall be used when the document is opened. |
| getPageMode() | Sets page mode, specifying how document should be displayed when opened. |
| setPageMode(PdfPageMode value) | Sets page mode, specifying how document should be displayed when opened. |
PdfFormattingOptions()
public PdfFormattingOptions()
getCenterWindow()
public final boolean getCenterWindow()
Specifies whether position of the document’s window will be centered on the screen. Default: false.
Returns: boolean
setCenterWindow(boolean value)
public final void setCenterWindow(boolean value)
Specifies whether position of the document’s window will be centered on the screen. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getDirection()
public final PdfDirection getDirection()
Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.
Returns: PdfDirection
setDirection(PdfDirection value)
public final void setDirection(PdfDirection value)
Sets reading order of text: L2R (left to right) or R2L (right to left). Default: L2R.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfDirection |
getDisplayDocTitle()
public final boolean getDisplayDocTitle()
Specifies whether document’s window title bar should display document title. Default: false.
Returns: boolean
setDisplayDocTitle(boolean value)
public final void setDisplayDocTitle(boolean value)
Specifies whether document’s window title bar should display document title. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getFitWindow()
public final boolean getFitWindow()
Specifies whether document window must be resized to fit the first displayed page. Default: false.
Returns: boolean
setFitWindow(boolean value)
public final void setFitWindow(boolean value)
Specifies whether document window must be resized to fit the first displayed page. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getHideMenuBar()
public final boolean getHideMenuBar()
Specifies whether menu bar should be hidden when document is active. Default: false.
Returns: boolean
setHideMenuBar(boolean value)
public final void setHideMenuBar(boolean value)
Specifies whether menu bar should be hidden when document is active. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getHideToolBar()
public final boolean getHideToolBar()
Specifies whether toolbar should be hidden when document is active. Default: false.
Returns: boolean
setHideToolBar(boolean value)
public final void setHideToolBar(boolean value)
Specifies whether toolbar should be hidden when document is active. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getHideWindowUI()
public final boolean getHideWindowUI()
Specifies whether user interface elements should be hidden when document is active. Default: false.
Returns: boolean
setHideWindowUI(boolean value)
public final void setHideWindowUI(boolean value)
Specifies whether user interface elements should be hidden when document is active. Default: false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getNonFullScreenPageMode()
public final PdfPageMode getNonFullScreenPageMode()
Sets page mode, specifying how to display the document on exiting full-screen mode.
Returns: PdfPageMode
setNonFullScreenPageMode(PdfPageMode value)
public final void setNonFullScreenPageMode(PdfPageMode value)
Sets page mode, specifying how to display the document on exiting full-screen mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfPageMode |
getPageLayout()
public final PdfPageLayout getPageLayout()
Sets page layout which shall be used when the document is opened.
Returns: PdfPageLayout
setPageLayout(PdfPageLayout value)
public final void setPageLayout(PdfPageLayout value)
Sets page layout which shall be used when the document is opened.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfPageLayout |
getPageMode()
public final PdfPageMode getPageMode()
Sets page mode, specifying how document should be displayed when opened.
Returns: PdfPageMode
setPageMode(PdfPageMode value)
public final void setPageMode(PdfPageMode value)
Sets page mode, specifying how document should be displayed when opened.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfPageMode |