|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.acm.seguin.pretty.JavaDocComponent
public class JavaDocComponent
Store a portion of a javadoc item
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 |
---|
public JavaDocComponent()
Method Detail |
---|
public void setDescription(java.lang.String newDescription)
newDescription
- the new descriptionpublic void setLongestLength(int newLongestLength)
newLongestLength
- the new longestLengthpublic void setRequired(boolean req)
req
- true if it is requiredpublic void setType(java.lang.String newType)
newType
- the new typepublic java.lang.String getDescription()
public int getLongestLength()
public java.lang.String getType()
public boolean isPrinted()
public boolean isRequired()
public void print(PrintData printData)
printData
- printDataprotected void setPrinted(boolean prn)
prn
- Description of Parameterprotected void leaveDescription(PrintData printData)
printData
- the print dataprotected void printDescription(PrintData printData)
printData
- the print dataprotected void wordwrapDescription(PrintData printData, int indent)
printData
- the print dataindent
- the number of spaces to indent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |