org.acm.seguin.pretty
Class JavaDocComponent

java.lang.Object
  org.acm.seguin.pretty.JavaDocComponent

Direct Known Subclasses:

NamedJavaDocComponent, XDocletJavaDocComponent

public class JavaDocComponent
extends java.lang.Object

Store a portion of a javadoc item

Author:

Chris Seguin

Constructor Summary

JavaDocComponent()
Create an instance of this java doc object

Method Summary

java.lang.String	getDescription() Return the description
int	getLongestLength() Return the longestLength
java.lang.String	getType() Return the type
boolean	isPrinted() Return whether this node has been printed
boolean	isRequired() Return whether this node is required
protected void	leaveDescription(PrintData printData) Print the drescription
void	print(PrintData printData) Print this tag
protected void	printDescription(PrintData printData) Print the drescription
void	setDescription(java.lang.String newDescription) Set the description
void	setLongestLength(int newLongestLength) Set the longestLength
protected void	setPrinted(boolean prn) Note that this node has been printed
void	setRequired(boolean req) Note that this node is required
void	setType(java.lang.String newType) Set the type
protected void	wordwrapDescription(PrintData printData, int indent) Print the drescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaDocComponent

public JavaDocComponent()

Create an instance of this java doc object

Method Detail

setDescription

public void setDescription(java.lang.String newDescription)

Set the description

Parameters:

newDescription - the new description

setLongestLength

public void setLongestLength(int newLongestLength)

Set the longestLength

Parameters:

newLongestLength - the new longestLength

setRequired

public void setRequired(boolean req)

Note that this node is required

Parameters:

req - true if it is required

setType

public void setType(java.lang.String newType)

Set the type

Parameters:

newType - the new type

getDescription

public java.lang.String getDescription()

Return the description

Returns:

the description

getLongestLength

public int getLongestLength()

Return the longestLength

Returns:

the longestLength

getType

public java.lang.String getType()

Return the type

Returns:

the type

isPrinted

public boolean isPrinted()

Return whether this node has been printed

Returns:

true if it was printed

isRequired

public boolean isRequired()

Return whether this node is required

Returns:

true if it is required

print

public void print(PrintData printData)

Print this tag

Parameters:

printData - printData

setPrinted

protected void setPrinted(boolean prn)

Note that this node has been printed

Parameters:

prn - Description of Parameter

leaveDescription

protected void leaveDescription(PrintData printData)

Print the drescription

Parameters:

printData - the print data

printDescription

protected void printDescription(PrintData printData)

Print the drescription

Parameters:

printData - the print data

wordwrapDescription

protected void wordwrapDescription(PrintData printData,
                                   int indent)

Print the drescription

Parameters:

printData - the print data

indent - the number of spaces to indent