A B C D E F G H I J K L M N P R S T V W Y

A

add(DTDElement, String) - Method in class DTDDoc.DefinitionsMap
 
addFileset(FileSet) - Method in class DTDDoc.DTDDocTask
Filesets as explained in Ant's documentation.
AntLogger - Class in DTDDoc
A logger that is logging through Ant's logging API.
AntLogger(Task) - Constructor for class DTDDoc.AntLogger
 
ATTR_COMMENT_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting an attribute comment (@attr attributeName comment)
ATTRIBUTE_NAME - Static variable in class DTDDoc.DtdHighlighter
 
ATTRIBUTE_VALUE - Static variable in class DTDDoc.DtdHighlighter
 

B

BEGIN_TAG - Static variable in class DTDDoc.DTDCommenter
Character used to begin a tag.

C

cardinalToChar(DTDCardinal) - Method in class DTDDoc.DTDCommenter
 
CHAR_DATA - Static variable in class DTDDoc.DtdHighlighter
 
CODE_SEPARATOR - Static variable in class DTDDoc.DTDCommenter
Character used to mark the beginning and the end of a part of a code fragment.
CODE_SEPARATOR_DEPRECATED - Static variable in class DTDDoc.DTDCommenter
Character used to mark the beginning and the end of a part of code fragment.
collectDeclaredChildren(DTDElement) - Static method in class DTDDoc.ExtendedDTD
Collects the elements that appear in the definition of a given element (its "children").
COMMENT - Static variable in class DTDDoc.DtdHighlighter
 
COMMENT_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a comment (@comment)
commentDTDs(HashSet, File, File, boolean, boolean, String, File) - Method in class DTDDoc.DTDCommenter
Deprecated. signature maintained for binary backward compatibility with versions <= 0.0.11, but equivalent to the other more generic commentDTDs() method
commentDTDs(Set, File, File, boolean, boolean, boolean, String, File) - Method in class DTDDoc.DTDCommenter
This is the main method.
CommentParser - Class in DTDDoc
This class contains several tools used for parsing javadoc-like comments (tags) appearing in XML comments.
CommentParser(DTDComment, Logger, boolean) - Constructor for class DTDDoc.CommentParser
 
copy(File, File) - Static method in class DTDDoc.Tools
Copy one file into antoher.
copyFromResource(String, File) - Static method in class DTDDoc.Tools
Copies a resource file (in-jar) to a given destination.

D

DEFAULT_CSS - Static variable in class DTDDoc.DtdXhtmlRenderer
 
DefinitionsMap - Class in DTDDoc
 
DefinitionsMap() - Constructor for class DTDDoc.DefinitionsMap
 
DOCTYPE_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a DTD doctype defintion (@doctype)
DTDCommenter - Class in DTDDoc
Main class to the DTDDoc program, everything happen here.
DTDCommenter() - Constructor for class DTDDoc.DTDCommenter
Deprecated. maintained for binary backward compatibility: uses SystemLogger as default logging system.
DTDCommenter(Logger) - Constructor for class DTDDoc.DTDCommenter
 
DTDDoc - package DTDDoc
 
DTDDoc - Class in DTDDoc
Deprecated. The command-line version of DTDDoc is deprecated in favour of an Ant Task version. Please try to migrate.
DTDDoc(Logger) - Constructor for class DTDDoc.DTDDoc
Deprecated.  
DTDDOC_TAG_STYLE - Static variable in class DTDDoc.DtdHighlighter
 
DTDDocTask - Class in DTDDoc
This is the DTDDoc ant task.
DTDDocTask() - Constructor for class DTDDoc.DTDDocTask
 
DtdHighlighter - Class in DTDDoc
This class is a scanner generated by JFlex 1.4.1 on 25/12/06 20:51 from the specification file /home/herve/projet/workspace/DTDDoc/src/DTDDoc/DtdHighlighter.flex
DtdHighlighter() - Constructor for class DTDDoc.DtdHighlighter
 
DtdHighlighter(Reader) - Constructor for class DTDDoc.DtdHighlighter
Creates a new scanner There is also a java.io.InputStream version of this constructor.
DtdHighlighter(InputStream) - Constructor for class DTDDoc.DtdHighlighter
Creates a new scanner.
DtdXhtmlRenderer - Class in DTDDoc
 
DtdXhtmlRenderer() - Constructor for class DTDDoc.DtdXhtmlRenderer
 

E

ElementTreeBuilder - Class in DTDDoc
Used to build the HTML/Javascript code necessary to set up the d-tree.
ElementTreeBuilder(PrintWriter, DTDCommenter, Set, Logger) - Constructor for class DTDDoc.ElementTreeBuilder
 
enumerationToList(Enumeration) - Static method in class DTDDoc.Tools
 
error(String) - Method in class DTDDoc.AntLogger
 
error(String) - Method in class DTDDoc.Logger
Logs an error message.
error(String, Exception) - Method in class DTDDoc.Logger
Logs an error message and an associated exception (stack trace).
error(String) - Method in class DTDDoc.SystemLogger
 
escapeHTMLUnicode(String, boolean) - Static method in class DTDDoc.Tools
Escape all non-ASCII character in a UNICODE string.
EXAMPLE_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting an "example" comment (@example)
execute() - Method in class DTDDoc.DTDDocTask
 
ExtendedDTD - Class in DTDDoc
An object of this class represents a full DTD.
ExtendedDTD(File, Logger, boolean) - Constructor for class DTDDoc.ExtendedDTD
Build all the information needed to make a ExtendedDTD out of a "normal" DTD.

F

FileCopyException - Exception in DTDDoc
 
FileCopyException(String) - Constructor for exception DTDDoc.FileCopyException
 
FIXME_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a "fix me" comment (@fixme)

G

generateJavascriptSetup(PrintWriter) - Static method in class DTDDoc.ElementTreeBuilder
Generates preliminary Javascript code needed to load the d-tree library.
generateTree() - Method in class DTDDoc.ElementTreeBuilder
Builds the HTML/Javascript code necessary to the invocation of d-tree.
getConfig(String) - Method in class DTDDoc.DTDDoc
Deprecated. Get a configuration value.
getCssClass(int) - Method in class DTDDoc.DtdXhtmlRenderer
 
getCurrentState() - Method in class DTDDoc.DtdHighlighter
 
getDefaultCssStyles() - Method in class DTDDoc.DtdXhtmlRenderer
 
getDoctype() - Method in class DTDDoc.ExtendedDTD
Returns the doctype of the DTD (see the doctype tag).
getDTDBaseURI(ExtendedDTD) - Method in class DTDDoc.DTDCommenter
 
getEffectiveEncoding() - Method in class DTDDoc.ExtendedDTD
Get the effective encoding of the file: either the encoding specified in the file, or the default encoding (UTF-8) if not specified
getElementByName(String) - Method in class DTDDoc.ExtendedDTD
 
getElementByName(DTDName) - Method in class DTDDoc.ExtendedDTD
 
getElementOrigin(DTDElement) - Method in class DTDDoc.ExtendedDTD
Gives the file name of the DTD where a given element is defined.
getElements() - Method in class DTDDoc.ExtendedDTD
Return all the DTDElements of the DTD (a transparent wrapper around the same function in Wutka's library).
getElementsCollection() - Method in class DTDDoc.ExtendedDTD
 
getEncoding() - Method in class DTDDoc.ExtendedDTD
Get the encoding specified in the file, if any.
getEntities() - Method in class DTDDoc.ExtendedDTD
Return all the DTDEntities of the DTD (a transparent wrapper around the same function in Wutka's library).
getExternalHREF(ExtendedDTD, DTDElement, String) - Method in class DTDDoc.DTDCommenter
Builds a HTML external reference to an element from the documentation of a DTD (filename#element_id).
getExternalHREF(ExtendedDTD, String, String) - Method in class DTDDoc.DTDCommenter
 
getFilename(String) - Static method in class DTDDoc.Tools
Extract the file name out of a full path.
getHighlighter() - Method in class DTDDoc.DtdXhtmlRenderer
 
getInternalHREF(ExtendedDTD, DTDElement) - Method in class DTDDoc.DTDCommenter
Builds a HTML internal reference to an element inside the documentation of a DTD (#element_id).
getItems() - Method in class DTDDoc.ExtendedDTD
Return all the DTDItems of the DTD (a transparent wrapper around the same function in Wutka's library).
getLocation(DTDElement) - Method in class DTDDoc.DefinitionsMap
 
getMultipleTagValue(String) - Method in class DTDDoc.CommentParser
 
getNextToken() - Method in class DTDDoc.DtdHighlighter
 
getParents(String) - Method in class DTDDoc.ExtendedDTD
Gets the parents of an element.
getRootElement() - Method in class DTDDoc.ExtendedDTD
Returns the root elements of the DTD, as defined by the \@root tag.
getStartState() - Method in class DTDDoc.DtdHighlighter
 
getStyleCount() - Method in class DTDDoc.DtdHighlighter
 
getSystemPath() - Method in class DTDDoc.ExtendedDTD
Returns the full path to the original DTD.
getTitle() - Method in class DTDDoc.ExtendedDTD
Returns the title of the DTD (see the @title tag).
getTokenLength() - Method in class DTDDoc.DtdHighlighter
 
getUniqueId(DTDAttlist, DTDAttribute) - Static method in class DTDDoc.ExtendedDTD
Gives a unique id for an attribute in a DTD.
getUniqueId(DTDElement, DTDAttribute) - Static method in class DTDDoc.ExtendedDTD
Gives a unique id for an attribute in a DTD.
getUniqueId(DTDElement) - Static method in class DTDDoc.ExtendedDTD
Gives a unique id for an element of a DTD.
getUniqueTagValue(String) - Method in class DTDDoc.CommentParser
 

H

HIDDEN_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a "hidden" comment (@hidden)
highlight(Reader, Writer) - Method in class DTDDoc.DtdXhtmlRenderer
 
HTML_TAGS - Static variable in class DTDDoc.Tools
 

I

IN_CDATA_SECTION - Static variable in class DTDDoc.DtdHighlighter
lexical states
IN_COMMENT - Static variable in class DTDDoc.DtdHighlighter
 
IN_DOUBLE_QUOTE_STRING - Static variable in class DTDDoc.DtdHighlighter
 
IN_PROCESSING_INSTRUCTION - Static variable in class DTDDoc.DtdHighlighter
 
IN_SINGLE_QUOTE_STRING - Static variable in class DTDDoc.DtdHighlighter
 
IN_TAG - Static variable in class DTDDoc.DtdHighlighter
 
info(String) - Method in class DTDDoc.AntLogger
 
info(String) - Method in class DTDDoc.Logger
Logs an informational message.
info(String) - Method in class DTDDoc.SystemLogger
 
isConfigTrueFor(String) - Method in class DTDDoc.DTDDoc
Deprecated. Test if a value of a property of the configuration is true.
isExternal(DTDElement) - Method in class DTDDoc.ExtendedDTD
Tells if an element is declared in a DTD outside the one represented in this.
isExternal(DTDAttlist) - Method in class DTDDoc.ExtendedDTD
Determine if an attributes list is defined in this DTD.
isPropertySet(String) - Method in class DTDDoc.DTDDoc
Deprecated.  
isRoot(DTDElement) - Method in class DTDDoc.ExtendedDTD
Check if an element is root, that is, if it has no parent.

J

join(String[], String) - Static method in class DTDDoc.Tools
 

K

KEYWORD - Static variable in class DTDDoc.DtdHighlighter
 

L

listToArray(String, String) - Static method in class DTDDoc.Tools
Transform a list into an array.
locateAttributesList(DTDAttribute) - Method in class DTDDoc.ExtendedDTD
 
Logger - Class in DTDDoc
A logger class that should be compatible with Ant and Maven's log.
Logger() - Constructor for class DTDDoc.Logger
 

M

main(String[]) - Static method in class DTDDoc.DTDDoc
Deprecated.  
makeFileDir(File) - Static method in class DTDDoc.Tools
Will create the directories present in the path of a file.
makeTOC(Set, String) - Method in class DTDDoc.DTDCommenter
This function will create a table of content for the parsed DTDs documentation, and copy necessary images (img sub-directory) and JavaScript library.
merge(DefinitionsMap) - Method in class DTDDoc.DefinitionsMap
 

N

newURITo(ExtendedDTD) - Method in class DTDDoc.DTDCommenter
 
newURITo(ExtendedDTD, DTDElement) - Method in class DTDDoc.DTDCommenter
 
newURITo(ExtendedDTD, DTDAttlist, DTDAttribute) - Method in class DTDDoc.DTDCommenter
 
newURITo(ExtendedDTD, DTDElement, DTDAttribute) - Method in class DTDDoc.DTDCommenter
 

P

parent(File) - Static method in class DTDDoc.Tools
Get the parent of a given path.
PLAIN_STYLE - Static variable in class DTDDoc.DtdHighlighter
 
PROCESSING_INSTRUCTION - Static variable in class DTDDoc.DtdHighlighter
 

R

replace(String, String, String) - Static method in class DTDDoc.Tools
 
ROOT_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a root element defintion (@root)

S

setDestDir(File) - Method in class DTDDoc.DTDDocTask
 
setDir(File) - Method in class DTDDoc.DTDDocTask
Pseudo-parameter addition to mimic FileSet definition with the real task parameter : sourceDir.
setDocTitle(String) - Method in class DTDDoc.DTDDocTask
 
setFile(File) - Method in class DTDDoc.DTDDocTask
 
setGetAroundNetBeansComments(boolean) - Method in class DTDDoc.DTDDocTask
 
setReader(Reader) - Method in class DTDDoc.DtdHighlighter
 
setRootElement(DTDElement) - Method in class DTDDoc.ExtendedDTD
Setter for the root elements of the DTD.
setShowFixmeTags(boolean) - Method in class DTDDoc.DTDDocTask
 
setShowHiddenTags(boolean) - Method in class DTDDoc.DTDDocTask
 
setSourceDir(File) - Method in class DTDDoc.DTDDocTask
 
setState(byte) - Method in class DTDDoc.DtdHighlighter
 
setStyleSheet(File) - Method in class DTDDoc.DTDDocTask
 
sort(Collection, Comparator) - Static method in class DTDDoc.Tools
Returns a sorted copy of a given collection.
startsWithHtmlTag(String) - Static method in class DTDDoc.Tools
 
SystemLogger - Class in DTDDoc
A logger that logs on System.out.
SystemLogger() - Constructor for class DTDDoc.SystemLogger
 

T

TAG_NAME - Static variable in class DTDDoc.DtdHighlighter
 
TAG_START - Static variable in class DTDDoc.DtdHighlighter
 
TAG_SYMBOLS - Static variable in class DTDDoc.DtdHighlighter
 
TITLE_TAG - Static variable in class DTDDoc.DTDCommenter
Tag starting a DTD title defintion (@title)
Tools - Class in DTDDoc
A class that gather some useful tools.
Tools() - Constructor for class DTDDoc.Tools
 

V

VERSION - Static variable in class DTDDoc.DTDCommenter
Version of DTDDoc running
visitContainer(int, DTDContainer) - Method in class DTDDoc.ElementTreeBuilder
Visit a container and generate the Javascript d-tree code.

W

warn(String) - Method in class DTDDoc.AntLogger
 
warn(String) - Method in class DTDDoc.Logger
Logs a warning message.
warn(String) - Method in class DTDDoc.SystemLogger
 

Y

yybegin(int) - Method in class DTDDoc.DtdHighlighter
Enters a new lexical state
yycharat(int) - Method in class DTDDoc.DtdHighlighter
Returns the character at position pos from the matched text.
yyclose() - Method in class DTDDoc.DtdHighlighter
Closes the input stream.
YYEOF - Static variable in class DTDDoc.DtdHighlighter
This character denotes the end of file
YYINITIAL - Static variable in class DTDDoc.DtdHighlighter
 
yylength() - Method in class DTDDoc.DtdHighlighter
Returns the length of the matched text region.
yylex() - Method in class DTDDoc.DtdHighlighter
Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
yypushback(int) - Method in class DTDDoc.DtdHighlighter
Pushes the specified amount of characters back into the input stream.
yyreset(Reader) - Method in class DTDDoc.DtdHighlighter
Resets the scanner to read from a new input stream.
yystate() - Method in class DTDDoc.DtdHighlighter
Returns the current lexical state.
yytext() - Method in class DTDDoc.DtdHighlighter
Returns the text matched by the current regular expression.

A B C D E F G H I J K L M N P R S T V W Y

Copyright © 2002-2009 DTDDoc. All Rights Reserved.