oracle.javatools.editor.print
Class HTMLGeneratorOptions

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.javatools.editor.print.HTMLGeneratorOptions

All Implemented Interfaces:

Copyable

public class HTMLGeneratorOptions
extends HashStructureAdapter
implements Copyable

The HTMLGeneratorOptions defines various options for generation of HTML output, from a BasicDocument, that is currently supported by the DocumentToHTMLGenerator 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.

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

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

HTMLGeneratorOptions(HashStructure hash)

Method Summary

java.lang.Object	clone() Creates a duplicate copy of this option class.
java.lang.String	getCharsetEncoding() Fetch the charset encoding to use for HTML generation.
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 and background 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	getPrintTimeStamp() Fetch whether we should print out a date/time stamp in the file header.
boolean	getUseAnchors() Fetch whether we should include anchors for each line of the document.
boolean	getUseFontInfo() Fetch whether the HTML output should include font family/size information.
boolean	getUseHyperlinks() Fetch whether we should include hyperlinks for source elements in the document.
int	getWrapBehavior() Fetch the current wrapping behavior.
int	getWrapColumn() Fetch the current column wrapping width.
java.lang.String	getWrapSymbol() Fetch the wrap symbol to print in the right margin for wrapped lines.
void	setCharsetEncoding(java.lang.String charsetEncoding) Sets the charset encoding to use for HTML generation.
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 and background 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	setPrintTimeStamp(boolean printTimeStamp) Sets whether we should print out a date/time stamp in the file header.
void	setUseAnchors(boolean useAnchors) Sets whether we should include anchors for each line of the document.
void	setUseFontInfo(boolean useFontInfo) Sets whether the HTML output should include font family/size information.
void	setUseHyperlinks(boolean useHyperlinks) Sets whether we should include hyperlinks for source elements in the document.
void	setWrapBehavior(int wrapBehavior) Sets the wrapping behavior.
void	setWrapColumn(int wrapColumn) Sets the wrapping column width.
void	setWrapSymbol(java.lang.String wrapSymbol) Sets the new wrap symbol to print in the right margin for wrapped lines.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.util.Copyable

copyTo

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

HTMLGeneratorOptions

public HTMLGeneratorOptions()

Construct a new HTMLGeneratorOptions with default option values.

HTMLGeneratorOptions

public HTMLGeneratorOptions(HashStructure hash)

Method Detail

clone

public java.lang.Object clone()

Creates a duplicate copy of this option class.

Overrides:

clone in class java.lang.Object

Returns:

a duplicate copy of this instance.

getCharsetEncoding

public java.lang.String getCharsetEncoding()

Fetch the charset encoding to use for HTML generation.

Returns:

the charset encoding to use for HTML generation

setCharsetEncoding

public void setCharsetEncoding(java.lang.String charsetEncoding)

Sets the charset encoding to use for HTML generation.

Parameters:

charsetEncoding - the charset encoding to use for HTML generation

getPrintColors

public boolean getPrintColors()

Fetch whether we are printing foreground and background colors in the output.

Returns:

whether we are printing foreground and background colors in the output

setPrintColors

public void setPrintColors(boolean printColors)

Sets whether to print foreground and background colors in the output.

Parameters:

printColors - whether to print foreground and background 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

getWrapColumn

public int getWrapColumn()

Fetch the current column wrapping width.

Returns:

the current wrapping column width

setWrapColumn

public void setWrapColumn(int wrapColumn)

Sets the wrapping column width.

Parameters:

wrapColumn - the new wrapping column

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

getUseAnchors

public boolean getUseAnchors()

Fetch whether we should include anchors for each line of the document.

Returns:

whether we should include anchors for each line

setUseAnchors

public void setUseAnchors(boolean useAnchors)

Sets whether we should include anchors for each line of the document.

Parameters:

useAnchors - whether we should use anchors

getUseHyperlinks

public boolean getUseHyperlinks()

Fetch whether we should include hyperlinks for source elements in the document.

Returns:

whether we should include anchors for each line

setUseHyperlinks

public void setUseHyperlinks(boolean useHyperlinks)

Sets whether we should include hyperlinks for source elements in the document.

Parameters:

useHyperlinks - whether we should use hyperlinks

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

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

getPrintTimeStamp

public boolean getPrintTimeStamp()

Fetch whether we should print out a date/time stamp in the file header. This is ignored if the file header is not displayed.

Returns:

whether we should print out a date/time stamp in the file header

setPrintTimeStamp

public void setPrintTimeStamp(boolean printTimeStamp)

Sets whether we should print out a date/time stamp in the file header. This is ignored if the file header is not displayed.

Parameters:

printTimeStamp - whether we should print a date/time stamp in the file header

getUseFontInfo

public boolean getUseFontInfo()

Fetch whether the HTML output should include font family/size information.

Returns:

whether the HTML output should include font info

setUseFontInfo

public void setUseFontInfo(boolean useFontInfo)

Sets whether the HTML output should include font family/size information.

Parameters:

useFontInfo - whether the HTML output should include font info

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