| java.lang.Object org.acm.seguin.ide.common.IDEPlugin
IDEPlugin | public class IDEPlugin (Code) | | Description of the Class
author: Chris Seguin |
Method Summary | |
public static void | addAnnotation(Frame view, Object buffer, int type, int lineNo, String description) Adds an annotation to an ide buffer. | public static boolean | bufferContainsJavaSource(Frame view, Object buffer) Does the buffer contain Java source code. | public static void | bufferNavigatorTree(Frame view, Object buffer, TreeNode node) Indicates that a buffer has been parsed and that a navigator tree of the source is available. | public static void | bufferParsed(Frame view, Object buffer, Node compilationUnit) Indicates that a buffer has been parsed and that an Abstract Syntax Tree is available. | public static void | checkAllOpenBuffers(Frame view) | public static void | checkBuffer(Frame view, Object buffer) | public static void | checkDirectory(Frame view, boolean recursive) | public static void | clearAnnotations(Frame view, Object buffer, int type) Clears all annotation for an ide buffer. | public static void | cpdAllOpenBuffers(Frame view) | public static void | cpdBuffer(Frame view, Object buffer) | public static void | cpdDir(Frame view, boolean recursive) | public static Object | getCurrentBuffer(Frame view) Get the current (atcive) buffer.
Parameters: view - The frame containing the IDE. | public static Frame | getEditorFrame() Returns the frame that contains the editor. | public static File | getFile(Frame view, Object buffer) | public static String | getFilePathForBuffer(Object buffer) | public static int | getLineCount(Object buffer) | public static int | getLineEndOffset(Object buffer, int end) | public static int | getLineNumber(Frame view, Object buffer) Get the line number of the cursor within the current buffer.
Parameters: view - The frame containing the IDE. | public static int | getLineStartOffset(Object buffer, int begin) | public static String | getProjectName(Frame view, Object buffer) | public static String[] | getProjects(Frame parent) | public static PropertiesFile | getProperties(String type, String project) | public static String | getProperty(String prop) | public static String | getProperty(String prop, String deflt) | public static String | getText(Frame view, Object buffer) | public static void | goToBuffer(Frame view, Object buffer) | public static void | hideWaitCursor(Frame parent) | public static Icon | loadIcon(String name) Load an icon from the IDE
Parameters: name - The name of the icon. | public static void | log(int urgency, Object source, Object message) | public static void | moveCaretPosition(Frame view, Object buffer, int start) | public static Object | openFile(Frame view, String fileName) | public static void | runInAWTThread(Runnable runnable) | public static void | saveProperties() | public static void | setBuffer(Frame view, Object buffer) | public static void | setLineNumber(Frame view, Object buffer, int lineNumber) Get the line number of the cursor within the current buffer. | public static void | setPlugin(IDEInterface ideIf) | public static void | setSelection(Frame view, Object buffer, int start, int end) | public static void | setText(Frame view, Object buffer, String value) | public static void | showWaitCursor(Frame parent) |
addAnnotation | public static void addAnnotation(Frame view, Object buffer, int type, int lineNo, String description)(Code) | | Adds an annotation to an ide buffer.
Parameters: view - The frame containing the IDE. Parameters: buffer - The buffer (containing Java Source) that has been parsed. Parameters: type - either CODING_STANDARDS or CUT_AND_PASTE_DETECTION Parameters: lineNo - The line number of the annotation. Parameters: description - The annotation |
bufferContainsJavaSource | public static boolean bufferContainsJavaSource(Frame view, Object buffer)(Code) | | Does the buffer contain Java source code.
Parameters: view - The frame containing the IDE. Parameters: buffer - Description of Parameter true if the buffer contains Java source code, false otherwise. |
bufferNavigatorTree | public static void bufferNavigatorTree(Frame view, Object buffer, TreeNode node)(Code) | | Indicates that a buffer has been parsed and that a navigator tree of the source is available.
Parameters: view - The frame containing the IDE. Parameters: buffer - The buffer (containing Java Source) that has been parsed. Parameters: node - The root node of the tree. |
bufferParsed | public static void bufferParsed(Frame view, Object buffer, Node compilationUnit)(Code) | | Indicates that a buffer has been parsed and that an Abstract Syntax Tree is available.
Parameters: view - The frame containing the IDE. Parameters: buffer - The buffer (containing Java Source) that has been parsed. Parameters: compilationUnit - The root node of the AST. |
checkAllOpenBuffers | public static void checkAllOpenBuffers(Frame view)(Code) | | Description of the Method
Parameters: view - Description of Parameter |
checkBuffer | public static void checkBuffer(Frame view, Object buffer)(Code) | | Description of the Method
Parameters: view - Description of Parameter |
checkDirectory | public static void checkDirectory(Frame view, boolean recursive)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: recursive - Description of Parameter |
clearAnnotations | public static void clearAnnotations(Frame view, Object buffer, int type)(Code) | | Clears all annotation for an ide buffer.
Parameters: view - The frame containing the IDE. Parameters: buffer - The buffer (containing Java Source) that has been parsed. Parameters: type - either CODING_STANDARDS or CUT_AND_PASTE_DETECTION |
cpdAllOpenBuffers | public static void cpdAllOpenBuffers(Frame view) throws IOException(Code) | | Description of the Method
Parameters: view - Description of Parameter exception: IOException - Description of Exception |
cpdBuffer | public static void cpdBuffer(Frame view, Object buffer) throws IOException(Code) | | Description of the Method
Parameters: view - Description of Parameter exception: IOException - Description of Exception |
cpdDir | public static void cpdDir(Frame view, boolean recursive) throws IOException(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: recursive - Description of Parameter exception: IOException - Description of Exception |
getCurrentBuffer | public static Object getCurrentBuffer(Frame view)(Code) | | Get the current (atcive) buffer.
Parameters: view - The frame containing the IDE. The active buffer or null if no active buffer. |
getEditorFrame | public static Frame getEditorFrame()(Code) | | Returns the frame that contains the editor. If this is not available or
you want dialog boxes to be centered on the screen return null from this
operation.
the frame |
getFile | public static File getFile(Frame view, Object buffer)(Code) | | Gets the file that is being edited
The File value |
getFilePathForBuffer | public static String getFilePathForBuffer(Object buffer)(Code) | | Description of the Method
Parameters: buffer - Description of Parameter The File path for this buffer |
getLineCount | public static int getLineCount(Object buffer)(Code) | | Description of the Method
Parameters: buffer - Description of Parameter The LineCount value |
getLineEndOffset | public static int getLineEndOffset(Object buffer, int end)(Code) | | Description of the Method
Parameters: buffer - Description of Parameter Parameters: end - Description of Parameter The LineEndOffset value |
getLineNumber | public static int getLineNumber(Frame view, Object buffer)(Code) | | Get the line number of the cursor within the current buffer.
Parameters: view - The frame containing the IDE. The ine number of the cursor in the current buffer, or -1 if no current buffer. |
getLineStartOffset | public static int getLineStartOffset(Object buffer, int begin)(Code) | | Description of the Method
Parameters: buffer - Description of Parameter Parameters: begin - Description of Parameter The BeginLine value |
getProjectName | public static String getProjectName(Frame view, Object buffer)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: buffer - Description of Parameter The ProjectName value |
getProjects | public static String[] getProjects(Frame parent)(Code) | | Gets the Projects attribute of the IDEPlugin class
Parameters: parent - Description of Parameter The Projects value |
getProperties | public static PropertiesFile getProperties(String type, String project)(Code) | | Gets the Properties attribute of the IDEPlugin class
Parameters: type - Description of Parameter Parameters: project - Description of Parameter The Properties value |
getProperty | public static String getProperty(String prop)(Code) | | Gets the Property attribute of the IDEPlugin class
Parameters: prop - Description of Parameter The Property value |
getProperty | public static String getProperty(String prop, String deflt)(Code) | | Gets the Property attribute of the IDEPlugin class
Parameters: prop - Description of Parameter Parameters: deflt - Description of Parameter The Property value |
getText | public static String getText(Frame view, Object buffer)(Code) | | Description of the Method
Parameters: view - Description of Parameter The Text value |
goToBuffer | public static void goToBuffer(Frame view, Object buffer)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: buffer - Description of Parameter |
hideWaitCursor | public static void hideWaitCursor(Frame parent)(Code) | | Description of the Method
Parameters: parent - Description of Parameter |
loadIcon | public static Icon loadIcon(String name)(Code) | | Load an icon from the IDE
Parameters: name - The name of the icon. An icon (or null if the icon cannot be found). |
log | public static void log(int urgency, Object source, Object message)(Code) | | Description of the Method
Parameters: urgency - Description of Parameter Parameters: source - Description of Parameter Parameters: message - Description of Parameter |
moveCaretPosition | public static void moveCaretPosition(Frame view, Object buffer, int start)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: start - Description of Parameter |
openFile | public static Object openFile(Frame view, String fileName) throws IOException(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: fileName - Description of Parameter Description of the Returned Value exception: IOException - Description of Exception |
runInAWTThread | public static void runInAWTThread(Runnable runnable)(Code) | | Description of the Method
Parameters: runnable - Description of Parameter |
saveProperties | public static void saveProperties()(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: buffer - Description of Parameter |
setBuffer | public static void setBuffer(Frame view, Object buffer)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: buffer - The new Buffer value |
setLineNumber | public static void setLineNumber(Frame view, Object buffer, int lineNumber)(Code) | | Get the line number of the cursor within the current buffer.
Parameters: view - The frame containing the IDE. Parameters: buffer - Description of Parameter The line number of the cursor in the current buffer, or -1 if no current buffer. |
setPlugin | public static void setPlugin(IDEInterface ideIf)(Code) | | Sets the Plugin attribute of the IDEPlugin class
Parameters: ideIf - The new Plugin value |
setSelection | public static void setSelection(Frame view, Object buffer, int start, int end)(Code) | | Description of the Method
Parameters: view - Description of Parameter Parameters: start - The new Selection value Parameters: end - The new Selection value |
setText | public static void setText(Frame view, Object buffer, String value)(Code) | | Sets the string in the IDE
Parameters: view - The frame containing the IDE. Parameters: buffer - Description of Parameter Parameters: value - The new file contained in a string |
showWaitCursor | public static void showWaitCursor(Frame parent)(Code) | | Description of the Method
Parameters: parent - Description of Parameter |
|
|