|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.fife.ui.app.AbstractPlugin org.fife.rtext.plugins.macros.MacroPlugin
public class MacroPlugin
A plugin providing scripted macro support to RText.
Field Summary | |
---|---|
protected static java.util.ResourceBundle |
msg
|
Constructor Summary | |
---|---|
MacroPlugin(AbstractPluggableGUIApplication app)
Constructor. |
Method Summary | |
---|---|
java.io.File |
getMacroDir()
Returns the directory that macro definitions are saved to. |
PluginOptionsDialogPanel |
getOptionsDialogPanel()
Returns an options panel for use in an Options dialog. |
java.lang.String |
getPluginAuthor()
Returns the author of the plugin. |
javax.swing.Icon |
getPluginIcon()
Returns the icon to display beside the name of this plugin in the application's interface. |
java.lang.String |
getPluginName()
Returns the name of the plugin. |
java.lang.String |
getPluginVersion()
Returns the version of the plugin. |
RText |
getRText()
|
void |
install(AbstractPluggableGUIApplication app)
Called just after a plugin is added to a GUI application. |
void |
propertyChange(java.beans.PropertyChangeEvent e)
|
void |
savePreferences()
Called when the GUI application is shutting down. |
boolean |
uninstall()
Called just before this Plugin is removed from an
GUIApplication . |
Methods inherited from class org.fife.ui.app.AbstractPlugin |
---|
getOptionsDialogPanelParentPanelID, lookAndFeelChanged, setOptionsDialogPanelParentPanelID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.util.ResourceBundle msg
Constructor Detail |
---|
public MacroPlugin(AbstractPluggableGUIApplication app)
app
- The parent RText application.Method Detail |
---|
public java.io.File getMacroDir()
public PluginOptionsDialogPanel getOptionsDialogPanel()
getOptionsDialogPanel
in interface Plugin
public java.lang.String getPluginAuthor()
getPluginAuthor
in interface Plugin
public javax.swing.Icon getPluginIcon()
getPluginIcon
in interface Plugin
null
to represent no icon.public java.lang.String getPluginName()
getPluginName
in interface Plugin
public java.lang.String getPluginVersion()
getPluginVersion
in interface Plugin
public RText getRText()
public void install(AbstractPluggableGUIApplication app)
GUIPlugin
, it has already been added visually. Plugins
should use this method to register any listeners to the GUI application
and do any other necessary setup.
install
in interface Plugin
app
- The application to which this plugin was just added.Plugin.uninstall()
public void propertyChange(java.beans.PropertyChangeEvent e)
propertyChange
in interface java.beans.PropertyChangeListener
public void savePreferences()
Plugin
Plugin
should save any preferences.
savePreferences
in interface Plugin
public boolean uninstall()
Plugin
is removed from an
GUIApplication
. This gives the plugin a chance to clean
up any loose ends (kill any threads, close any files, remove listeners,
etc.).
uninstall
in interface Plugin
Plugin.install(org.fife.ui.app.AbstractPluggableGUIApplication)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |