Represents one chapter in the documentation. More...

Public Member Functions
	DocChapter ()
	DocChapter (String title[])
	DocChapter (DocChapter parent, String title)
	Create a new sub chapter within the given parent chapter.
String[]	childTitle (String title)
StringBuffer	text ()
	Accessor for attribute text.
StringBuffer	text (StringBuffer text)
	Mutator for attribute text.
void	addText (String text)
	Add a piece of text to the chapter contents.
void	addTag (String tag, String attributes, String text)
void	addBlock (String text)
	Add a text block (a div, actually).
void	addParagraph (String text)
	Add a paragraph.
void	addCode (String text)
	Add verbatim text that is supposed to be formatted as a code example.
void	addChapterRef (Vector refs, boolean withSubheading, Vector texts)
	Add a list of references to chapters.
void	addChapterRef (Vector refs, boolean withSubheading)
void	addChapterRef (DocChapter ref, boolean withSubheading)
	Add one reference to a chapter (like addChapterRef(Vector, boolean)).
void	addChapterRef (DocChapter ref, boolean withSubheading, String additionalText)
	Add one reference to a chapter (like addChapterRef(Vector, boolean)).
void	addChapterRefWithTemplate (DocChapter ref, DocInfo info)
	Add one reference to a chapter as specified in the DocInfo record.
void	addToRefChapter (DocBuilder builder, DocChapter targetChapter, String subChapterTitle, String additionalText)
	Add a reference to ourselves to the subchapter of targetChapter with the title subChapterTitle.
void	addToRefChapter (DocBuilder builder, DocChapter targetChapter, String subChapterTitle)
	Add a reference to ourselves to the subchapter of targetChapter with the title subChapterTitle.
void	addFile (File file) throws DirectorException
	Add contents read from a (optionally xhtml formatted) text file.
void	addFile (String text) throws DirectorException
	Add content from a PHTML String.
File	addImage (DocBuilder builder, File imagefile, int maxwidth, int maxheight, String caption)
	Add an image, optionally with caption.
File	addImage (DocBuilder builder, File imagefile, String caption)
	Like addImage(DocBuilder, File, int, int, String ), but uses defaults for maxwidth and maxheight argument.
File	addImage (DocBuilder builder, File imagefile)
	Like addImage(DocBuilder, File, int, int, String ), but uses defaults for maxwidth and maxheight argument.
String[]	title ()
	Accessor for attribute title.
String	heading ()
	Return the actual title text with hierarchy stripped off.
String[]	title (String title[])
	Mutator for attribute title.
void	resetText ()
String	label ()
	Accessor for attribute label.
String	label (String label)
	Mutator for attribute label.
Vector	aliasLabels ()
	Accessor for attribute aliasLabels.
Vector	aliasLabels (Vector aliasLabels)
	Mutator for attribute aliasLabels.
String	subheading ()
	Accessor for attribute subheading.
String	subheading (String subheading)
	Mutator for attribute subheading.
String	toString ()
String	parentToString ()
	Return string representation of the alleged parent chapter.
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).
Vector	subheadings ()
	returns a Vector of subheadings.
boolean	isReferring (String ref)
	check if this chapter refers to the passed reference.
void	addRef (String ref)
	remember the given ref as a reference this chapter refers to.
void	addRef (Vector refs)
	remember the given refs as a reference this chapter refers to.
void	addRefLabel (String label)
	remember a reference to the given label as a reference this chapter refers to.
void	addRefLabel (Vector labels)
	remember the given label references as a reference this chapter refers to.
Vector	findReferences ()
	return a Vector of ref targets this chapter refers to.
boolean	onlyIncludeIfReferred ()
	Accessor for attribute onlyIncludeIfReferred.
boolean	onlyIncludeIfReferred (boolean onlyIncludeIfReferred)
	Mutator for attribute onlyIncludeIfReferred.

Static Public Member Functions
static String	verbatim (String text)
	Alters text so that it can safely used in xhtml as a verbatim text.

Protected Attributes
StringBuffer	text = new StringBuffer()
	chapter contents
String	title [] = new String[0]
	chapter title
String	label = "c" + sequence++
	Unique label of this chapter.
