| |
|
| java.lang.Object org.acm.seguin.pretty.JavaDocComponent
All known Subclasses: org.acm.seguin.pretty.NamedJavaDocComponent, org.acm.seguin.pretty.XDocletJavaDocComponent,
JavaDocComponent | public class JavaDocComponent (Code) | | Store a portion of a javadoc item
author: Chris Seguin |
JavaDocComponent | public JavaDocComponent()(Code) | | Create an instance of this java doc object
|
getDescription | public String getDescription()(Code) | | Return the description
the description |
getLongestLength | public int getLongestLength()(Code) | | Return the longestLength
the longestLength |
getType | public String getType()(Code) | | Return the type
the type |
isDescription | boolean isDescription()(Code) | | returns true if this is a description
true if it is a description |
isPrinted | public boolean isPrinted()(Code) | | Return whether this node has been printed
true if it was printed |
isRequired | public boolean isRequired()(Code) | | Return whether this node is required
true if it is required |
leaveDescription | protected void leaveDescription(PrintData printData)(Code) | | Print the drescription
Parameters: printData - the print data |
print | public void print(PrintData printData)(Code) | | Print this tag
Parameters: printData - printData |
printDescription | protected void printDescription(PrintData printData)(Code) | | Print the drescription
Parameters: printData - the print data |
setDescription | public void setDescription(String newDescription)(Code) | | Set the description
Parameters: newDescription - the new description |
setLongestLength | public void setLongestLength(int newLongestLength)(Code) | | Set the longestLength
Parameters: newLongestLength - the new longestLength |
setPrinted | protected void setPrinted(boolean prn)(Code) | | Note that this node has been printed
Parameters: prn - Description of Parameter |
setRequired | public void setRequired(boolean req)(Code) | | Note that this node is required
Parameters: req - true if it is required |
setType | public void setType(String newType)(Code) | | Set the type
Parameters: newType - the new type |
wordwrapDescription | protected void wordwrapDescription(PrintData printData, int indent)(Code) | | Print the drescription
Parameters: printData - the print data Parameters: indent - the number of spaces to indent |
|
|
|