|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
gui.JDFrame
This class is the GUI for the JavaDoctor program. It interacts with the user, of course, and JDControl, which does the internal stuff. That would be the conversion etc.
Nested Class Summary |
Nested classes inherited from class java.awt.Frame |
Frame.AccessibleAWTFrame |
Nested classes inherited from class java.awt.Window |
Window.AccessibleAWTWindow |
Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
protected TagPanel |
attributepanel
The TagPanel for the attribute tags. |
protected ButtonPanel |
buttonpanel
The ButonPanel for the buttons. |
protected TagPanel |
classpanel
The TagPanel for the class tags. |
protected JDControl |
control
The control class for this GUI. |
protected FolderPanel |
folderpanel
The FolderPanel for the folders. |
protected ListPanel |
listpanel
The ListPanel for the list. |
protected TagPanel |
methodpanel
The TagPanel for the method tags. |
Fields inherited from class java.awt.Frame |
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR |
Fields inherited from class java.awt.Window |
|
Fields inherited from class java.awt.Container |
|
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
JDFrame()
Construct a new JDFrame to have the user stare at in awe. |
Method Summary | |
void |
addAttributeTag(String attributetag)
Adds an attribute tag to the attributetag list. |
void |
addAttributeTag(String attributetag,
int index)
Adds an attribute tag to the attributetag list on the passed index. |
void |
addClassTag(String classtag)
Adds a class tag to the classtag list. |
void |
addClassTag(String classtag,
int index)
Adds a class tag to the classtag list on the passed index. |
void |
addMethodTag(String methodtag)
Adds a method tag to the methodtag list. |
void |
addMethodTag(String methodtag,
int index)
Adds a method tag to the methodtag list on the passed index. |
void |
deselectAllFiles()
Deselects all the files in the list of files. |
boolean |
getAddAttributeComment()
Returns whether the user wants comments to be added to their attributes. |
boolean |
getAddClassComment()
Returns whether the user wants comments to be added to their classes. |
boolean |
getAddMethodComment()
Returns whether the user wants comments to be added to their methods. |
String[] |
getAttributeTags()
Returns the list of tags the user wants to use in the attribute comments. |
String |
getAttributeWhiteLines()
Returns the amount of white lines the user wants to be added before an attribute. |
String[] |
getClassTags()
Returns the list of tags the user wants to use in the class comments. |
String |
getClassWhiteLines()
Returns the amount of white lines the user wants to be added before a class. |
boolean |
getConvertAttributeComment()
Returns whether the user wants attribute comments to be converted. |
boolean |
getConvertClassComment()
Returns whether the user wants class comments to be converted. |
boolean |
getConvertMethodComment()
Returns whether the user wants method comments to be converted. |
String[] |
getFileList()
Returns a list of the selected filenames. |
String |
getInputFolder()
Returns the Input Folder that the user has chosen. |
String[] |
getMethodTags()
Returns the list of tags the user wants to use in the method comments. |
String |
getMethodWhiteLines()
Returns the amount of white lines the user wants to be added before a method. |
int |
getNumberOfAttributeTags()
Returns the amount of attribute tags. |
int |
getNumberOfClassTags()
Returns the amount of class tags. |
int |
getNumberOfMethodTags()
Returns the amount of method tags. |
String |
getOutputFolder()
Returns the Output Folder that the user has chosen. |
String |
getPopupText(String message)
Returns the String entered by the user a popped up dialog box. |
String |
getSelectedAttributeTag()
Returns the currently selected attribute tag. |
int |
getSelectedAttributeTagIndex()
Returns the index of the currently selected attribute tag. |
String |
getSelectedClassTag()
Returns the currently selected class tag. |
int |
getSelectedClassTagIndex()
Returns the index of the currently selected class tag. |
String |
getSelectedMethodTag()
Returns the currently selected method tag. |
int |
getSelectedMethodTagIndex()
Returns the index of the currently selected method tag. |
boolean |
getStarInsets()
Returns whether the star insets style of commentins should be used. |
boolean |
outputFolderIsInputFolder()
Returns whether the user wants to have the Output Folder the same as the Input Folder. |
void |
popup(String message)
Shows a Dialog with the passed message. |
void |
removeAttributeTag(int index)
Removes an attribute tag from the attributetag list. |
void |
removeClassTag(int index)
Removes a class tag from the classtag list. |
void |
removeMethodTag(int index)
Removes a method tag from the methodtag list. |
void |
selectAllFiles()
Selects all the files in the list of files. |
void |
selectAttributeTag(int index)
Selects the attribute tag at the passed index. |
void |
selectClassTag(int index)
Selects the class tag at the passed index. |
void |
selectMethodTag(int index)
Selects the method tag at the passed index. |
void |
setFileList(String[] filelist)
Set the list of the filenames to the passed filenames. |
Methods inherited from class java.awt.Frame |
addNotify, finalize, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.awt.MenuContainer |
getFont, postEvent |
Field Detail |
protected FolderPanel folderpanel
protected ButtonPanel buttonpanel
protected ListPanel listpanel
protected TagPanel classpanel
protected TagPanel methodpanel
protected TagPanel attributepanel
protected JDControl control
Constructor Detail |
public JDFrame()
Construct a new JDFrame to have the user stare at in awe. Perhaps. Sets the title to a standard funky thing. Or maybe not so funky.
Furthermore it initialises a lot of stuff. Like components... action commands... yeah... that stuff.
Method Detail |
public void popup(String message)
message
- the passed message.public String getPopupText(String message)
message
- The message asking for a tag.
null
if the user canceled.public String getInputFolder()
public String getOutputFolder()
public boolean outputFolderIsInputFolder()
public String[] getFileList()
public void setFileList(String[] filelist)
filelist
- A list of filenames.public boolean getStarInsets()
public void addClassTag(String classtag)
classtag
- The classtag to be added.public void addClassTag(String classtag, int index)
classtag
- The classtag to be added.index
- The index to add the passed classtag on.public void removeClassTag(int index)
index
- The index of the class tag to be removed.public int getNumberOfClassTags()
public int getSelectedClassTagIndex()
public String getSelectedClassTag()
public void selectClassTag(int index)
index
- The index of the class tag to be added.public String[] getClassTags()
String
s that represent tags.public boolean getConvertClassComment()
public boolean getAddClassComment()
public String getClassWhiteLines()
String
).public void addMethodTag(String methodtag)
methodtag
- The methodtag to be added.public void addMethodTag(String methodtag, int index)
methodtag
- The methodtag to be added.index
- The index to add the passed methodtag on.public void removeMethodTag(int index)
index
- The index of the methodtag to be removed.public int getNumberOfMethodTags()
public int getSelectedMethodTagIndex()
public String getSelectedMethodTag()
public void selectMethodTag(int index)
index
- The index of the method tag to be added.public String[] getMethodTags()
String
s that represent tags.public boolean getConvertMethodComment()
public boolean getAddMethodComment()
public String getMethodWhiteLines()
String
).public void addAttributeTag(String attributetag)
attributetag
- The attributetag to be added.public void addAttributeTag(String attributetag, int index)
attributetag
- The attributetag to be added.index
- The index to add the passed attributetag on.public void removeAttributeTag(int index)
index
- The index of the attributetag to be removed.public int getNumberOfAttributeTags()
public int getSelectedAttributeTagIndex()
public String getSelectedAttributeTag()
public void selectAttributeTag(int index)
index
- The index of the attribute tag to be added.public String[] getAttributeTags()
String
s that represent tags.public boolean getConvertAttributeComment()
public boolean getAddAttributeComment()
public String getAttributeWhiteLines()
String
).public void selectAllFiles()
public void deselectAllFiles()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |