oracle.javatools.editor.print
Class PrintOptions

java.lang.Object
  oracle.javatools.editor.print.PrintOptions

public class PrintOptions

extends java.lang.Object

The PrintOptions defines various printing options supported currenting by the EditorPageable implementation.

Field Summary

static int	LINE_NUMBERS_EVERY Constant indicating we should print out line numbers for every buffer line (but not for subsequent lines of a wrapped buffer line.)
static int	LINE_NUMBERS_NONE Constant indicating we should not print out line numbers.
static int	WRAP_FILL_WIDTH Constant indicating we should do basic wrapping - long lines will be wrapped when it reaches the page edge.
static int	WRAP_NONE Constant indicating that we should not perform any line wrappings.

Constructor Summary

PrintOptions()
Construct a new PrintOptions with default option values.

Method Summary

java.lang.Object	clone() Creates a duplicate copy of this option class.
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
java.lang.String	getFontFamily() Retrieve the font family of the font to use for printing.
int	getFontSize() Fetches the font size to use for printing.
boolean	getPrintColors() Fetch whether we are printing foreground colors in the output.
boolean	getPrintFileHeader() Fetch whether we should print out a file header on the top displaying the name of the file.
boolean	getPrintFontStyles() Fetch whether we are printing the font styles in the output.
int	getPrintLineNumbers() Fetch whether we are printing line numbers in the output.
boolean	getPrintPageNumbers() Gets whether we are printing out page numbers in the upper right-hand of the output.
int	getWrapBehavior() Fetch the current wrapping behavior.
java.lang.String	getWrapSymbol() Fetch the wrap symbol to print in the right margin for wrapped lines.
void	setFontFamily(java.lang.String fontFamily) Sets the font family that we should use for printing.
void	setFontSize(int fontSize) Sets the font size to use for printing.
void	setPrintColors(boolean printColors) Sets whether to print foreground colors in the output.
void	setPrintFileHeader(boolean printFileHeader) Sets whether we should print out a file header on the top displaying the name of the file.
void	setPrintFontStyles(boolean printFontStyles) Sets whether to print font styles in the output.
void	setPrintLineNumbers(int printLineNumbers) Sets whether we are printing line numbers in the output - we currently support only LINE_NUMBERS_NONE and LINE_NUMBERS_EVERY.
void	setPrintPageNumbers(boolean printPageNumbers) Sets whether we are printing out page numbers in the output.
void	setWrapBehavior(int wrapBehavior) Sets the wrapping behavior.
void	setWrapSymbol(java.lang.String wrapSymbol) Sets the new wrap symbol to print in the right margin for wrapped lines.

Methods inherited from class java.lang.Object

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

Field Detail

WRAP_NONE

public static final int WRAP_NONE

Constant indicating that we should not perform any line wrappings. Long lines will be truncated at the page edge.

See Also:

Constant Field Values

WRAP_FILL_WIDTH

public static final int WRAP_FILL_WIDTH

Constant indicating we should do basic wrapping - long lines will be wrapped when it reaches the page edge.

See Also:

Constant Field Values

LINE_NUMBERS_NONE

public static final int LINE_NUMBERS_NONE

Constant indicating we should not print out line numbers.

See Also:

Constant Field Values

LINE_NUMBERS_EVERY

public static final int LINE_NUMBERS_EVERY

Constant indicating we should print out line numbers for every buffer line (but not for subsequent lines of a wrapped buffer line.)

See Also:

Constant Field Values

Constructor Detail

PrintOptions

public PrintOptions()

Construct a new PrintOptions with default option values.

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Copies the internal state of this object to the specified copy.

Parameters:

target - the target to copy our state to

clone

public java.lang.Object clone()

Creates a duplicate copy of this option class.

Returns:

a duplicate copy of this instance.

getPrintColors

public boolean getPrintColors()

Fetch whether we are printing foreground colors in the output.

Returns:

whether we are printing foreground colors in the output

setPrintColors

public void setPrintColors(boolean printColors)

Sets whether to print foreground colors in the output.

Parameters:

printColors - whether to print foreground colors in the output

getPrintFontStyles

public boolean getPrintFontStyles()

Fetch whether we are printing the font styles in the output.

Returns:

whether we are printing the font styles in the output

setPrintFontStyles

public void setPrintFontStyles(boolean printFontStyles)

Sets whether to print font styles in the output.

Parameters:

printFontStyles - whether to print font styles in the output

getWrapBehavior

public int getWrapBehavior()

Fetch the current wrapping behavior.

Returns:

the current wrapping behavior

setWrapBehavior

public void setWrapBehavior(int wrapBehavior)

Sets the wrapping behavior. Currently, only WRAP_NONE and WRAP_FILL_WIDTH are supported.

Parameters:

wrapBehavior - the new wrapping behavior

getWrapSymbol

public java.lang.String getWrapSymbol()

Fetch the wrap symbol to print in the right margin for wrapped lines.

Returns:

the wrap symbol to print

setWrapSymbol

public void setWrapSymbol(java.lang.String wrapSymbol)

Sets the new wrap symbol to print in the right margin for wrapped lines.

Parameters:

wrapSymbol - the wrap symbol to print

getPrintLineNumbers

public int getPrintLineNumbers()

Fetch whether we are printing line numbers in the output.

setPrintLineNumbers

public void setPrintLineNumbers(int printLineNumbers)

Sets whether we are printing line numbers in the output - we currently support only LINE_NUMBERS_NONE and LINE_NUMBERS_EVERY.

Parameters:

printLineNumbers - whether we should print line numbers in the output

getPrintPageNumbers

public boolean getPrintPageNumbers()

Gets whether we are printing out page numbers in the upper right-hand of the output.

Returns:

whether we are printing out page numbers

setPrintPageNumbers

public void setPrintPageNumbers(boolean printPageNumbers)

Sets whether we are printing out page numbers in the output.

Parameters:

printPageNumbers - whether we should print out page numbers

getPrintFileHeader

public boolean getPrintFileHeader()

Fetch whether we should print out a file header on the top displaying the name of the file.

Returns:

whether we should print out a file header on the top

setPrintFileHeader

public void setPrintFileHeader(boolean printFileHeader)

Sets whether we should print out a file header on the top displaying the name of the file.

Parameters:

printFileHeader - whether we should print out a file header

getFontFamily

public java.lang.String getFontFamily()

Retrieve the font family of the font to use for printing.

Returns:

the font family for printing

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Sets the font family that we should use for printing.

Parameters:

fontFamily - the font family to use for printing

getFontSize

public int getFontSize()

Fetches the font size to use for printing.

Returns:

the font size to use for printing

setFontSize

public void setFontSize(int fontSize)

Sets the font size to use for printing.

Parameters:

fontSize - the font size to use for printing