Vector	aliasLabels = new Vector()
	alternative labels
String	subheading = null
	Subheading / Teaser.
boolean	onlyIncludeIfReferred = false
	if set, chapter is only included in the docu if referred by another chapter

Detailed Description

Represents one chapter in the documentation.

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocChapter.DocChapter ( )

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), and sfi.director.application.autodoc.DocChapter.addToRefChapter().

sfi.director.application.autodoc.DocChapter.DocChapter ( String title[] )

References sfi.director.application.autodoc.DocChapter.title().

sfi.director.application.autodoc.DocChapter.DocChapter	(	DocChapter	parent,
		String	title
	)

Create a new sub chapter within the given parent chapter.

References sfi.director.application.autodoc.DocChapter.childTitle(), and sfi.director.application.autodoc.DocChapter.title().

Member Function Documentation

void sfi.director.application.autodoc.DocChapter.addBlock ( String text )

Add a text block (a div, actually).

References sfi.director.application.autodoc.DocChapter.addTag().

void sfi.director.application.autodoc.DocChapter.addChapterRef	(	Vector	refs,
		boolean	withSubheading,
		Vector	texts
	)

Add a list of references to chapters.

For conveniency, the chapter vector may contain null values which are ignored.

Parameters

refs	a list of DocChapters to be referred
withSubHeading	if true, the subheading text is included in the reference text
texts	(optional) list of texts to be included in the respective reference

References sfi.director.application.autodoc.DocChapter.addRef(), sfi.director.application.autodoc.DocChapter.addRefLabel(), sfi.director.application.autodoc.DocChapter.addText(), sfi.director.application.autodoc.DocChapter.aliasLabels, sfi.director.application.autodoc.DocChapter.DocChapter(), sfi.director.application.autodoc.DocChapter.heading(), sfi.director.application.autodoc.DocChapter.label, sfi.director.application.autodoc.DocChapter.subheading, and sfi.director.application.autodoc.DocChapter.text().

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocChapter.addChapterRefWithTemplate(), sfi.director.application.autodoc.DocChapter.addToRefChapter(), sfi.director.application.autodoc.DocBuilder.configfilesdoc(), sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.hostdoc(), and sfi.director.application.autodoc.DocInfo.locationDocu().

void sfi.director.application.autodoc.DocChapter.addChapterRef	(	Vector	refs,
		boolean	withSubheading
	)

See Also: addChapterRef( Vector, boolean, Vector )

References sfi.director.application.autodoc.DocChapter.addChapterRef().

void sfi.director.application.autodoc.DocChapter.addChapterRef	(	DocChapter	ref,
		boolean	withSubheading
	)

Add one reference to a chapter (like addChapterRef(Vector, boolean)).

References sfi.director.application.autodoc.DocChapter.addChapterRef().

void sfi.director.application.autodoc.DocChapter.addChapterRef	(	DocChapter	ref,
		boolean	withSubheading,
		String	additionalText
	)

Add one reference to a chapter (like addChapterRef(Vector, boolean)).

References sfi.director.application.autodoc.DocChapter.addChapterRef().

void sfi.director.application.autodoc.DocChapter.addChapterRefWithTemplate	(	DocChapter	ref,
		DocInfo	info
	)

Add one reference to a chapter as specified in the DocInfo record.

References sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.templateText(), and sfi.director.application.autodoc.DocChapter.text().

Referenced by sfi.director.application.autodoc.DocBuilder.hostdoc().

void sfi.director.application.autodoc.DocChapter.addCode ( String text )

Add verbatim text that is supposed to be formatted as a code example.

References sfi.director.application.autodoc.DocChapter.addTag().

Referenced by sfi.director.application.autodoc.DocBuilder.configfilesdoc().

void sfi.director.application.autodoc.DocChapter.addFile ( File file ) throws DirectorException

Add contents read from a (optionally xhtml formatted) text file.

