|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDEInterface
Description of the Interface
Field Summary | |
---|---|
static int |
CODING_STANDARDS
Signals that this is to do with coding standards checking. |
static int |
CUT_AND_PASTE_DETECTOR
Signals that this is to do with cut and paste detection. |
static int |
DEBUG
Debugging message urgency. |
static int |
ERROR
Error urgency. |
static int |
MESSAGE
Message urgency. |
static int |
NOTICE
Notice urgency. |
static int |
WARNING
Warning urgency. |
Method Summary | |
---|---|
void |
addAnnotation(java.awt.Frame view,
java.lang.Object buffer,
int type,
int lineNo,
java.lang.String description)
Adds an annotation to an ide buffer. |
boolean |
bufferContainsJavaSource(java.awt.Frame view,
java.lang.Object buffer)
Does the buffer contain Java source code. |
void |
bufferNavigatorTree(java.awt.Frame view,
java.lang.Object buffer,
javax.swing.tree.TreeNode node)
Indicates that a buffer has been parsed and that a navigator tree of the source is available. |
void |
bufferParsed(java.awt.Frame view,
java.lang.Object buffer,
net.sourceforge.jrefactory.ast.Node compilationUnit)
Indicates that a buffer has been parsed and that an Abstract Syntax Tree is available. |
void |
checkAllOpenBuffers(java.awt.Frame view)
Description of the Method |
void |
checkBuffer(java.awt.Frame view,
java.lang.Object buffer)
Description of the Method |
void |
checkDirectory(java.awt.Frame view,
boolean recursive)
Description of the Method |
void |
clearAnnotations(java.awt.Frame view,
java.lang.Object buffer,
int type)
Clears all annotation for an ide buffer. |
void |
cpdAllOpenBuffers(java.awt.Frame view)
Description of the Method |
void |
cpdBuffer(java.awt.Frame view,
java.lang.Object buffer)
Description of the Method |
void |
cpdDir(java.awt.Frame view,
boolean recursive)
Description of the Method |
java.lang.Object |
getCurrentBuffer(java.awt.Frame view)
Get the current (atcive) buffer. |
java.awt.Frame |
getEditorFrame()
Returns the frame that contains the editor. |
java.io.File |
getFile(java.awt.Frame view,
java.lang.Object buffer)
Gets the file that is being edited |
java.lang.String |
getFilePathForBuffer(java.lang.Object buffer)
Description of the Method |
java.lang.String[] |
getIDEProjects(java.awt.Frame parent)
Gets the IDEProjects attribute of the IDEInterface object |
java.lang.String |
getIDEProperty(java.lang.String prop)
Gets the IDEProperty attribute of the IDEInterface object |
java.lang.String |
getIDEProperty(java.lang.String prop,
java.lang.String deflt)
Gets the IDEProperty attribute of the IDEInterface object |
int |
getLineCount(java.lang.Object buffer)
Description of the Method |
int |
getLineEndOffset(java.lang.Object buffer,
int end)
Description of the Method |
int |
getLineNumber(java.awt.Frame view,
java.lang.Object buffer)
Get the line number of the cursor within the current buffer. |
int |
getLineStartOffset(java.lang.Object buffer,
int begin)
Description of the Method |
java.lang.String |
getProjectName(java.awt.Frame view,
java.lang.Object buffer)
Description of the Method |
PropertiesFile |
getProperties(java.lang.String type,
java.lang.String project)
Gets the Properties attribute of the IDEInterface object |
java.lang.String |
getText(java.awt.Frame view,
java.lang.Object buffer)
Description of the Method |
void |
goToBuffer(java.awt.Frame view,
java.lang.Object buffer)
Description of the Method |
void |
hideWaitCursor(java.awt.Frame parent)
Description of the Method |
javax.swing.Icon |
loadIcon(java.lang.String name)
Load an icon from the IDE |
void |
log(int urgency,
java.lang.Object source,
java.lang.Object message)
Description of the Method |
void |
moveCaretPosition(java.awt.Frame view,
java.lang.Object buffer,
int start)
Description of the Method |
java.lang.Object |
openFile(java.awt.Frame view,
java.lang.String fileName)
Description of the Method |
void |
runInAWTThread(java.lang.Runnable runnable)
Description of the Method |
void |
saveProperties()
Description of the Method |
void |
setBuffer(java.awt.Frame view,
java.lang.Object fileName)
Description of the Method |
void |
setLineNumber(java.awt.Frame view,
java.lang.Object buffer,
int lineNumber)
Get the line number of the cursor within the current buffer. |
void |
setSelection(java.awt.Frame view,
java.lang.Object buffer,
int start,
int end)
Description of the Method |
void |
setText(java.awt.Frame view,
java.lang.Object buffer,
java.lang.String value)
Sets the string in the IDE |
void |
showWaitCursor(java.awt.Frame parent)
Description of the Method |
Field Detail |
---|
static final int DEBUG
static final int MESSAGE
static final int NOTICE
static final int WARNING
static final int ERROR
static final int CODING_STANDARDS
static final int CUT_AND_PASTE_DETECTOR
Method Detail |
---|
java.lang.String getIDEProperty(java.lang.String prop)
prop
- Description of Parameter
java.lang.String getIDEProperty(java.lang.String prop, java.lang.String deflt)
prop
- Description of Parameterdeflt
- Description of Parameter
java.lang.String[] getIDEProjects(java.awt.Frame parent)
parent
- Description of Parameter
void showWaitCursor(java.awt.Frame parent)
parent
- Description of Parametervoid hideWaitCursor(java.awt.Frame parent)
parent
- Description of Parametervoid log(int urgency, java.lang.Object source, java.lang.Object message)
urgency
- Description of Parametersource
- Description of Parametermessage
- Description of ParameterPropertiesFile getProperties(java.lang.String type, java.lang.String project)
type
- Description of Parameterproject
- Description of Parameter
void setBuffer(java.awt.Frame view, java.lang.Object fileName)
view
- Description of ParameterfileName
- The new Buffer valuevoid setSelection(java.awt.Frame view, java.lang.Object buffer, int start, int end)
view
- Description of Parameterstart
- The new Selection valueend
- The new Selection valuevoid cpdBuffer(java.awt.Frame view, java.lang.Object buffer) throws java.io.IOException
view
- Description of Parameter
java.io.IOException
- Description of Exceptionvoid cpdAllOpenBuffers(java.awt.Frame view) throws java.io.IOException
view
- Description of Parameter
java.io.IOException
- Description of Exceptionvoid cpdDir(java.awt.Frame view, boolean recursive) throws java.io.IOException
view
- Description of Parameterrecursive
- Description of Parameter
java.io.IOException
- Description of Exceptionjava.lang.Object openFile(java.awt.Frame view, java.lang.String fileName) throws java.io.IOException
view
- Description of ParameterfileName
- Description of Parameter
java.io.IOException
- Description of Exceptionint getLineStartOffset(java.lang.Object buffer, int begin)
buffer
- Description of Parameterbegin
- Description of Parameter
int getLineEndOffset(java.lang.Object buffer, int end)
buffer
- Description of Parameterend
- Description of Parameter
void moveCaretPosition(java.awt.Frame view, java.lang.Object buffer, int start)
view
- Description of Parameterstart
- Description of Parametervoid runInAWTThread(java.lang.Runnable runnable)
runnable
- Description of Parameterjava.lang.String getText(java.awt.Frame view, java.lang.Object buffer)
view
- Description of Parameter
void checkBuffer(java.awt.Frame view, java.lang.Object buffer)
view
- Description of Parametervoid checkAllOpenBuffers(java.awt.Frame view)
view
- Description of Parametervoid checkDirectory(java.awt.Frame view, boolean recursive)
view
- Description of Parameterrecursive
- Description of Parametervoid goToBuffer(java.awt.Frame view, java.lang.Object buffer)
view
- Description of Parameterbuffer
- Description of Parameterint getLineCount(java.lang.Object buffer)
buffer
- Description of Parameter
java.lang.String getProjectName(java.awt.Frame view, java.lang.Object buffer)
view
- Description of Parameterbuffer
- Description of Parameter
void saveProperties()
view
- Description of Parameterbuffer
- Description of Parameterjava.lang.String getFilePathForBuffer(java.lang.Object buffer)
buffer
- Description of Parameter
javax.swing.Icon loadIcon(java.lang.String name)
name
- The name of the icon.
java.awt.Frame getEditorFrame()
java.lang.Object getCurrentBuffer(java.awt.Frame view)
view
- The frame containing the IDE.
int getLineNumber(java.awt.Frame view, java.lang.Object buffer)
view
- The frame containing the IDE.buffer
- Description of ParameterlineNumber
- The line number of the cursor in the current buffer.void setLineNumber(java.awt.Frame view, java.lang.Object buffer, int lineNumber)
view
- The frame containing the IDE.buffer
- Description of Parameterboolean bufferContainsJavaSource(java.awt.Frame view, java.lang.Object buffer)
view
- The frame containing the IDE.buffer
- Description of Parameter
true
if the buffer contains Java source code, false
otherwise.void setText(java.awt.Frame view, java.lang.Object buffer, java.lang.String value)
view
- The frame containing the IDE.buffer
- Description of Parametervalue
- The new file contained in a stringjava.io.File getFile(java.awt.Frame view, java.lang.Object buffer)
void bufferParsed(java.awt.Frame view, java.lang.Object buffer, net.sourceforge.jrefactory.ast.Node compilationUnit)
view
- The frame containing the IDE.buffer
- The buffer (containing Java Source) that has been parsed.compilationUnit
- The root node of the AST.void bufferNavigatorTree(java.awt.Frame view, java.lang.Object buffer, javax.swing.tree.TreeNode node)
view
- The frame containing the IDE.buffer
- The buffer (containing Java Source) that has been parsed.node
- The root node of the tree.void addAnnotation(java.awt.Frame view, java.lang.Object buffer, int type, int lineNo, java.lang.String description)
view
- The frame containing the IDE.buffer
- The buffer (containing Java Source) that has been parsed.type
- either CODING_STANDARDS or CUT_AND_PASTE_DETECTIONlineNo
- The line number of the annotation.description
- The annotationvoid clearAnnotations(java.awt.Frame view, java.lang.Object buffer, int type)
view
- The frame containing the IDE.buffer
- The buffer (containing Java Source) that has been parsed.type
- either CODING_STANDARDS or CUT_AND_PASTE_DETECTION
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |