com.qoppa.office

Class PrintOptions

java.lang.Object

com.qoppa.office.PrintOptions

public class PrintOptions
extends Object

This object controls the behavior of the library when sending a Word document to the printer. The object has four flags that can be set:

AutoRotate - Will rotate the printout to match the width and length with the paper. When this flag is on, the library will ignore the portrait / landscape setting set by the user.

ShrinkToPage - Will shrink pages so that they fit in the paper. This flag has no effect if the pages in a document are smaller than the paper they are being printed on.

ExpandToPage - Will expand pages to fill the paper they are being printed on. This flag has no effect if the pages in a document are larger than the paper they are being printed on.

CenterInPage - Will center the page in the paper. This flag has no effect if the pages in a document are larger than the paper they are being printed on.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
PrintOptions() Constructs a default PrintOptions object.
PrintOptions(boolean autoRotate, boolean shrinkToMargins, boolean expandToMargins, boolean centerInPage) Constructs a new PrintOptions object and initializes each of its variables to the parameters.

Method Summary

Modifier and Type	Method and Description
boolean	isAutoRotate() Returns the value auto-rotate flag.
boolean	isCenterInPage() Returns the current value of the center-in-page flag.
boolean	isExpandToMargins() Returns the value of the expand-to-margins flag.
boolean	isShrinkToMargins() Returns the value of the shrink-to-margins flag.
void	setAutoRotate(boolean autoRotate) Sets the value of the auto-rotate flag.
void	setCenterInPage(boolean centerInPage) Sets the value of the center-in-page flag.
void	setExpandToMargins(boolean expandToMargins) Sets the value of the expand-to-margins flag.
void	setShrinkToMargins(boolean shrinkToMargins) Sets the value of the shrink-to-margins flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrintOptions

public PrintOptions()

Constructs a default PrintOptions object. The default PrintOptions object will auto-rotate, shrink to fit and center in page, but will not expand the content to fit to the margins.

PrintOptions

public PrintOptions(boolean autoRotate,
                    boolean shrinkToMargins,
                    boolean expandToMargins,
                    boolean centerInPage)

Constructs a new PrintOptions object and initializes each of its variables to the parameters.

Parameters:

autoRotate - Sets the auto rotate flag.

shrinkToMargins - Sets the shrink to page flag.

expandToMargins - Sets the expand to page flag.

centerInPage - Sets the center in page flag.

Method Detail

isAutoRotate

public boolean isAutoRotate()

Returns the value auto-rotate flag.

Returns:

the value of the auto-rotate flag.

setAutoRotate

public void setAutoRotate(boolean autoRotate)

Sets the value of the auto-rotate flag.

Parameters:

autoRotate - The new value of the auto-rotate flag.

isShrinkToMargins

public boolean isShrinkToMargins()

Returns the value of the shrink-to-margins flag.

Returns:

the value of the shrink-to-margins

setShrinkToMargins

public void setShrinkToMargins(boolean shrinkToMargins)

Sets the value of the shrink-to-margins flag.

Parameters:

shrinkToMargins - The new value of the shrink-to-margins flag.

isExpandToMargins

public boolean isExpandToMargins()

Returns the value of the expand-to-margins flag.

Returns:

The current value of the expand-to-margins flag.

setExpandToMargins

public void setExpandToMargins(boolean expandToMargins)

Sets the value of the expand-to-margins flag.

Parameters:

expandToMargins - The new value of the expand-to-margins flag.

isCenterInPage

public boolean isCenterInPage()

Returns the current value of the center-in-page flag.

Returns:

The current value of the center-in-page flag.

setCenterInPage

public void setCenterInPage(boolean centerInPage)

Sets the value of the center-in-page flag.

Parameters:

centerInPage - The new value of the center-in-page flag.