ConForM.CoopnTools.CoKer.DocComment
Class HTMLDocWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.PrintWriter
              |
              +--ConForM.CoopnTools.CoKer.DocComment.DocWriter
                    |
                    +--ConForM.CoopnTools.CoKer.DocComment.HTMLDocWriter

public class HTMLDocWriter
extends DocWriter

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

HTMLDocWriter

protected HTMLDocWriter(java.io.Writer writer,
                        PackageMgr packageMgr,
                        CoopnEnv env)

HTMLDocWriter

protected HTMLDocWriter(int docKind,
                        java.lang.String moduleName,
                        int moduleKind,
                        PackageMgr packageMgr,
                        CoopnEnv env)
                 throws java.io.IOException
Method Detail

fileOf

protected static java.io.File fileOf(int docKind,
                                     java.lang.String module,
                                     int moduleKind,
                                     PackageMgr pmgr,
                                     CoopnEnv env)

fileOf

protected static java.io.File fileOf(java.lang.String pointer,
                                     PackageMgr pmgr,
                                     CoopnEnv env)

printHeader

public void printHeader(java.lang.String headerText)
Print the header.
Overrides:
printHeader in class DocWriter

printTrailer

public void printTrailer()
Print the trailer text.
Overrides:
printTrailer in class DocWriter

printTitle

public void printTitle(java.lang.String text)
Print a title.
Overrides:
printTitle in class DocWriter

printSection

public void printSection(java.lang.String text)
Print a sub-title.
Overrides:
printSection in class DocWriter

printSubSection

public void printSubSection(java.lang.String text)
Print a sub-sub-title.
Overrides:
printSubSection in class DocWriter

printSubSubSection

public void printSubSubSection(java.lang.String text)
Print a sub-sub-sub-title, i.e. menu or bullet title.
Overrides:
printSubSubSection in class DocWriter

startShift

public void startShift()
Start a shift text.
Overrides:
startShift in class DocWriter

endShift

public void endShift()
End a shift text.
Overrides:
endShift in class DocWriter

startMenu

public void startMenu()
Start a Menu, containing bullet elements.
Overrides:
startMenu in class DocWriter

endMenu

public void endMenu()
End a Menu, containing bullet elements.
Overrides:
endMenu in class DocWriter

startBullet

public void startBullet()
Start a bullet element.
Overrides:
startBullet in class DocWriter

endBullet

public void endBullet()
Ends a bullet element.
Overrides:
endBullet in class DocWriter

startDefinitionList

public void startDefinitionList()
Start a definition list, containing terms and their definitions.
Overrides:
startDefinitionList in class DocWriter

endDefinitionList

public void endDefinitionList()
End a definition list, containing terms and their definitions.
Overrides:
endDefinitionList in class DocWriter

startTerm

public void startTerm()
Start the term in a definition list.
Overrides:
startTerm in class DocWriter

endTerm

public void endTerm()
End the term in a definition list.
Overrides:
endTerm in class DocWriter

startDefinition

public void startDefinition()
Start the definition in a definition list.
Overrides:
startDefinition in class DocWriter

endDefinition

public void endDefinition()
End the definition in a definition list.
Overrides:
endDefinition in class DocWriter

setTT

public void setTT()
Start the teletype mode.
Overrides:
setTT in class DocWriter

resetTT

public void resetTT()
End the teletype mode mode.
Overrides:
resetTT in class DocWriter

setEmphasis

public void setEmphasis()
Start an emphasis text.
Overrides:
setEmphasis in class DocWriter

resetEmphasis

public void resetEmphasis()
End an emphasis text.
Overrides:
resetEmphasis in class DocWriter

setBold

public void setBold()
Start a bold face.
Overrides:
setBold in class DocWriter

resetBold

public void resetBold()
End a bold face.
Overrides:
resetBold in class DocWriter

horizontalRule

public void horizontalRule()
Horizontal line.
Overrides:
horizontalRule in class DocWriter

lineBreak

public void lineBreak()
Line break.
Overrides:
lineBreak in class DocWriter

blankSpace

public void blankSpace()
Blank space.
Overrides:
blankSpace in class DocWriter

documentationFileOf

public java.io.File documentationFileOf(java.lang.String pointer)
Get the documentation file associated to a pointer.
Overrides:
documentationFileOf in class DocWriter

documentationFileOf

public java.io.File documentationFileOf(java.lang.String moduleName,
                                        int moduleKind)
Get the documentation file of a module.
Overrides:
documentationFileOf in class DocWriter

tocFileOf

public 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.
Overrides:
tocFileOf in class DocWriter

gtocFileOf

public java.io.File gtocFileOf(java.lang.String moduleName,
                               int moduleKind)
Get the general table-of-contents file associated to a module.
Overrides:
gtocFileOf in class DocWriter

startAnchor

public void startAnchor(java.io.File target)
Start a hypertext anchor.
Overrides:
startAnchor in class DocWriter

startAnchor

public void startAnchor(java.io.File target,
                        java.lang.String item)
Start a hypertext anchor.
Overrides:
startAnchor in class DocWriter

startAnchor

public void startAnchor(java.net.URL target)
Start a hypertext anchor.
Overrides:
startAnchor in class DocWriter

endAnchor

public void endAnchor()
End a hypertext anchor.
Overrides:
endAnchor in class DocWriter

defineTargetItem

public void defineTargetItem(java.lang.String item)
Defines a hypertext target item.
Overrides:
defineTargetItem in class DocWriter