Java Doc for Configuration.java in  » HTML-Parser » JTidy » org » w3c » tidy » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » HTML Parser » JTidy » org.w3c.tidy 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.w3c.tidy.Configuration

Configuration
public class Configuration implements Serializable(Code)
Read configuration file and manage configuration properties. Configuration files associate a property name with a value. The format is that of a Java .properties file.
author:
   Dave Raggett dsr@w3.org
author:
   Andy Quick ac.quick@sympatico.ca (translation to Java)
author:
   Fabrizio Giustina
version:
   $Revision: 1.43 $ ($Author: fgiust $)

Inner Class :static class Flag implements Comparable

Field Summary
final public static  intASCII
     character encoding = ASCII.
final public static  intBIG5
     character encoding = BIG5.
final public static  intDOCTYPE_AUTO
     treatment of doctype: auto.
final public static  intDOCTYPE_LOOSE
     treatment of doctype: loose.
final public static  intDOCTYPE_OMIT
     treatment of doctype: omit.
final public static  intDOCTYPE_STRICT
     treatment of doctype: strict.
final public static  intDOCTYPE_USER
     treatment of doctype: user.
final public static  intISO2022
     character encoding = ISO2022.
final public static  intKEEP_FIRST
     Keep first duplicate attribute.
final public static  intKEEP_LAST
     Keep last duplicate attribute.
final public static  intLATIN1
     character encoding = LATIN1.
final public static  intMACROMAN
     character encoding = MACROMAN.
final public static  intRAW
     character encoding = RAW.
final public static  intSHIFTJIS
     character encoding = SHIFTJIS.
final public static  intUTF16
     character encoding = UTF16.
final public static  intUTF16BE
     character encoding = UTF16BE.
final public static  intUTF16LE
     character encoding = UTF16LE.
final public static  intUTF8
     character encoding = UTF8.
final public static  intWIN1252
     character encoding = WIN1252.
protected  StringaltText
     default text for alt attribute.
protected  booleanasciiChars
     convert quotes and dashes to nearest ASCII char.
protected  booleanbodyOnly
     output BODY content only.
protected  booleanbreakBeforeBR
    
protected  booleanburstSlides
     create slides on each h2 element.
protected  StringcssPrefix
     CSS class naming for -clean option.
protected  intdefinedTags
     track what types of tags user has defined to eliminate unnecessary searches.
protected  intdocTypeMode
     see doctype property.
protected  StringdocTypeStr
     user specified doctype.
protected  booleandropEmptyParas
     discard empty p elements.
protected  booleandropFontTags
     discard presentation tags.
protected  booleandropProprietaryAttributes
     discard proprietary attributes.
protected  intduplicateAttrs
     Keep first or last duplicate attribute.
protected  booleanemacs
     if true format error output for GNU Emacs.
protected  booleanencloseBlockText
     if yes text in blocks is wrapped in p's.
protected  booleanencloseBodyText
     if yes text at body is wrapped in p's.
protected  Stringerrfile
     file name to write errors to.
protected  booleanescapeCdata
     replace CDATA sections with escaped text.
protected  booleanfixBackslash
     fix URLs by replacing \ with /.
protected  booleanfixComments
     fix comments with adjacent hyphens.
protected  booleanfixUri
     properly escape URLs.
protected  booleanforceOutput
     output document even if errors were found.
protected  booleanhideComments
     hides all (real) comments in output.
protected  booleanhideEndTags
     suppress optional end tags.
protected  booleanhtmlOut
     output plain-old HTML, even for XHTML input.
protected  booleanindentAttributes
     newline+indent before each attribute.
protected  booleanindentCdata
     indent CDATA sections.
protected  booleanindentContent
     indent content of appropriate tags.
protected  booleanjoinClasses
     join multiple class attributes.
protected  booleanjoinStyles
     join multiple style attributes.
protected  booleankeepFileTimes
     if yes last modied time is preserved.
protected  Stringlanguage
     RJ language property.
protected  booleanliteralAttribs
     if true attributes may use newlines.
protected  booleanlogicalEmphasis
     replace i by em and b by strong.
protected  booleanlowerLiterals
     folds known attribute values to lower case.
protected  booleanmakeBare
     Make bare HTML: remove Microsoft cruft.
protected  booleanmakeClean
     remove presentational clutter.
protected  booleanncr
     allow numeric character references.
protected  char[]newline
     bytes for the newline marker.
protected  booleannumEntities
     use numeric entities.
protected  booleanonlyErrors
     if true normal output is suppressed.
protected  booleanquiet
     no 'Parsing X', guessed DTD or summary.
protected  booleanquoteAmpersand
     output naked ampersand as &.
protected  booleanquoteMarks
     output " marks as ".