Referenced by sfi.director.application.autodoc.DocChapter.addFile(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocBuilder.addMasterChapter(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

void sfi.director.application.autodoc.DocChapter.addFile ( String text ) throws DirectorException

Add content from a PHTML String.

References sfi.director.application.autodoc.DocChapter.addFile(), and sfi.director.application.autodoc.DocChapter.text().

File sfi.director.application.autodoc.DocChapter.addImage	(	DocBuilder	builder,
		File	imagefile,
		int	maxwidth,
		int	maxheight,
		String	caption
	)

Add an image, optionally with caption.

If the images size exceeds a given limit, a thumbnail is generated and a link to the large image inserted. In case a thumbnail is used, addImage() returns the thumbfile, otherwise it returns null.

References sfi.director.application.autodoc.DocBuilder.addMediaFile(), sfi.director.application.autodoc.DocChapter.addText(), sfi.director.util.ImageInfo.height, sfi.director.application.autodoc.DocBuilder.nextPath(), sfi.director.util.ImageInfo.thumbnail(), and sfi.director.util.ImageInfo.width.

Referenced by sfi.director.application.autodoc.DocChapter.addImage(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocBuilder.domaindoc(), and sfi.director.application.autodoc.DocBuilder.insertDependencyGraph().

File sfi.director.application.autodoc.DocChapter.addImage	(	DocBuilder	builder,
		File	imagefile,
		String	caption
	)

Like addImage(DocBuilder, File, int, int, String ), but uses defaults for maxwidth and maxheight argument.

References sfi.director.application.autodoc.DocChapter.addImage().

File sfi.director.application.autodoc.DocChapter.addImage	(	DocBuilder	builder,
		File	imagefile
	)

Like addImage(DocBuilder, File, int, int, String ), but uses defaults for maxwidth and maxheight argument.

References sfi.director.application.autodoc.DocChapter.addImage().

void sfi.director.application.autodoc.DocChapter.addParagraph ( String text )

Add a paragraph.

References sfi.director.application.autodoc.DocChapter.addTag().

void sfi.director.application.autodoc.DocChapter.addRef ( String ref )

remember the given ref as a reference this chapter refers to.

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocChapter.addRef(), and sfi.director.application.autodoc.DocChapter.addRefLabel().

void sfi.director.application.autodoc.DocChapter.addRef ( Vector refs )

remember the given refs as a reference this chapter refers to.

References sfi.director.application.autodoc.DocChapter.addRef().

void sfi.director.application.autodoc.DocChapter.addRefLabel ( String label )

remember a reference to the given label as a reference this chapter refers to.

References sfi.director.application.autodoc.DocChapter.addRef().

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), and sfi.director.application.autodoc.DocChapter.addRefLabel().

void sfi.director.application.autodoc.DocChapter.addRefLabel ( Vector labels )

remember the given label references as a reference this chapter refers to.

References sfi.director.application.autodoc.DocChapter.addRefLabel().

void sfi.director.application.autodoc.DocChapter.addTag	(	String	tag,
		String	attributes,
		String	text
	)

References sfi.director.application.autodoc.DocChapter.text().

Referenced by sfi.director.application.autodoc.DocChapter.addBlock(), sfi.director.application.autodoc.DocChapter.addCode(), and sfi.director.application.autodoc.DocChapter.addParagraph().

void sfi.director.application.autodoc.DocChapter.addText ( String text )

Add a piece of text to the chapter contents.

References sfi.director.application.autodoc.DocChapter.text().

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocChapter.addImage(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.DocBuilder.configfilesdoc(), sfi.director.application.autodoc.DocBuilder.domaindoc(), and sfi.director.application.autodoc.DocBuilder.hostdoc().

void sfi.director.application.autodoc.DocChapter.addToRefChapter	(	DocBuilder	builder,
		DocChapter	targetChapter,
		String	subChapterTitle,
		String	additionalText
	)

Add a reference to ourselves to the subchapter of targetChapter with the title subChapterTitle.

If the subchapter does not exist, creates one. For conveniency, the targetChapter may be null and in this case the method returns without function.

References sfi.director.application.autodoc.DocBuilder.addChapter(), sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocChapter.DocChapter(), and sfi.director.application.autodoc.DocBuilder.getChapter().

Referenced by sfi.director.application.autodoc.DocChapter.addToRefChapter(), sfi.director.application.autodoc.DocBuilder.domaindoc(), sfi.director.application.autodoc.DocBuilder.genericObjDoc(), and sfi.director.application.autodoc.DocBuilder.hostdoc().

void sfi.director.application.autodoc.DocChapter.addToRefChapter	(	DocBuilder	builder,
		DocChapter	targetChapter,
		String	subChapterTitle
	)

Add a reference to ourselves to the subchapter of targetChapter with the title subChapterTitle.

If the subchapter does not exist, creates one. For conveniency, the targetChapter may be null and in this case the method returns without function.

References sfi.director.application.autodoc.DocChapter.addToRefChapter().

Vector sfi.director.application.autodoc.DocChapter.aliasLabels ( )

Accessor for attribute aliasLabels.

alternative labels

Referenced by sfi.director.application.autodoc.DocChapter.aliasLabels().

Vector sfi.director.application.autodoc.DocChapter.aliasLabels ( Vector aliasLabels )

Mutator for attribute aliasLabels.

alternative labels

References sfi.director.application.autodoc.DocChapter.aliasLabels().

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

returns a Vector of anchor names in the parsed text.

Each anchor name corresponds with an entry in headings().

Referenced by sfi.director.application.autodoc.DocChapter.label(), sfi.director.application.autodoc.DocChapter.resetText(), and sfi.director.application.autodoc.DocChapter.title().

String [] sfi.director.application.autodoc.DocChapter.childTitle ( String title )

References sfi.director.application.autodoc.DocChapter.title().

Referenced by sfi.director.application.autodoc.DocChapter.DocChapter(), and sfi.director.application.autodoc.DocBuilder.hostdoc().

Vector sfi.director.application.autodoc.DocChapter.findReferences ( )

return a Vector of ref targets this chapter refers to.

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocChapter.heading ( )

Return the actual title text with hierarchy stripped off.

This returns the last component of the title hierarchy.

References sfi.director.application.autodoc.DocChapter.title().

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), and sfi.director.application.autodoc.DocChapter.title().

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

returns a Vector of headingLevels (Integer objects).

Each entry corresponds with an entry in anchors() / headings()

Referenced by sfi.director.application.autodoc.DocChapter.resetText(), and sfi.director.application.autodoc.DocChapter.title().

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

returns a Vector of headings.

Each heading corresponds with an entry in anchors().

Referenced by sfi.director.application.autodoc.DocChapter.resetText(), and sfi.director.application.autodoc.DocChapter.title().

boolean sfi.director.application.autodoc.DocChapter.isReferring ( String ref )

check if this chapter refers to the passed reference.

String sfi.director.application.autodoc.DocChapter.label ( )

Accessor for attribute label.

Unique label of this chapter.

Referenced by sfi.director.application.autodoc.DocChapter.label(), and sfi.director.application.autodoc.DocChapter.title().

String sfi.director.application.autodoc.DocChapter.label ( String label )

Mutator for attribute label.

Unique label of this chapter.

References sfi.director.application.autodoc.DocChapter.anchors(), and sfi.director.application.autodoc.DocChapter.label().

boolean sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred ( )

Accessor for attribute onlyIncludeIfReferred.

if set, chapter is only included in the docu if referred by another chapter

Referenced by sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred().

boolean sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred ( boolean onlyIncludeIfReferred )

Mutator for attribute onlyIncludeIfReferred.

if set, chapter is only included in the docu if referred by another chapter

References sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred().

String sfi.director.application.autodoc.DocChapter.parentToString ( )

Return string representation of the alleged parent chapter.

Referenced by sfi.director.application.autodoc.DocBuilder.makeStructure().

void sfi.director.application.autodoc.DocChapter.resetText ( )

References sfi.director.application.autodoc.DocChapter.anchors(), sfi.director.application.autodoc.DocChapter.headingLevels(), sfi.director.application.autodoc.DocChapter.headings(), sfi.director.application.autodoc.DocChapter.text(), and sfi.director.application.autodoc.DocChapter.title().

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocChapter.subheading ( )

Accessor for attribute subheading.

Subheading / Teaser.

Referenced by sfi.director.application.autodoc.DocChapter.subheading(), and sfi.director.application.autodoc.DocChapter.title().

String sfi.director.application.autodoc.DocChapter.subheading ( String subheading )

Mutator for attribute subheading.

Subheading / Teaser.

References sfi.director.application.autodoc.DocChapter.subheading(), and sfi.director.application.autodoc.DocChapter.subheadings().

Vector sfi.director.application.autodoc.DocChapter.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.

Referenced by sfi.director.application.autodoc.DocChapter.subheading(), and sfi.director.application.autodoc.DocChapter.title().

StringBuffer sfi.director.application.autodoc.DocChapter.text ( )

Accessor for attribute text.

chapter contents

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocChapter.addChapterRefWithTemplate(), sfi.director.application.autodoc.DocChapter.addFile(), sfi.director.application.autodoc.DocChapter.addTag(), sfi.director.application.autodoc.DocChapter.addText(), sfi.director.application.autodoc.DocChapter.resetText(), and sfi.director.application.autodoc.DocChapter.text().

StringBuffer sfi.director.application.autodoc.DocChapter.text ( StringBuffer text )

Mutator for attribute text.

chapter contents

References sfi.director.application.autodoc.DocChapter.text().

String [] sfi.director.application.autodoc.DocChapter.title ( )

Accessor for attribute title.

chapter title

Referenced by sfi.director.application.autodoc.DocChapter.childTitle(), sfi.director.application.autodoc.DocChapter.DocChapter(), sfi.director.application.autodoc.DocChapter.heading(), sfi.director.application.autodoc.DocChapter.resetText(), and sfi.director.application.autodoc.DocChapter.title().

String [] sfi.director.application.autodoc.DocChapter.title ( String title[] )

Mutator for attribute title.

chapter title

References sfi.director.application.autodoc.DocChapter.anchors(), sfi.director.application.autodoc.DocChapter.heading(), sfi.director.application.autodoc.DocChapter.headingLevels(), sfi.director.application.autodoc.DocChapter.headings(), sfi.director.application.autodoc.DocChapter.label(), sfi.director.application.autodoc.DocChapter.subheading(), sfi.director.application.autodoc.DocChapter.subheadings(), and sfi.director.application.autodoc.DocChapter.title().

String sfi.director.application.autodoc.DocChapter.toString ( )

Referenced by sfi.director.application.autodoc.DocBuilder.addChapter(), sfi.director.application.autodoc.DocBuilder.configfilesdoc(), and sfi.director.application.autodoc.DocBuilder.getChapter().

static String sfi.director.application.autodoc.DocChapter.verbatim ( String text )

static

Alters text so that it can safely used in xhtml as a verbatim text.

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter(), sfi.director.application.autodoc.ConfigFile.citeFile(), and sfi.director.application.autodoc.DocBuilder.hostdoc().

Member Data Documentation

Vector sfi.director.application.autodoc.DocChapter.aliasLabels = new Vector()

protected

alternative labels

Referenced by sfi.director.application.autodoc.DocBuilder.addChapter(), sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), and sfi.director.application.autodoc.DocBuilder.configfilesdoc().

String sfi.director.application.autodoc.DocChapter.label = "c" + sequence++

protected

Unique label of this chapter.

Referenced by sfi.director.application.autodoc.DocBuilder.addChapter(), sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

boolean sfi.director.application.autodoc.DocChapter.onlyIncludeIfReferred = false

protected

if set, chapter is only included in the docu if referred by another chapter

Referenced by sfi.director.application.autodoc.DocInfo.addIntroChapter(), and sfi.director.application.autodoc.Formathtml.genIndex().

String sfi.director.application.autodoc.DocChapter.subheading = null

protected

Subheading / Teaser.

Referenced by sfi.director.application.autodoc.DocChapter.addChapterRef(), sfi.director.application.autodoc.DocInfo.addIntroChapter(), and sfi.director.application.autodoc.DocBuilder.addMasterChapter().

StringBuffer sfi.director.application.autodoc.DocChapter.text = new StringBuffer()

protected

chapter contents

Referenced by sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

String sfi.director.application.autodoc.DocChapter.title[] = new String[0]

protected

chapter title

Referenced by sfi.director.application.autodoc.DocBuilder.makeStructure(), and sfi.director.application.autodoc.DocBuilder.slurpExternalDocs().

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

director/src/sfi/director/application/autodoc/DocChapter.java

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation