com.kinabaloo.plugins
Interface TJIModule
Methods
beNotifiedOfEdits
public boolean beNotifiedOfEdits()
- Tells TJI if wish to receive notification of edits made
in the current editor. If so, method editOccurred() will be called each
time an edit occurs.
-
- This method is called just after method start().
changeOccurred
public void changeOccurred(Integer change)
- Called when there is a change in the IDE that a module
might be interested in. To determine what change
occurred, compare int change with the constants defined
in interface TJI.
-
- For example:
-
- if
(change.intValue()==TJI.EDITOR_CHANGE)) {
-
- if
(tji.getCurrentFile().length()>0) {
-
- text=tji.getCurrentEditorText();
-
- ...
}
- }
editOccurred
public void editOccurred()
- Called whenever an edit occurs in the current editor, but
only if beNotifiedOfEdits()
returns true. No details of the edit are provided; these
can be obtained by adding a DocumentListener to getCurrentEditorDocument() but
note that changes to the document (or editor text) cannot
be made in methods implementing the DocumentListener
interface but should be made in this method, which is
called after calls to all DocumentListeners.
getModuleAuthor
public String getModuleAuthor()
- Return the module author and contact details. The "\n" (new line) character is
allowed.
getModuleName
public String getModuleName()
- Return the module name.
getModuleVersion
public String getModuleVersion()
- Return the module version.
moduleSelected
public void moduleSelected()
- Called when the module tab is selected by the user.
start
public boolean start(com.kinabaloo.tji.TJI tji)
- Called when the module is installed during the IDE start
up (after all the standard modules are set up). The
return should specify whether this module rquires a tab
within TJI for it's GUI, or whether it is simply invoked
by menu or runs in the background and alters project or
editor contents without requiring its own GUI.
stop
public void stop()
- Called when the IDE is about to close down.
Return to PlugIns