public class HTMLGeneratorOptions extends HashStructureAdapter implements Copyable
HTMLGeneratorOptions
defines various options for
generation of HTML output, from a BasicDocument, that is currently
supported by the DocumentToHTMLGenerator
implementation.Modifier and Type | Field and Description |
---|---|
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.
|
_hash
Constructor and Description |
---|
HTMLGeneratorOptions()
Construct a new
HTMLGeneratorOptions with default
option values. |
HTMLGeneratorOptions(HashStructure hash) |
Modifier and Type | Method and Description |
---|---|
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.
|
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
public static final int WRAP_NONE
public static final int WRAP_FILL_WIDTH
public static final int LINE_NUMBERS_NONE
public static final int LINE_NUMBERS_EVERY
public HTMLGeneratorOptions()
HTMLGeneratorOptions
with default
option values.public HTMLGeneratorOptions(HashStructure hash)
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String getCharsetEncoding()
public void setCharsetEncoding(java.lang.String charsetEncoding)
charsetEncoding
- the charset encoding to use for HTML generationpublic boolean getPrintColors()
public void setPrintColors(boolean printColors)
printColors
- whether to print foreground and background colors
in the outputpublic boolean getPrintFontStyles()
public void setPrintFontStyles(boolean printFontStyles)
printFontStyles
- whether to print font styles in the outputpublic int getWrapBehavior()
public void setWrapBehavior(int wrapBehavior)
wrapBehavior
- the new wrapping behaviorpublic int getWrapColumn()
public void setWrapColumn(int wrapColumn)
wrapColumn
- the new wrapping columnpublic java.lang.String getWrapSymbol()
public void setWrapSymbol(java.lang.String wrapSymbol)
wrapSymbol
- the wrap symbol to printpublic boolean getUseAnchors()
public void setUseAnchors(boolean useAnchors)
useAnchors
- whether we should use anchorspublic boolean getUseHyperlinks()
public void setUseHyperlinks(boolean useHyperlinks)
useHyperlinks
- whether we should use hyperlinkspublic int getPrintLineNumbers()
public void setPrintLineNumbers(int printLineNumbers)
printLineNumbers
- whether we should print line numbers in
the outputpublic boolean getPrintFileHeader()
public void setPrintFileHeader(boolean printFileHeader)
printFileHeader
- whether we should print out a file headerpublic boolean getPrintTimeStamp()
public void setPrintTimeStamp(boolean printTimeStamp)
printTimeStamp
- whether we should print a date/time stamp
in the file headerpublic boolean getUseFontInfo()
public void setUseFontInfo(boolean useFontInfo)
useFontInfo
- whether the HTML output should include font infopublic java.lang.String getFontFamily()
public void setFontFamily(java.lang.String fontFamily)
fontFamily
- the font family to use for printingpublic int getFontSize()
public void setFontSize(int fontSize)
fontSize
- the font size to use for printing