|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.io.Writer | +--java.io.PrintWriter | +--ConForM.CoopnTools.CoKer.DocComment.DocWriter
Documentation Comment Writer. This abstarct class defines documentation comment writers, which extend simple PrintWriter. The default doc writer format its output in HTML.
Field Summary | |
protected static int |
DOC
|
protected CoopnEnv |
env
|
protected static int |
GTOC
|
static int |
HTML
HTML doc writer. |
protected static int |
INDEX
|
protected PackageMgr |
packageMgr
|
protected static int |
TOC
|
Fields inherited from class java.io.PrintWriter |
out |
Fields inherited from class java.io.Writer |
lock |
Constructor Summary | |
protected |
DocWriter(java.io.Writer writer,
PackageMgr packageMgr,
CoopnEnv env)
|
Method Summary | |
abstract void |
blankSpace()
Blank space. |
abstract void |
defineTargetItem(java.lang.String item)
Defines a hypertext target item. |
abstract java.io.File |
documentationFileOf(java.lang.String pointer)
Get the documentation file associated to a pointer. |
abstract java.io.File |
documentationFileOf(java.lang.String moduleName,
int moduleKind)
Get the documentation file of a module. |
abstract void |
endAnchor()
End a hypertext anchor. |
abstract void |
endBullet()
Ends a bullet element. |
abstract void |
endDefinition()
End the definition in a definition list. |
abstract void |
endDefinitionList()
End a definition list, containing terms and their definitions. |
abstract void |
endMenu()
End a Menu, containing bullet elements. |
abstract void |
endShift()
End a shift text. |
abstract void |
endTerm()
End the term in a definition list. |
static java.io.File |
getDocFile(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get the documentation file for a particular format, associated to a module. |
static DocWriter |
getDocWriter(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get a documentation writer for a particular format, associated to a module. |
static DocWriter |
getDocWriter(java.io.Writer writer,
int format,
PackageMgr packageMgr,
CoopnEnv env)
Get a doc writer for a particular format. |
static java.io.File |
getGTocFile(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get a general TOC file for a particular format, associated to a module. |
static DocWriter |
getGTocWriter(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get a general TOC writer for a particular format, associated to a module. |
static java.io.File |
getIndexFile(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get an index file for a particular format, associated to a module. |
static DocWriter |
getIndexWriter(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get an index writer for a particular format, associated to a module. |
static java.io.File |
getTocFile(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get a TOC file for a particular format, associated to a module. |
static DocWriter |
getTocWriter(int format,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
Get a TOC writer for a particular format, associated to a module. |
abstract java.io.File |
gtocFileOf(java.lang.String moduleName,
int moduleKind)
Get the general table-of-contents file associated to a module. |
abstract void |
horizontalRule()
Horizontal line. |
abstract void |
lineBreak()
Line break. |
abstract void |
printHeader(java.lang.String headerText)
Print the header. |
abstract void |
printSection(java.lang.String text)
Print a sub-title. |
abstract void |
printSubSection(java.lang.String text)
Print a sub-sub-title. |
abstract void |
printSubSubSection(java.lang.String text)
Print a sub-sub-sub-title. |
abstract void |
printTitle(java.lang.String text)
Print a title. |
abstract void |
printTrailer()
Print the trailer text. |
abstract void |
resetBold()
End a bold face. |
abstract void |
resetEmphasis()
End an emphasis text. |
abstract void |
resetTT()
End the teletype mode mode. |
abstract void |
setBold()
Start a bold face. |
abstract void |
setEmphasis()
Start an emphasis text. |
abstract void |
setTT()
Start the teletype mode. |
abstract void |
startAnchor(java.io.File target)
Start a hypertext anchor on a file. |
abstract void |
startAnchor(java.io.File target,
java.lang.String item)
Start a hypertext anchor on a file. |
abstract void |
startAnchor(java.net.URL target)
Start a hypertext anchor on an URL. |
abstract void |
startBullet()
Start a bullet element. |
abstract void |
startDefinition()
Start the definition in a definition list. |
abstract void |
startDefinitionList()
Start a definition list, containing terms and their definitions. |
abstract void |
startMenu()
Start a Menu, containing bullet elements. |
abstract void |
startShift()
Start a shift text. |
abstract void |
startTerm()
Start the term in a definition list. |
static java.lang.String[] |
supportedFormats(CoopnEnv env)
Get the supported formats. |
abstract java.io.File |
tocFileOf(java.lang.String moduleName,
int moduleKind)
Get the index file associated to a module public abstract File indexFileOf(String moduleName, int moduleKind); /**Get the table-of-contents file associated to a module. |
Methods inherited from class java.io.PrintWriter |
checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected PackageMgr packageMgr
protected CoopnEnv env
public static final int HTML
protected static final int DOC
protected static final int INDEX
protected static final int TOC
protected static final int GTOC
Constructor Detail |
protected DocWriter(java.io.Writer writer, PackageMgr packageMgr, CoopnEnv env)
Method Detail |
public abstract void printHeader(java.lang.String headerText)
public abstract void printTrailer()
public abstract void printTitle(java.lang.String text)
public abstract void printSection(java.lang.String text)
public abstract void printSubSection(java.lang.String text)
public abstract void printSubSubSection(java.lang.String text)
public abstract void startShift()
public abstract void endShift()
public abstract void startMenu()
public abstract void endMenu()
public abstract void startBullet()
public abstract void endBullet()
public abstract void startDefinitionList()
public abstract void endDefinitionList()
public abstract void startTerm()
public abstract void endTerm()
public abstract void startDefinition()
public abstract void endDefinition()
public abstract void setTT()
public abstract void resetTT()
public abstract void setEmphasis()
public abstract void resetEmphasis()
public abstract void setBold()
public abstract void resetBold()
public abstract void horizontalRule()
public abstract void lineBreak()
public abstract void blankSpace()
public abstract java.io.File documentationFileOf(java.lang.String pointer)
public abstract java.io.File documentationFileOf(java.lang.String moduleName, int moduleKind)
public abstract java.io.File tocFileOf(java.lang.String moduleName, int moduleKind)
public abstract java.io.File gtocFileOf(java.lang.String moduleName, int moduleKind)
public abstract void startAnchor(java.io.File target)
public abstract void startAnchor(java.io.File target, java.lang.String item)
public abstract void startAnchor(java.net.URL target)
public abstract void endAnchor()
public abstract void defineTargetItem(java.lang.String item)
public static java.lang.String[] supportedFormats(CoopnEnv env)
public static DocWriter getDocWriter(java.io.Writer writer, int format, PackageMgr packageMgr, CoopnEnv env)
writer
- the basic Writer to useformat
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatspackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.public static java.io.File getDocFile(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.public static java.io.File getIndexFile(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.public static java.io.File getTocFile(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.public static java.io.File getGTocFile(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env)
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.public static DocWriter getDocWriter(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env) throws java.io.IOException
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.java.io.IOException
- cannot open the file for the writer.public static DocWriter getIndexWriter(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env) throws java.io.IOException
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.java.io.IOException
- cannot open the file for the writer.public static DocWriter getTocWriter(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env) throws java.io.IOException
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.java.io.IOException
- cannot open the file for the writer.public static DocWriter getGTocWriter(int format, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env) throws java.io.IOException
format
- the format of doc writer, one of the valid indexes
of the array returned by supportedFormatsmoduleName
- the name of the modulemoduleKind
- the kind of the modulepackageMgr
- the associated package managerenv
- the environmentjava.lang.IllegalArgumentException
- an argument is erroneous.java.io.IOException
- cannot open the file for the writer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |