Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.w3c.tidy.Tidy
public class Tidy
extends java.lang.Object
implements Serializable
Constructor Summary | |
|
Method Summary | |
static org.w3c.dom.Document |
|
String |
|
boolean |
|
boolean |
|
boolean |
|
Configuration |
|
String |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
PrintWriter |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
String | |
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
int |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
int |
|
boolean |
|
int |
|
boolean |
|
boolean |
|
int |
|
PrintWriter | |
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
static void |
|
protected int |
|
Node |
|
Node |
|
Node |
|
Node |
|
org.w3c.dom.Document |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public Tidy()
Instantiates a new Tidy instance. It's reccomended that a new instance is used at each parsing.
public static org.w3c.dom.Document createEmptyDocument()
Creates an empty DOM Document.
- Returns:
- a new org.w3c.dom.Document
public String getAltText()
alt-text
- default text for alt attribute.
- Returns:
- default text for alt attribute
- See Also:
Configuration.altText
public boolean getAsciiChars()
ascii-chars
- convert quotes and dashes to nearest ASCII char.
- Returns:
- true if tidy will convert quotes and dashes to nearest ASCII char
public boolean getBreakBeforeBR()
break-before-br - output newline before <br>.
- Returns:
true
if tidy will output a newline before <br>
- See Also:
Configuration.breakBeforeBR
public boolean getBurstSlides()
split
- create slides on each h2 element.
- Returns:
true
if tidy will create slides on each h2 element
- See Also:
Configuration.burstSlides
public Configuration getConfiguration()
Returns the actual configuration
- Returns:
- tidy configuration
public String getDocType()
doctype
- user specified doctype.
- Returns:
omit | auto | strict | loose | fpi
where the fpi is a string similar to "-//ACME//DTD HTML 3.14159//EN" Note: for fpi include the double-quotes in the string.
public boolean getDropEmptyParas()
drop-empty-paras
- discard empty p elements.
- Returns:
true
if tidy will discard empty p elements
- See Also:
Configuration.dropEmptyParas
public boolean getDropFontTags()
drop-font-tags
- discard presentation tags.
- Returns:
true
if tidy will discard presentation tags
- See Also:
Configuration.dropFontTags
public boolean getDropProprietaryAttributes()
drop-proprietary-attributes
- discard proprietary attributes.
- Returns:
true
if tidy will discard proprietary attributes
public boolean getEmacs()
gnu-emacs
- if true format error output for GNU Emacs.
- Returns:
true
if tidy will format error output for GNU Emacs
- See Also:
Configuration.emacs
public boolean getEncloseBlockText()
enclose-block-text
- if true text in blocks is wrapped in <p>'s. returntrue
if tidy should will text text in blocks in <p>'s.
- See Also:
Configuration.encloseBlockText
public boolean getEncloseText()
enclose-text
- if true text at body is wrapped in <p>'s.
- Returns:
true
if tidy will wrap text at body in <p>'s.
- See Also:
Configuration.encloseBodyText
public String getErrfile()
Errfile - file name to write errors to.
- Returns:
- error file name
- See Also:
Configuration.errfile
public PrintWriter getErrout()
Errout - the error output stream.
- Returns:
- error output stream.
public boolean getEscapeCdata()
escape-cdata
-replace CDATA sections with escaped text.
- Returns:
- true if tidy will replace CDATA sections with escaped text
public boolean getFixBackslash()
fix-backslash
- fix URLs by replacing \ with /.
- Returns:
true
if tidy will fix URLs by replacing \ with /
- See Also:
Configuration.fixBackslash
public boolean getFixComments()
fix-bad-comments
- fix comments with adjacent hyphens.
- Returns:
true
if tidy will fix comments with adjacent hyphens
- See Also:
Configuration.fixComments
public boolean getFixUri()
fix-uri
- output BODY content only.
- Returns:
- true if tidy will fix uri references
public boolean getForceOutput()
force-output
- output document even if errors were found.
- Returns:
- true if tidy will output document even if errors were found
public boolean getHideComments()
hide-comments
- hides all (real) comments in output.
- Returns:
- true if tidy will hide all comments in output
public boolean getHideEndTags()
hide-endtags - suppress optional end tags.
- Returns:
true
if tidy will suppress optional end tags
- See Also:
Configuration.hideEndTags
public boolean getIndentAttributes()
indent-attributes
- newline+indent before each attribute.
- Returns:
true
if tidy will output a newline+indent before each attribute
- See Also:
Configuration.indentAttributes
public boolean getIndentCdata()
indent-cdata
- indent CDATA sections.
- Returns:
- true if tidy will indent CDATA sections
public boolean getIndentContent()
indent - indent content of appropriate tags.
- Returns:
true
if tidy will indent content of appropriate tags
- See Also:
Configuration.indentContent
public String getInputEncoding()
input-encoding
the character encoding used for input.
- Returns:
- the java name of the encoding currently used for input
public String getInputStreamName()
public boolean getJoinClasses()
join-classes
- join multiple class attributes.
- Returns:
- true if tidy will join multiple class attributes
public boolean getJoinStyles()
join-styles
- join multiple style attributes.
- Returns:
- true if tidy will join multiple style attributes
public boolean getKeepFileTimes()
keep-time
- if true last modified time is preserved.
- Returns:
true
if tidy will preserved last modified time in input file.
- See Also:
Configuration.keepFileTimes
public boolean getLiteralAttribs()
literal-attributes
- if true attributes may use newlines.
- Returns:
true
if attributes may use newlines
- See Also:
Configuration.literalAttribs
public boolean getLogicalEmphasis()
logical-emphasis
- replace i by em and b by strong.
- Returns:
true
if tidy will replace i by em and b by strong
- See Also:
Configuration.logicalEmphasis
public boolean getLowerLiterals()
lower-literals
- folds known attribute values to lower case.
- Returns:
- true if tidy will folds known attribute values to lower case
public boolean getMakeBare()
make-clean - remove Microsoft cruft.
- Returns:
- true if tidy will remove Microsoft cruft
- See Also:
Configuration.makeBare
public boolean getMakeClean()
make-clean - remove presentational clutter.
- Returns:
- true if tidy will remove presentational clutter
- See Also:
Configuration.makeClean
public boolean getNumEntities()
numeric-entities
- output entities other than the built-in HTML entities in the numeric rather than the named entity form.
- Returns:
true
if tidy will output entities in the numeric form.
- See Also:
Configuration.numEntities
public boolean getOnlyErrors()
only-errors - if true normal output is suppressed.
- Returns:
true
if normal output is suppressed.
- See Also:
Configuration.onlyErrors
public String getOutputEncoding()
output-encoding
the character encoding used for output.
- Returns:
- the java name of the encoding currently used for output
public int getParseErrors()
ParseErrors - the number of errors that occurred in the most recent parse operation.
- Returns:
- number of errors that occurred in the most recent parse operation.
public int getParseWarnings()
ParseWarnings - the number of warnings that occurred in the most recent parse operation.
- Returns:
- number of warnings that occurred in the most recent parse operation.
public boolean getPrintBodyOnly()
print-body-only
- output BODY content only.
- Returns:
- true if tidy will print only the document body
public boolean getQuiet()
quiet - no 'Parsing X', guessed DTD or summary.
- Returns:
true
if tidy will not output summary, warnings or errors
- See Also:
Configuration.quiet
public boolean getQuoteAmpersand()
quote-ampersand
- output naked ampersand as &.
- Returns:
true
if tidy will output naked ampersand as &
- See Also:
Configuration.quoteAmpersand
public boolean getQuoteMarks()
quote-marks
- output " marks as ".
- Returns:
true
if tidy will output " marks as "
- See Also:
Configuration.quoteMarks
public boolean getQuoteNbsp()
quote-nbsp
- output non-breaking space as entity.
- Returns:
true
if tidy will output non-breaking space as entity
- See Also:
Configuration.quoteNbsp
public boolean getRawOut()
output-raw
- avoid mapping values > 127 to entities.
- Returns:
true
if tidy will not map values > 127 to entities
- See Also:
Configuration.rawOut
public int getRepeatedAttributes()
repeated-attributes
- keep first or last duplicate attribute.
- Returns:
Configuration.KEEP_FIRST | Configuration.KEEP_LAST
public boolean getReplaceColor()
replace-color
- replace hex color attribute values with names.
- Returns:
- true if tidy will replace hex color attribute values with names
public int getShowErrors()
show-errors
- number of errors to put out.
- Returns:
- the number of errors tidy will put out
public boolean getShowWarnings()
show-warnings - show warnings? (errors are always shown).
- Returns:
false
if warnings are not shown
- See Also:
Configuration.showWarnings
public boolean getSmartIndent()
SmartIndent - does text/block level content effect indentation.
- Returns:
true
if text/block level content should effect indentation
- See Also:
Configuration.smartIndent
public int getSpaces()
indent-spaces
- default indentation.
- Returns:
- number of spaces used for indentation
- See Also:
Configuration.spaces
public PrintWriter getStderr()
public int getTabsize()
tab-size
- tab size in chars.
- Returns:
- tab size in chars
- See Also:
Configuration.tabsize
public boolean getTidyMark()
tidy-mark
- add meta element indicating tidied doc.
- Returns:
true
if tidy will add meta element indicating tidied doc
- See Also:
Configuration.tidyMark
public boolean getTrimEmptyElements()
trim-empty-elements
- trim empty elements.
- Returns:
- true if tidy will trim empty elements
public boolean getUpperCaseAttrs()
uppercase-attributes - output attributes in upper case.
- Returns:
true
if tidy should will attributes in upper case
- See Also:
Configuration.upperCaseAttrs
public boolean getUpperCaseTags()
uppercase-tags - output tags in upper case.
- Returns:
true
if tidy should will tags in upper case
- See Also:
Configuration.upperCaseTags
public boolean getWord2000()
word-2000
- draconian cleaning for Word2000.
- Returns:
true
if tidy will clean word2000 documents
- See Also:
Configuration.word2000
public boolean getWrapAsp()
wrap-asp
- wrap within ASP pseudo elements.
- Returns:
true
if tidy will wrap within ASP pseudo elements
- See Also:
Configuration.wrapAsp
public boolean getWrapAttVals()
wrap-attributes
- wrap within attribute values.
- Returns:
true
if tidy will wrap within attribute values
- See Also:
Configuration.wrapAttVals
public boolean getWrapJste()
wrap-jste
- wrap within JSTE pseudo elements.
- Returns:
true
if tidy will wrap within JSTE pseudo elements
- See Also:
Configuration.wrapJste
public boolean getWrapPhp()
wrap-php
- wrap within PHP pseudo elements.
- Returns:
true
if tidy will wrap within PHP pseudo elements
- See Also:
Configuration.wrapPhp
public boolean getWrapScriptlets()
wrap-script-literals
- wrap within JavaScript string literals.
- Returns:
true
if tidy will wrap within JavaScript string literals
- See Also:
Configuration.wrapScriptlets
public boolean getWrapSection()
wrap-sections
- wrap within <![ ... ]> section tags
- Returns:
true
if tidy will wrap within <![ ... ]> section tags
- See Also:
Configuration.wrapSection
public int getWraplen()
wrap
- default wrap margin.
- Returns:
- default wrap margin
- See Also:
Configuration.wraplen
public boolean getWriteback()
writeback - if true then output tidied markup. NOTE: this property is ignored when parsing from an InputStream.
- Returns:
true
if tidy will output tidied markup in input file
- See Also:
Configuration.writeback
public boolean getXHTML()
output-xhtml - output extensible HTML.
- Returns:
true
if tidy will output XHTML
- See Also:
Configuration.xHTML
public boolean getXmlOut()
output-xml - create output as XML.
- Returns:
true
if tidy will create output as xml
- See Also:
Configuration.xmlOut
public boolean getXmlPIs()
assume-xml-procins
This option specifies if Tidy should change the parsing of processing instructions to require ?> as the terminator rather than >. This option is automatically set if the input is in XML.
- Returns:
true
if tidy will expect a ?> at the end of processing instructions
- See Also:
Configuration.xmlPIs
public boolean getXmlPi()
add-xml-pi
- add <?xml?> for XML docs.
- Returns:
true
if tidy will add <?xml?> for XML docs
- See Also:
Configuration.xmlPi
public boolean getXmlSpace()
add-xml-space
- if set to yes adds xml:space attr as needed.
- Returns:
true
if tidy will add xml:space attr as needed
- See Also:
Configuration.xmlSpace
public boolean getXmlTags()
input-xml - treat input as XML.
- Returns:
true
if tidy will treat input as XML
- See Also:
Configuration.xmlTags
public static void main(String[] argv)
Command line interface to parser and pretty printer.
- Parameters:
argv
- command line parameters
protected int mainExec(String[] argv)
Main method, but returns the return code as an int instead of calling System.exit(code). Needed for testing main method without shutting down tests.
- Parameters:
argv
- command line parameters
- Returns:
- return code
public Node parse(InputStream in, OutputStream out)
Reads from the given input and returns the root Node. If out is non-null, pretty prints to out. Warning: caller is responsible for calling close() on input and output after calling this method.
- Parameters:
in
- inputout
- optional destination for pretty-printed document
- Returns:
- parsed org.w3c.tidy.Node
public Node parse(InputStream in, Writer out)
Reads from the given input and returns the root Node. If out is non-null, pretty prints to out. Warning: caller is responsible for calling close() on input and output after calling this method.
- Parameters:
in
- inputout
- optional destination for pretty-printed document
- Returns:
- parsed org.w3c.tidy.Node
public Node parse(Reader in, OutputStream out)
Reads from the given input and returns the root Node. If out is non-null, pretty prints to out. Warning: caller is responsible for calling close() on input and output after calling this method.
- Parameters:
in
- inputout
- optional destination for pretty-printed document
- Returns:
- parsed org.w3c.tidy.Node
public Node parse(Reader in, Writer out)
Reads from the given input and returns the root Node. If out is non-null, pretty prints to out. Warning: caller is responsible for calling close() on input and output after calling this method.
- Parameters:
in
- inputout
- optional destination for pretty-printed document
- Returns:
- parsed org.w3c.tidy.Node
public org.w3c.dom.Document parseDOM(InputStream in, OutputStream out)
Parses InputStream in and returns a DOM Document node. If out is non-null, pretty prints to OutputStream out.
- Parameters:
in
- input streamout
- optional output stream
- Returns:
- parsed org.w3c.dom.Document
public void pprint(org.w3c.dom.Document doc, OutputStream out)
Pretty-prints a DOM Document. Must be an instance of org.w3c.tidy.DOMDocumentImpl. Caller is responsible for closing the outputStream after calling this method.
- Parameters:
doc
- org.w3c.dom.Documentout
- output stream
public void pprint(org.w3c.dom.Node node, OutputStream out)
Pretty-prints a DOM Node. Caller is responsible for closing the outputStream after calling this method.
- Parameters:
node
- org.w3c.dom.Node. Must be an instance of org.w3c.tidy.DOMNodeImpl.out
- output stream
public void setAltText(String altText)
alt-text
- default text for alt attribute.
- Parameters:
altText
- default text for alt attribute
- See Also:
Configuration.altText
public void setAsciiChars(boolean asciiChars)
ascii-chars
- convert quotes and dashes to nearest ASCII char.
- Parameters:
asciiChars
- true = convert quotes and dashes to nearest ASCII char
- See Also:
Configuration.asciiChars
public void setBreakBeforeBR(boolean breakBeforeBR)
break-before-br - output newline before <br>.
- Parameters:
breakBeforeBR
-true
if tidy should output a newline before <br>
- See Also:
Configuration.breakBeforeBR
public void setBurstSlides(boolean burstSlides)
split
- create slides on each h2 element.
- Parameters:
burstSlides
-true
if tidy should create slides on each h2 element
- See Also:
Configuration.burstSlides
public void setConfigurationFromFile(String filename)
Sets the configuration from a configuration file.
- Parameters:
filename
- configuration file name/path.
public void setConfigurationFromProps(Properties props)
Sets the configuration from a properties object.
- Parameters:
props
- Properties object
public void setDocType(String doctype)
doctype
- user specified doctype.
- Parameters:
doctype
-omit | auto | strict | loose | fpi
where the fpi is a string similar to "-//ACME//DTD HTML 3.14159//EN" Note: for fpi include the double-quotes in the string.
public void setDropEmptyParas(boolean dropEmptyParas)
drop-empty-paras
- discard empty p elements.
- Parameters:
dropEmptyParas
-true
if tidy should discard empty p elements
- See Also:
Configuration.dropEmptyParas
public void setDropFontTags(boolean dropFontTags)
drop-font-tags
- discard presentation tags.
- Parameters:
dropFontTags
-true
if tidy should discard presentation tags
- See Also:
Configuration.dropFontTags
public void setDropProprietaryAttributes(boolean dropProprietaryAttributes)
drop-proprietary-attributes
- discard proprietary attributes.
- Parameters:
dropProprietaryAttributes
-true
if tidy should discard proprietary attributes
public void setEmacs(boolean emacs)
gnu-emacs
- if true format error output for GNU Emacs.
- Parameters:
emacs
-true
if tidy should format error output for GNU Emacs
- See Also:
Configuration.emacs
public void setEncloseBlockText(boolean encloseBlockText)
enclose-block-text
- if true text in blocks is wrapped in <p>'s.
- Parameters:
encloseBlockText
-true
if tidy should wrap text text in blocks in <p>'s.
- See Also:
Configuration.encloseBlockText
public void setEncloseText(boolean encloseText)
enclose-text
- if true text at body is wrapped in <p>'s.
- Parameters:
encloseText
-true
if tidy should wrap text at body in <p>'s.
- See Also:
Configuration.encloseBodyText
public void setErrfile(String errfile)
Errfile - file name to write errors to.
- Parameters:
errfile
- file name to write errors to
- See Also:
Configuration.errfile
public void setErrout(PrintWriter out)
public void setEscapeCdata(boolean escapeCdata)
escape-cdata
- replace CDATA sections with escaped text.
- Parameters:
escapeCdata
- true = replace CDATA sections with escaped text
- See Also:
Configuration.escapeCdata
public void setFixBackslash(boolean fixBackslash)
fix-backslash
- fix URLs by replacing \ with /.
- Parameters:
fixBackslash
-true
if tidy should fix URLs by replacing \ with /
- See Also:
Configuration.fixBackslash
public void setFixComments(boolean fixComments)
fix-bad-comments
- fix comments with adjacent hyphens.
- Parameters:
fixComments
-true
if tidy should fix comments with adjacent hyphens
- See Also:
Configuration.fixComments
public void setFixUri(boolean fixUri)
fix-uri
- fix uri references applying URI encoding if necessary.
- Parameters:
fixUri
- true = fix uri references
- See Also:
Configuration.fixUri
public void setForceOutput(boolean forceOutput)
force-output
- output document even if errors were found.
- Parameters:
forceOutput
- true = output document even if errors were found
- See Also:
Configuration.forceOutput
public void setHideComments(boolean hideComments)
hide-comments
- hides all (real) comments in output.
- Parameters:
hideComments
- true = hides all comments in output
- See Also:
Configuration.hideComments
public void setHideEndTags(boolean hideEndTags)
hide-endtags - suppress optional end tags.
- Parameters:
hideEndTags
-true
= suppress optional end tags
- See Also:
Configuration.hideEndTags
public void setIndentAttributes(boolean indentAttributes)
indent-attributes
- newline+indent before each attribute.
- Parameters:
indentAttributes
-true
if tidy should output a newline+indent before each attribute
- See Also:
Configuration.indentAttributes
public void setIndentCdata(boolean indentCdata)
indent-cdata
- indent CDATA sections.
- Parameters:
indentCdata
- true = indent CDATA sections
- See Also:
Configuration.indentCdata
public void setIndentContent(boolean indentContent)
indent - indent content of appropriate tags.
- Parameters:
indentContent
- indent content of appropriate tags
- See Also:
Configuration.indentContent
public void setInputEncoding(String encoding)
input-encoding
the character encoding used for input.
- Parameters:
encoding
- a valid java encoding name
public void setInputStreamName(String name)
InputStreamName - the name of the input stream (printed in the header information).
- Parameters:
name
- input stream name
public void setJoinClasses(boolean joinClasses)
join-classes
- join multiple class attributes.
- Parameters:
joinClasses
- true = join multiple class attributes
- See Also:
Configuration.joinClasses
public void setJoinStyles(boolean joinStyles)
join-styles
- join multiple style attributes.
- Parameters:
joinStyles
- true = join multiple style attributes
- See Also:
Configuration.joinStyles
public void setKeepFileTimes(boolean keepFileTimes)
keep-time
- if true last modified time is preserved.
- Parameters:
keepFileTimes
-true
if tidy should preserved last modified time in input file.
- See Also:
Configuration.keepFileTimes
public void setLiteralAttribs(boolean literalAttribs)
literal-attributes
- if true attributes may use newlines.
- Parameters:
literalAttribs
-true
if attributes may use newlines
- See Also:
Configuration.literalAttribs
public void setLogicalEmphasis(boolean logicalEmphasis)
logical-emphasis
- replace i by em and b by strong.
- Parameters:
logicalEmphasis
-true
if tidy should replace i by em and b by strong
- See Also:
Configuration.logicalEmphasis
public void setLowerLiterals(boolean lowerLiterals)
lower-literals
- folds known attribute values to lower case.
- Parameters:
lowerLiterals
- true = folds known attribute values to lower case
- See Also:
Configuration.lowerLiterals
public void setMakeBare(boolean makeBare)
make-bare - remove Microsoft cruft.
- Parameters:
makeBare
- true to remove Microsoft cruft
- See Also:
Configuration.makeBare
public void setMakeClean(boolean makeClean)
make-clean - remove presentational clutter.
- Parameters:
makeClean
- true to remove presentational clutter
- See Also:
Configuration.makeClean
public void setMessageListener(TidyMessageListener listener)
Attach a TidyMessageListener which will be notified for messages and errors.
- Parameters:
listener
- TidyMessageListener implementation
public void setNumEntities(boolean numEntities)
numeric-entities
- output entities other than the built-in HTML entities in the numeric rather than the named entity form.
- Parameters:
numEntities
-true
if tidy should output entities in the numeric form.
- See Also:
Configuration.numEntities
public void setOnlyErrors(boolean onlyErrors)
only-errors - if true normal output is suppressed.
- Parameters:
onlyErrors
- iftrue
normal output is suppressed.
- See Also:
Configuration.onlyErrors
public void setOutputEncoding(String encoding)
output-encoding
the character encoding used for output.
- Parameters:
encoding
- a valid java encoding name
public void setPrintBodyOnly(boolean bodyOnly)
print-body-only
- output BODY content only.
- Parameters:
bodyOnly
- true = print only the document body
- See Also:
Configuration.bodyOnly
public void setQuiet(boolean quiet)
quiet - no 'Parsing X', guessed DTD or summary.
- Parameters:
quiet
-true
= don't output summary, warnings or errors
- See Also:
Configuration.quiet
public void setQuoteAmpersand(boolean quoteAmpersand)
quote-ampersand
- output naked ampersand as &.
- Parameters:
quoteAmpersand
-true
if tidy should output naked ampersand as &
- See Also:
Configuration.quoteAmpersand
public void setQuoteMarks(boolean quoteMarks)
quote-marks
- output " marks as ".
- Parameters:
quoteMarks
-true
if tidy should output " marks as "
- See Also:
Configuration.quoteMarks
public void setQuoteNbsp(boolean quoteNbsp)
quote-nbsp
- output non-breaking space as entity.
- Parameters:
quoteNbsp
-true
if tidy should output non-breaking space as entity
- See Also:
Configuration.quoteNbsp
public void setRawOut(boolean rawOut)
output-raw
- avoid mapping values > 127 to entities. This has the same effect of specifying a "raw" encoding in the original version of tidy.
- Parameters:
rawOut
- avoid mapping values > 127 to entities
- See Also:
Configuration.rawOut
public void setRepeatedAttributes(int repeatedAttributes)
repeated-attributes
- keep first or last duplicate attribute.
- Parameters:
repeatedAttributes
-Configuration.KEEP_FIRST | Configuration.KEEP_LAST
- See Also:
Configuration.duplicateAttrs
public void setReplaceColor(boolean replaceColor)
replace-color
- replace hex color attribute values with names.
- Parameters:
replaceColor
- true = replace hex color attribute values with names
- See Also:
Configuration.replaceColor
public void setShowErrors(int showErrors)
show-errors
- set the number of errors to put out.
- Parameters:
showErrors
- number of errors to put out
- See Also:
Configuration.showErrors
public void setShowWarnings(boolean showWarnings)
show-warnings - show warnings? (errors are always shown).
- Parameters:
showWarnings
- iffalse
warnings are not shown
- See Also:
Configuration.showWarnings
public void setSmartIndent(boolean smartIndent)
SmartIndent - does text/block level content effect indentation.
- Parameters:
smartIndent
-true
if text/block level content should effect indentation
- See Also:
Configuration.smartIndent
public void setSpaces(int spaces)
indent-spaces
- default indentation.
- Parameters:
spaces
- number of spaces used for indentation
- See Also:
Configuration.spaces
public void setTabsize(int tabsize)
tab-size
- tab size in chars.
- Parameters:
tabsize
- tab size in chars
- See Also:
Configuration.tabsize
public void setTidyMark(boolean tidyMark)
tidy-mark
- add meta element indicating tidied doc.
- Parameters:
tidyMark
-true
if tidy should add meta element indicating tidied doc
- See Also:
Configuration.tidyMark
public void setTrimEmptyElements(boolean trimEmpty)
trim-empty-elements
- trim empty elements.
- Parameters:
- See Also:
Configuration.trimEmpty
public void setUpperCaseAttrs(boolean upperCaseAttrs)
uppercase-attributes - output attributes in upper case.
- Parameters:
upperCaseAttrs
-true
if tidy should output attributes in upper case (default is lowercase)
- See Also:
Configuration.upperCaseAttrs
public void setUpperCaseTags(boolean upperCaseTags)
uppercase-tags - output tags in upper case.
- Parameters:
upperCaseTags
-true
if tidy should output tags in upper case (default is lowercase)
- See Also:
Configuration.upperCaseTags
public void setWord2000(boolean word2000)
word-2000
- draconian cleaning for Word2000.
- Parameters:
word2000
-true
if tidy should clean word2000 documents
- See Also:
Configuration.word2000
public void setWrapAsp(boolean wrapAsp)
wrap-asp
- wrap within ASP pseudo elements.
- Parameters:
wrapAsp
-true
if tidy should wrap within ASP pseudo elements
- See Also:
Configuration.wrapAsp
public void setWrapAttVals(boolean wrapAttVals)
wrap-attributes
- wrap within attribute values.
- Parameters:
wrapAttVals
-true
if tidy should wrap within attribute values
- See Also:
Configuration.wrapAttVals
public void setWrapJste(boolean wrapJste)
wrap-jste
- wrap within JSTE pseudo elements.
- Parameters:
wrapJste
-true
if tidy should wrap within JSTE pseudo elements
- See Also:
Configuration.wrapJste
public void setWrapPhp(boolean wrapPhp)
wrap-php
- wrap within PHP pseudo elements.
- Parameters:
wrapPhp
-true
if tidy should wrap within PHP pseudo elements
- See Also:
Configuration.wrapPhp
public void setWrapScriptlets(boolean wrapScriptlets)
wrap-script-literals
- wrap within JavaScript string literals.
- Parameters:
wrapScriptlets
-true
if tidy should wrap within JavaScript string literals
- See Also:
Configuration.wrapScriptlets
public void setWrapSection(boolean wrapSection)
wrap-sections
- wrap within <![ ... ]> section tags
- Parameters:
wrapSection
-true
if tidy should wrap within <![ ... ]> section tags
- See Also:
Configuration.wrapSection
public void setWraplen(int wraplen)
wrap
- default wrap margin.
- Parameters:
wraplen
- default wrap margin
- See Also:
Configuration.wraplen
public void setWriteback(boolean writeback)
writeback - if true then output tidied markup. NOTE: this property is ignored when parsing from an InputStream.
- Parameters:
writeback
-true
= output tidied markup
- See Also:
Configuration.writeback
public void setXHTML(boolean xhtml)
output-xhtml - output extensible HTML.
- Parameters:
xhtml
-true
if tidy should output XHTML
- See Also:
Configuration.xHTML
public void setXmlOut(boolean xmlOut)
output-xml - create output as XML.
- Parameters:
xmlOut
-true
if tidy should create output as xml
- See Also:
Configuration.xmlOut
public void setXmlPIs(boolean xmlPIs)
assume-xml-procins
This option specifies if Tidy should change the parsing of processing instructions to require ?> as the terminator rather than >. This option is automatically set if the input is in XML.
- Parameters:
xmlPIs
-true
if tidy should expect a ?> at the end of processing instructions
- See Also:
Configuration.xmlPIs
public void setXmlPi(boolean xmlPi)
add-xml-pi
- add <?xml?> for XML docs.
- Parameters:
xmlPi
-true
if tidy should add <?xml?> for XML docs
- See Also:
Configuration.xmlPi
public void setXmlSpace(boolean xmlSpace)
add-xml-space
- if set to yes adds xml:space attr as needed.
- Parameters:
xmlSpace
-true
if tidy should add xml:space attr as needed
- See Also:
Configuration.xmlSpace
public void setXmlTags(boolean xmlTags)
input-xml - treat input as XML.
- Parameters:
xmlTags
-true
if tidy should treat input as XML
- See Also:
Configuration.xmlTags