|
|||||||||
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 | +--ConForM.CoopnTools.CoKer.DocComment.HTMLDocWriter
HTML Documentation Comment Writer.
Fields inherited from class ConForM.CoopnTools.CoKer.DocComment.DocWriter |
DOC, env, GTOC, HTML, INDEX, packageMgr, TOC |
Fields inherited from class java.io.PrintWriter |
out |
Fields inherited from class java.io.Writer |
lock |
Constructor Summary | |
protected |
HTMLDocWriter(int docKind,
java.lang.String moduleName,
int moduleKind,
PackageMgr packageMgr,
CoopnEnv env)
|
protected |
HTMLDocWriter(java.io.Writer writer,
PackageMgr packageMgr,
CoopnEnv env)
|
Method Summary | |
void |
blankSpace()
Blank space. |
void |
defineTargetItem(java.lang.String item)
Defines a hypertext target item. |
java.io.File |
documentationFileOf(java.lang.String pointer)
Get the documentation file associated to a pointer. |
java.io.File |
documentationFileOf(java.lang.String moduleName,
int moduleKind)
Get the documentation file of a module. |
void |
endAnchor()
End a hypertext anchor. |
void |
endBullet()
Ends a bullet element. |
void |
endDefinition()
End the definition in a definition list. |
void |
endDefinitionList()
End a definition list, containing terms and their definitions. |
void |
endMenu()
End a Menu, containing bullet elements. |
void |
endShift()
End a shift text. |
void |
endTerm()
End the term in a definition list. |
protected static java.io.File |
fileOf(int docKind,
java.lang.String module,
int moduleKind,
PackageMgr pmgr,
CoopnEnv env)
|
protected static java.io.File |
fileOf(java.lang.String pointer,
PackageMgr pmgr,
CoopnEnv env)
|
java.io.File |
gtocFileOf(java.lang.String moduleName,
int moduleKind)
Get the general table-of-contents file associated to a module. |
void |
horizontalRule()
Horizontal line. |
void |
lineBreak()
Line break. |
void |
printHeader(java.lang.String headerText)
Print the header. |
void |
printSection(java.lang.String text)
Print a sub-title. |
void |
printSubSection(java.lang.String text)
Print a sub-sub-title. |
void |
printSubSubSection(java.lang.String text)
Print a sub-sub-sub-title, i.e. menu or bullet title. |
void |
printTitle(java.lang.String text)
Print a title. |
void |
printTrailer()
Print the trailer text. |
void |
resetBold()
End a bold face. |
void |
resetEmphasis()
End an emphasis text. |
void |
resetTT()
End the teletype mode mode. |
void |
setBold()
Start a bold face. |
void |
setEmphasis()
Start an emphasis text. |
void |
setTT()
Start the teletype mode. |
void |
startAnchor(java.io.File target)
Start a hypertext anchor. |
void |
startAnchor(java.io.File target,
java.lang.String item)
Start a hypertext anchor. |
void |
startAnchor(java.net.URL target)
Start a hypertext anchor. |
void |
startBullet()
Start a bullet element. |
void |
startDefinition()
Start the definition in a definition list. |
void |
startDefinitionList()
Start a definition list, containing terms and their definitions. |
void |
startMenu()
Start a Menu, containing bullet elements. |
void |
startShift()
Start a shift text. |
void |
startTerm()
Start the term in a definition list. |
java.io.File |
tocFileOf(java.lang.String moduleName,
int moduleKind)
Get the index file associated to a module public File indexFileOf(String moduleName, int moduleKind) { return(fileOf(INDEX,moduleName,moduleKind,packageMgr,env)); } /**Get the table-of-contents file associated to a module. |
Methods inherited from class ConForM.CoopnTools.CoKer.DocComment.DocWriter |
getDocFile, getDocWriter, getDocWriter, getGTocFile, getGTocWriter, getIndexFile, getIndexWriter, getTocFile, getTocWriter, supportedFormats |
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 |
Constructor Detail |
protected HTMLDocWriter(java.io.Writer writer, PackageMgr packageMgr, CoopnEnv env)
protected HTMLDocWriter(int docKind, java.lang.String moduleName, int moduleKind, PackageMgr packageMgr, CoopnEnv env) throws java.io.IOException
Method Detail |
protected static java.io.File fileOf(int docKind, java.lang.String module, int moduleKind, PackageMgr pmgr, CoopnEnv env)
protected static java.io.File fileOf(java.lang.String pointer, PackageMgr pmgr, CoopnEnv env)
public void printHeader(java.lang.String headerText)
printHeader
in class DocWriter
public void printTrailer()
printTrailer
in class DocWriter
public void printTitle(java.lang.String text)
printTitle
in class DocWriter
public void printSection(java.lang.String text)
printSection
in class DocWriter
public void printSubSection(java.lang.String text)
printSubSection
in class DocWriter
public void printSubSubSection(java.lang.String text)
printSubSubSection
in class DocWriter
public void startShift()
startShift
in class DocWriter
public void endShift()
endShift
in class DocWriter
public void startMenu()
startMenu
in class DocWriter
public void endMenu()
endMenu
in class DocWriter
public void startBullet()
startBullet
in class DocWriter
public void endBullet()
endBullet
in class DocWriter
public void startDefinitionList()
startDefinitionList
in class DocWriter
public void endDefinitionList()
endDefinitionList
in class DocWriter
public void startTerm()
startTerm
in class DocWriter
public void endTerm()
endTerm
in class DocWriter
public void startDefinition()
startDefinition
in class DocWriter
public void endDefinition()
endDefinition
in class DocWriter
public void setTT()
setTT
in class DocWriter
public void resetTT()
resetTT
in class DocWriter
public void setEmphasis()
setEmphasis
in class DocWriter
public void resetEmphasis()
resetEmphasis
in class DocWriter
public void setBold()
setBold
in class DocWriter
public void resetBold()
resetBold
in class DocWriter
public void horizontalRule()
horizontalRule
in class DocWriter
public void lineBreak()
lineBreak
in class DocWriter
public void blankSpace()
blankSpace
in class DocWriter
public java.io.File documentationFileOf(java.lang.String pointer)
documentationFileOf
in class DocWriter
public java.io.File documentationFileOf(java.lang.String moduleName, int moduleKind)
documentationFileOf
in class DocWriter
public java.io.File tocFileOf(java.lang.String moduleName, int moduleKind)
tocFileOf
in class DocWriter
public java.io.File gtocFileOf(java.lang.String moduleName, int moduleKind)
gtocFileOf
in class DocWriter
public void startAnchor(java.io.File target)
startAnchor
in class DocWriter
public void startAnchor(java.io.File target, java.lang.String item)
startAnchor
in class DocWriter
public void startAnchor(java.net.URL target)
startAnchor
in class DocWriter
public void endAnchor()
endAnchor
in class DocWriter
public void defineTargetItem(java.lang.String item)
defineTargetItem
in class DocWriter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |