| org.acm.seguin.ide.common.IDEInterface
All known Subclasses: org.acm.seguin.ide.netbeans.JRefactory, org.acm.seguin.ide.standalone.JRefactory, org.acm.seguin.ide.jedit.JavaStylePlugin, org.acm.seguin.ide.jbuilder.JRefactory,
| IDEInterface | | public interface IDEInterface (Code) | | Description of the Interface
author:
Mike Atkinson |
| Field Summary | |
| final public static int | CODING_STANDARDS
Signals that this is to do with coding standards checking. | | final public static int | CUT_AND_PASTE_DETECTOR
Signals that this is to do with cut and paste detection. | | final public static int | DEBUG
Debugging message urgency. | | final public static int | ERROR
Error urgency. | | final public static int | MESSAGE
Message urgency. | | final public static int | NOTICE
Notice urgency. | | final public static int | WARNING
Warning urgency. |
| Method Summary | |
| void | addAnnotation(Frame view, Object buffer, int type, int lineNo, String description)
Adds an annotation to an ide buffer. | | boolean | bufferContainsJavaSource(Frame view, Object buffer)
Does the buffer contain Java source code. | | 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. | | void | bufferParsed(Frame view, Object buffer, Node compilationUnit)
Indicates that a buffer has been parsed and that an Abstract Syntax Tree is available. | | void | checkAllOpenBuffers(Frame view)
| | void | checkBuffer(Frame view, Object buffer)
| | void | checkDirectory(Frame view, boolean recursive)
| | void | clearAnnotations(Frame view, Object buffer, int type)
Clears all annotation for an ide buffer. | | void | cpdAllOpenBuffers(Frame view)
| | void | cpdBuffer(Frame view, Object buffer)
| | void | cpdDir(Frame view, boolean recursive)
| | Object | getCurrentBuffer(Frame view)
Get the current (atcive) buffer.
Parameters:
view - The frame containing the IDE. | | Frame | getEditorFrame()
Returns the frame that contains the editor. | | File | getFile(Frame view, Object buffer)
| | String | getFilePathForBuffer(Object buffer)
| | String[] | getIDEProjects(Frame parent)
| | String | getIDEProperty(String prop)
| | String | getIDEProperty(String prop, String deflt)
| | int | getLineCount(Object buffer)
| | int | getLineEndOffset(Object buffer, int end)
| | int | getLineNumber(Frame view, Object buffer)
Get the line number of the cursor within the current buffer. | | int | getLineStartOffset(Object buffer, int begin)
| | String | getProjectName(Frame view, Object buffer)
| | PropertiesFile | getProperties(String type, String project)
| | String | getText(Frame view, Object buffer)
| | void | goToBuffer(Frame view, Object buffer)
| | void | hideWaitCursor(Frame parent)
| | Icon | loadIcon(String name)
Load an icon from the IDE
Parameters:
name - The name of the icon. | | void | log(int urgency, Object source, Object message)
| | void | moveCaretPosition(Frame view, Object buffer, int start)
| | Object | openFile(Frame view, String fileName)
| | void | runInAWTThread(Runnable runnable)
| | void | saveProperties()
| | void | setBuffer(Frame view, Object fileName)
| | void | setLineNumber(Frame view, Object buffer, int lineNumber)
Get the line number of the cursor within the current buffer. | | void | setSelection(Frame view, Object buffer, int start, int end)
| | void | setText(Frame view, Object buffer, String value)
| | void | showWaitCursor(Frame parent)
|
| CODING_STANDARDS | | final public static int CODING_STANDARDS(Code) | | Signals that this is to do with coding standards checking.
since:
JRefactory 2.9.17 |
| CUT_AND_PASTE_DETECTOR | | final public static int CUT_AND_PASTE_DETECTOR(Code) | | Signals that this is to do with cut and paste detection.
since:
JRefactory 2.9.17 |
| DEBUG | | final public static int DEBUG(Code) | | Debugging message urgency. Should be used for messages only useful when debugging a problem.
since:
JRefactory 2.8.02 |
| ERROR | | final public static int ERROR(Code) | | Error urgency. Should be used for messages that signal a failure.
since:
JRefactory 2.8.02 |
| MESSAGE | | final public static int MESSAGE(Code) | | Message urgency. Should be used for messages which give more detail than notices.
since:
JRefactory 2.8.02 |
| NOTICE | | final public static int NOTICE(Code) | | Notice urgency. Should be used for messages that directly affect the user.
since:
JRefactory 2.8.02 |
| WARNING | | final public static int WARNING(Code) | | Warning urgency. Should be used for messages that warrant attention.
since:
JRefactory 2.8.02 |
| addAnnotation | | 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 | | 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 | | 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 | | 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 | | void checkAllOpenBuffers(Frame view)(Code) | | Description of the Method
Parameters:
view - Description of Parameter |
| checkBuffer | | void checkBuffer(Frame view, Object buffer)(Code) | | Description of the Method
Parameters:
view - Description of Parameter |
| checkDirectory | | void checkDirectory(Frame view, boolean recursive)(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
recursive - Description of Parameter |
| clearAnnotations | | 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 | | void cpdAllOpenBuffers(Frame view) throws IOException(Code) | | Description of the Method
Parameters:
view - Description of Parameter
exception:
IOException - Description of Exception |
| cpdBuffer | | void cpdBuffer(Frame view, Object buffer) throws IOException(Code) | | Description of the Method
Parameters:
view - Description of Parameter
exception:
IOException - Description of Exception |
| cpdDir | | 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 | | 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 | | 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 |
| getFilePathForBuffer | | String getFilePathForBuffer(Object buffer)(Code) | | Description of the Method
Parameters:
buffer - Description of Parameter The File path for this buffer |
| getIDEProjects | | String[] getIDEProjects(Frame parent)(Code) | | Gets the IDEProjects attribute of the IDEInterface object
Parameters:
parent - Description of Parameter The IDEProjects value |
| getIDEProperty | | String getIDEProperty(String prop)(Code) | | Gets the IDEProperty attribute of the IDEInterface object
Parameters:
prop - Description of Parameter The IDEProperty value |
| getIDEProperty | | String getIDEProperty(String prop, String deflt)(Code) | | Gets the IDEProperty attribute of the IDEInterface object
Parameters:
prop - Description of Parameter
Parameters:
deflt - Description of Parameter The IDEProperty value |
| getLineCount | | int getLineCount(Object buffer)(Code) | | Description of the Method
Parameters:
buffer - Description of Parameter The LineCount value |
| getLineEndOffset | | 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 | | 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.
Parameters:
buffer - Description of Parameter
Parameters:
lineNumber - The line number of the cursor in the current buffer. |
| getLineStartOffset | | 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 | | String getProjectName(Frame view, Object buffer)(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
buffer - Description of Parameter The ProjectName value |
| getProperties | | PropertiesFile getProperties(String type, String project)(Code) | | Gets the Properties attribute of the IDEInterface object
Parameters:
type - Description of Parameter
Parameters:
project - Description of Parameter The Properties value |
| getText | | String getText(Frame view, Object buffer)(Code) | | Description of the Method
Parameters:
view - Description of Parameter The Text value |
| goToBuffer | | void goToBuffer(Frame view, Object buffer)(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
buffer - Description of Parameter |
| hideWaitCursor | | void hideWaitCursor(Frame parent)(Code) | | Description of the Method
Parameters:
parent - Description of Parameter |
| loadIcon | | 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 | | 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 | | void moveCaretPosition(Frame view, Object buffer, int start)(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
start - Description of Parameter |
| openFile | | 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 | | void runInAWTThread(Runnable runnable)(Code) | | Description of the Method
Parameters:
runnable - Description of Parameter |
| saveProperties | | void saveProperties()(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
buffer - Description of Parameter |
| setBuffer | | void setBuffer(Frame view, Object fileName)(Code) | | Description of the Method
Parameters:
view - Description of Parameter
Parameters:
fileName - The new Buffer value |
| setLineNumber | | 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. |
| setSelection | | 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 | | 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 | | void showWaitCursor(Frame parent)(Code) | | Description of the Method
Parameters:
parent - Description of Parameter |
|
|