sfi.director.application.autodoc.DocPHTML Class Reference

Inheritance diagram for sfi.director.application.autodoc.DocPHTML:

List of all members.

---

Detailed Description

Parses phtml documents, adjusts their title levels and adds anchors.

Public Member Functions
	DocPHTML () throws DirectorException
void	parse (File file) throws DirectorException
void	parse (String xml) throws DirectorException
String	text ()
	returns the resulting document.
Vector	anchors ()
	returns a Vector of anchor names in the parsed text.
Vector	headings ()
	returns a Vector of headings.
Vector	headingLevels ()
	returns a Vector of headingLevels (Integer objects).
void	startDocument ()
void	startElement (String uri, String name, String qName, Attributes atts)
void	endElement (String uri, String name, String qName)
void	characters (char ch[], int start, int length)
void	fatalError (SAXParseException exception)
String	anchorPrefix ()
	Accessor for attribute anchorPrefix.
String	anchorPrefix (String anchorPrefix)
	Mutator for attribute anchorPrefix.
int	headingLevel ()
	Accessor for attribute headingLevel.
int	headingLevel (int headingLevel)
	Mutator for attribute headingLevel.
Vector	subheadings ()
	returns a Vector of subheadings.
Vector	references ()
	returns a Vector of references (href) that were found in the parsed document.
Hashtable	refReplace ()
	Accessor for attribute refReplace.
Hashtable	refReplace (Hashtable refReplace)
	Mutator for attribute refReplace.
void	injectInline () throws DirectorException
Protected Member Functions
int	adjustedLevel (String name)
Protected Attributes
XMLReader	reader
XmlCreator	text
Vector	anchors = new Vector()
Vector	headings = new Vector()
Vector	headingLevels = new Vector()
Vector	subheadings = new Vector()
Hashtable	referencesSeen = new Hashtable()
Vector	references = new Vector()
boolean	inInline = false
int	errorLine = 0
int	errorColumn = 0
int	topHeadNode = 6
String	anchorPrefix = ""
	The string that is prepended to every anchor inserted for title elements.
int	headingLevel = 0
	If set, the heading tags are adjusted, so that the top level heading of the parsed document is below the headingLevel.
Hashtable	refReplace = null
	replace hrefs by those
Static Package Attributes
static final String	inlineMarker = "###INLINE###"
static final String	endMarker = "###"

---

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocPHTML.DocPHTML (   )  throws DirectorException

---

Member Function Documentation

int sfi.director.application.autodoc.DocPHTML.adjustedLevel (  String  name  )  [protected]

String sfi.director.application.autodoc.DocPHTML.anchorPrefix (  String  anchorPrefix  )

Mutator for attribute anchorPrefix. The string that is prepended to every anchor inserted for title elements. If not set, no prefix is used.

String sfi.director.application.autodoc.DocPHTML.anchorPrefix (   )

Accessor for attribute anchorPrefix. The string that is prepended to every anchor inserted for title elements. If not set, no prefix is used.

Vector sfi.director.application.autodoc.DocPHTML.anchors (   )

returns a Vector of anchor names in the parsed text. Each anchor name corresponds with an entry in headings().

void sfi.director.application.autodoc.DocPHTML.characters (  char  ch[], int  start, int  length )

Reimplemented from sfi.director.application.autodoc.DocXHTML.

void sfi.director.application.autodoc.DocPHTML.endElement (  String  uri, String  name, String  qName )

Reimplemented from sfi.director.application.autodoc.DocXHTML.

void sfi.director.application.autodoc.DocPHTML.fatalError (  SAXParseException  exception  )

Reimplemented from sfi.director.application.autodoc.DocXHTML.

int sfi.director.application.autodoc.DocPHTML.headingLevel (  int  headingLevel  )

Mutator for attribute headingLevel. If set, the heading tags are adjusted, so that the top level heading of the parsed document is below the headingLevel.

int sfi.director.application.autodoc.DocPHTML.headingLevel (   )

Accessor for attribute headingLevel. If set, the heading tags are adjusted, so that the top level heading of the parsed document is below the headingLevel.

Vector sfi.director.application.autodoc.DocPHTML.headingLevels (   )

returns a Vector of headingLevels (Integer objects). Each entry corresponds with an entry in anchors() / headings()

Vector sfi.director.application.autodoc.DocPHTML.headings (   )

returns a Vector of headings. Each heading corresponds with an entry in anchors().

void sfi.director.application.autodoc.DocPHTML.injectInline (   )  throws DirectorException

void sfi.director.application.autodoc.DocPHTML.parse (  String  xml  )  throws DirectorException

void sfi.director.application.autodoc.DocPHTML.parse (  File  file  )  throws DirectorException

Vector sfi.director.application.autodoc.DocPHTML.references (   )

returns a Vector of references (href) that were found in the parsed document.

Hashtable sfi.director.application.autodoc.DocPHTML.refReplace (  Hashtable  refReplace  )

Mutator for attribute refReplace. replace hrefs by those

Hashtable sfi.director.application.autodoc.DocPHTML.refReplace (   )

Accessor for attribute refReplace. replace hrefs by those

void sfi.director.application.autodoc.DocPHTML.startDocument (   )

Reimplemented from sfi.director.application.autodoc.DocXHTML.

void sfi.director.application.autodoc.DocPHTML.startElement (  String  uri, String  name, String  qName, Attributes  atts )

Reimplemented from sfi.director.application.autodoc.DocXHTML.

Vector sfi.director.application.autodoc.DocPHTML.subheadings (   )

returns a Vector of subheadings. Each entry corresponds with an entry * in anchors() / headings(). If no subheading is available at an index, an * empty string is stored in the list. *

String sfi.director.application.autodoc.DocPHTML.text (   )

returns the resulting document.

---

Member Data Documentation

String sfi.director.application.autodoc.DocPHTML.anchorPrefix = "" [protected]

The string that is prepended to every anchor inserted for title elements. If not set, no prefix is used.

Vector sfi.director.application.autodoc.DocPHTML.anchors = new Vector() [protected]

final String sfi.director.application.autodoc.DocPHTML.endMarker = "###" [static, package]

int sfi.director.application.autodoc.DocPHTML.errorColumn = 0 [protected]

int sfi.director.application.autodoc.DocPHTML.errorLine = 0 [protected]

int sfi.director.application.autodoc.DocPHTML.headingLevel = 0 [protected]

If set, the heading tags are adjusted, so that the top level heading of the parsed document is below the headingLevel.

Vector sfi.director.application.autodoc.DocPHTML.headingLevels = new Vector() [protected]

Vector sfi.director.application.autodoc.DocPHTML.headings = new Vector() [protected]

boolean sfi.director.application.autodoc.DocPHTML.inInline = false [protected]

final String sfi.director.application.autodoc.DocPHTML.inlineMarker = "###INLINE###" [static, package]

XMLReader sfi.director.application.autodoc.DocPHTML.reader [protected]

Vector sfi.director.application.autodoc.DocPHTML.references = new Vector() [protected]

Hashtable sfi.director.application.autodoc.DocPHTML.referencesSeen = new Hashtable() [protected]

Hashtable sfi.director.application.autodoc.DocPHTML.refReplace = null [protected]

replace hrefs by those

Vector sfi.director.application.autodoc.DocPHTML.subheadings = new Vector() [protected]

XmlCreator sfi.director.application.autodoc.DocPHTML.text [protected]

int sfi.director.application.autodoc.DocPHTML.topHeadNode = 6 [protected]

---

The documentation for this class was generated from the following file:

• director/application/autodoc/DocPHTML.java

---