protected  booleanquoteNbsp
     output non-breaking space as entity.
protected  booleanrawOut
     Avoid mapping values > 127 to entities.
protected  booleanreplaceColor
     replace hex color attribute values with names.
protected  intreplacementCharEncoding
     char encoding used when replacing illegal SGML chars, regardless of specified encoding.
protected  Reportreport
     Report instance.
protected  intshowErrors
     number of errors to put out.
protected  booleanshowWarnings
     however errors are always shown.
protected  Stringslidestyle
     style sheet for slides.
protected  booleansmartIndent
     does text/block level content effect indentation.
protected  intspaces
     default indentation.
protected  inttabsize
     default tab size (8).
protected  booleantidyMark
     add meta element indicating tidied doc.
protected  booleantrimEmpty
     trim empty elements.
protected  TagTablett
     TagTable associated with this Configuration.
protected  booleanupperCaseAttrs
     output attributes in upper not lower case.
protected  booleanupperCaseTags
     output tags in upper not lower case.
protected  booleanword2000
     draconian cleaning for Word2000.
protected  booleanwrapAsp
     wrap within ASP pseudo elements.
protected  booleanwrapAttVals
     wrap within attribute values.
protected  booleanwrapJste
     wrap within JSTE pseudo elements.
protected  booleanwrapPhp
     wrap within PHP pseudo elements.
protected  booleanwrapScriptlets
     wrap within JavaScript string literals.
protected  booleanwrapSection
     wrap within CDATA section tags.
protected  intwraplen
     default wrap margin (68).
protected  booleanwriteback
     if true then output tidied markup.
protected  booleanxHTML
     output extensible HTML.
protected  booleanxmlOut
     create output as XML.
protected  booleanxmlPIs
     If set to yes PIs must end with ?>.
protected  booleanxmlPi
     add <?xml?> for XML docs.
protected  booleanxmlSpace
     if set to yes adds xml:space attr as needed.
protected  booleanxmlTags
     treat input as XML.

Constructor Summary
protected  Configuration(Report report)
     Instantiates a new Configuration.

Method Summary
public  voidaddProps(Properties p)
     adds configuration Properties.
public  voidadjust()
     Ensure that config is self consistent.
protected  StringconvertCharEncoding(int code)
     Convert a char encoding from the deprecated tidy constant to a standard java encoding name.
protected  intconvertCharEncoding(String name)
     Convert a char encoding from a standard java encoding name to the deprecated tidy constant.
protected  intgetInCharEncoding()
     Getter for inCharEncoding.
protected  StringgetInCharEncodingName()
     Getter for inCharEncodingName.
protected  intgetOutCharEncoding()
     Getter for outCharEncoding.
protected  StringgetOutCharEncodingName()
     Getter for outCharEncodingName.
public static  booleanisKnownOption(String name)
    
public  voidparseFile(String filename)
     Parses a property file.
 voidprintConfigOptions(Writer errout, boolean showActualConfiguration)
     prints available configuration options.
protected  voidsetInCharEncoding(int encoding)
     Setter for inCharEncoding.
protected  voidsetInCharEncodingName(String encoding)
     Setter for inCharEncodingName.
protected  voidsetInOutEncodingName(String encoding)
     Setter for inOutCharEncodingName.
protected  voidsetOutCharEncoding(int encoding)
     Setter for outCharEncoding.
protected  voidsetOutCharEncodingName(String encoding)
     Setter for outCharEncodingName.

Field Detail
ASCII
final public static int ASCII(Code)
character encoding = ASCII.



BIG5
final public static int BIG5(Code)
character encoding = BIG5.



DOCTYPE_AUTO
final public static int DOCTYPE_AUTO(Code)
treatment of doctype: auto.



DOCTYPE_LOOSE
final public static int DOCTYPE_LOOSE(Code)
treatment of doctype: loose.



DOCTYPE_OMIT
final public static int DOCTYPE_OMIT(Code)
treatment of doctype: omit.



DOCTYPE_STRICT
final public static int DOCTYPE_STRICT(Code)
treatment of doctype: strict.



DOCTYPE_USER
final public static int DOCTYPE_USER(Code)
treatment of doctype: user.



ISO2022
final public static int ISO2022(Code)
character encoding = ISO2022.



KEEP_FIRST
final public static int KEEP_FIRST(Code)
Keep first duplicate attribute.



KEEP_LAST
final public static int KEEP_LAST(Code)
Keep last duplicate attribute.



LATIN1
final public static int LATIN1(Code)
character encoding = LATIN1.



MACROMAN
final public static int MACROMAN(Code)
character encoding = MACROMAN.



RAW
final public static int RAW(Code)
character encoding = RAW.



SHIFTJIS
final public static int SHIFTJIS(Code)
character encoding = SHIFTJIS.



UTF16
final public static int UTF16(Code)
character encoding = UTF16.



UTF16BE
final public static int UTF16BE(Code)
character encoding = UTF16BE.



UTF16LE
final public static int UTF16LE(Code)
character encoding = UTF16LE.



UTF8
final public static int UTF8(Code)
character encoding = UTF8.



WIN1252
final public static int WIN1252(Code)
character encoding = WIN1252.



altText
protected String altText(Code)
default text for alt attribute.



asciiChars
protected boolean asciiChars(Code)
convert quotes and dashes to nearest ASCII char.



bodyOnly
protected boolean bodyOnly(Code)
output BODY content only.



breakBeforeBR
protected boolean breakBeforeBR(Code)
o/p newline before br or not?



burstSlides
protected boolean burstSlides(Code)
create slides on each h2 element.



cssPrefix
protected String cssPrefix(Code)
CSS class naming for -clean option.



definedTags
protected int definedTags(Code)
track what types of tags user has defined to eliminate unnecessary searches.



docTypeMode
protected int docTypeMode(Code)
see doctype property.



docTypeStr
protected String docTypeStr(Code)
user specified doctype.



dropEmptyParas
protected boolean dropEmptyParas(Code)
discard empty p elements.



dropFontTags
protected boolean dropFontTags(Code)
discard presentation tags.



dropProprietaryAttributes
protected boolean dropProprietaryAttributes(Code)
discard proprietary attributes.



duplicateAttrs
protected int duplicateAttrs(Code)
Keep first or last duplicate attribute.



emacs
protected boolean emacs(Code)
if true format error output for GNU Emacs.



encloseBlockText
protected boolean encloseBlockText(Code)
if yes text in blocks is wrapped in p's.



encloseBodyText
protected boolean encloseBodyText(Code)
if yes text at body is wrapped in p's.



errfile
protected String errfile(Code)
file name to write errors to.



escapeCdata
protected boolean escapeCdata(Code)
replace CDATA sections with escaped text.



fixBackslash
protected boolean fixBackslash(Code)
fix URLs by replacing \ with /.



fixComments
protected boolean fixComments(Code)
fix comments with adjacent hyphens.



fixUri
protected boolean fixUri(Code)
properly escape URLs.



forceOutput
protected boolean forceOutput(Code)
output document even if errors were found.



hideComments
protected boolean hideComments(Code)
hides all (real) comments in output.



hideEndTags
protected boolean hideEndTags(Code)
suppress optional end tags.



htmlOut
protected boolean htmlOut(Code)
output plain-old HTML, even for XHTML input. Yes means set explicitly.



indentAttributes
protected boolean indentAttributes(Code)
newline+indent before each attribute.



indentCdata
protected boolean indentCdata(Code)
indent CDATA sections.



indentContent
protected boolean indentContent(Code)
indent content of appropriate tags.



joinClasses
protected boolean joinClasses(Code)
join multiple class attributes.



joinStyles
protected boolean joinStyles(Code)
join multiple style attributes.



keepFileTimes
protected boolean keepFileTimes(Code)
if yes last modied time is preserved.



language
protected String language(Code)
RJ language property.



literalAttribs
protected boolean literalAttribs(Code)
if true attributes may use newlines.



logicalEmphasis
protected boolean logicalEmphasis(Code)
replace i by em and b by strong.



lowerLiterals
protected boolean lowerLiterals(Code)
folds known attribute values to lower case.



makeBare
protected boolean makeBare(Code)
Make bare HTML: remove Microsoft cruft.



makeClean
protected boolean makeClean(Code)
remove presentational clutter.



ncr
protected boolean ncr(Code)
allow numeric character references.



newline
protected char[] newline(Code)
bytes for the newline marker.



numEntities
protected boolean numEntities(Code)
use numeric entities.



onlyErrors
protected boolean onlyErrors(Code)
if true normal output is suppressed.



quiet
protected boolean quiet(Code)
no 'Parsing X', guessed DTD or summary.



quoteAmpersand
protected boolean quoteAmpersand(Code)
output naked ampersand as &.



quoteMarks
protected boolean quoteMarks(Code)
output " marks as ".



quoteNbsp
protected boolean quoteNbsp(Code)
output non-breaking space as entity.



rawOut
protected boolean rawOut(Code)
Avoid mapping values > 127 to entities.



replaceColor
protected boolean replaceColor(Code)
replace hex color attribute values with names.



replacementCharEncoding
protected int replacementCharEncoding(Code)
char encoding used when replacing illegal SGML chars, regardless of specified encoding.



report
protected Report report(Code)
Report instance. Used for messages.



showErrors
protected int showErrors(Code)
number of errors to put out.



showWarnings
protected boolean showWarnings(Code)
however errors are always shown.



slidestyle
protected String slidestyle(Code)
style sheet for slides.



smartIndent
protected boolean smartIndent(Code)
does text/block level content effect indentation.



spaces
protected int spaces(Code)
default indentation.



tabsize
protected int tabsize(Code)
default tab size (8).



tidyMark
protected boolean tidyMark(Code)
add meta element indicating tidied doc.



trimEmpty
protected boolean trimEmpty(Code)
trim empty elements.



tt
protected TagTable tt(Code)
TagTable associated with this Configuration.



upperCaseAttrs
protected boolean upperCaseAttrs(Code)
output attributes in upper not lower case.



upperCaseTags
protected boolean upperCaseTags(Code)
output tags in upper not lower case.



word2000
protected boolean word2000(Code)
draconian cleaning for Word2000.



wrapAsp
protected boolean wrapAsp(Code)
wrap within ASP pseudo elements.



wrapAttVals
protected boolean wrapAttVals(Code)
wrap within attribute values.



wrapJste
protected boolean wrapJste(Code)
wrap within JSTE pseudo elements.



wrapPhp
protected boolean wrapPhp(Code)
wrap within PHP pseudo elements.



wrapScriptlets
protected boolean wrapScriptlets(Code)
wrap within JavaScript string literals.



wrapSection
protected boolean wrapSection(Code)
wrap within CDATA section tags.



wraplen
protected int wraplen(Code)
default wrap margin (68).



writeback
protected boolean writeback(Code)
if true then output tidied markup.



xHTML
protected boolean xHTML(Code)
output extensible HTML.



xmlOut
protected boolean xmlOut(Code)
create output as XML.



xmlPIs
protected boolean xmlPIs(Code)
If set to yes PIs must end with ?>.



xmlPi
protected boolean xmlPi(Code)
add <?xml?> for XML docs.



xmlSpace
protected boolean xmlSpace(Code)
if set to yes adds xml:space attr as needed.



xmlTags
protected boolean xmlTags(Code)
treat input as XML.




Constructor Detail
Configuration
protected Configuration(Report report)(Code)
Instantiates a new Configuration. This method should be called by Tidy only.
Parameters:
  report - Report instance




Method Detail
addProps
public void addProps(Properties p)(Code)
adds configuration Properties.
Parameters:
  p - Properties



adjust
public void adjust()(Code)
Ensure that config is self consistent.



convertCharEncoding
protected String convertCharEncoding(int code)(Code)
Convert a char encoding from the deprecated tidy constant to a standard java encoding name.
Parameters:
  code - encoding code encoding name



convertCharEncoding
protected int convertCharEncoding(String name)(Code)
Convert a char encoding from a standard java encoding name to the deprecated tidy constant.
Parameters:
  name - encoding name encoding code



getInCharEncoding
protected int getInCharEncoding()(Code)
Getter for inCharEncoding. Returns the inCharEncoding.



getInCharEncodingName
protected String getInCharEncodingName()(Code)
Getter for inCharEncodingName. Returns the inCharEncodingName.



getOutCharEncoding
protected int getOutCharEncoding()(Code)
Getter for outCharEncoding. Returns the outCharEncoding.



getOutCharEncodingName
protected String getOutCharEncodingName()(Code)
Getter for outCharEncodingName. Returns the outCharEncodingName.



isKnownOption
public static boolean isKnownOption(String name)(Code)
Is the given String a valid configuration flag?
Parameters:
  name - configuration parameter name true if the given String is a valid config option



parseFile
public void parseFile(String filename)(Code)
Parses a property file.
Parameters:
  filename - file name



printConfigOptions
void printConfigOptions(Writer errout, boolean showActualConfiguration)(Code)
prints available configuration options.
Parameters:
  errout - where to write
Parameters:
  showActualConfiguration - print actual configuration values



setInCharEncoding
protected void setInCharEncoding(int encoding)(Code)
Setter for inCharEncoding.
Parameters:
  encoding - The inCharEncoding to set.



setInCharEncodingName
protected void setInCharEncodingName(String encoding)(Code)
Setter for inCharEncodingName.
Parameters:
  encoding - The inCharEncodingName to set.



setInOutEncodingName
protected void setInOutEncodingName(String encoding)(Code)
Setter for inOutCharEncodingName.
Parameters:
  encoding - The CharEncodingName to set.



setOutCharEncoding
protected void setOutCharEncoding(int encoding)(Code)
Setter for outCharEncoding.
Parameters:
  encoding - The outCharEncoding to set.



setOutCharEncodingName
protected void setOutCharEncodingName(String encoding)(Code)
Setter for outCharEncodingName.
Parameters:
  encoding - The outCharEncodingName to set.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.