|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
kernel.Plugin
public abstract class Plugin
All plugins have to extend one of its subclasses.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Field Summary |
---|
Fields inherited from class javax.swing.JComponent |
---|
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Method Summary | |
---|---|
int |
compareTo(Plugin plugin)
Callback method, do not call it directly. |
abstract void |
execute()
This method will be automatically called when the user clicks on this plugin. |
String |
getAppLanguage()
Returns the ISO 639-1 language code of the main application. |
String |
getDescription()
Returns a full html description of the plugin. |
Dialog |
getOwner()
Returns a Dialog object that can be used as the owner window
for a dialog box. |
String |
getPluginsDir()
Returns the relative directory path to the plugins. |
String |
getSummary()
Returns a short summary of the plugin. |
void |
mouseClicked(MouseEvent e)
Callback method, do not call it directly. |
void |
mouseEntered(MouseEvent e)
Callback method, do not call it directly. |
void |
mouseExited(MouseEvent e)
Callback method, do not call it directly. |
void |
mousePressed(MouseEvent e)
Callback method, do not call it directly. |
void |
mouseReleased(MouseEvent e)
Callback method, do not call it directly. |
String |
readFile(String filename)
Reads the specified file and returns its content in a String. |
void |
setDescription(String description)
Sets the full html description of the plugin. |
void |
setSummary(String summary)
Sets a short summary of the plugin. |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public abstract void execute()
public String getDescription()
public String getSummary()
public Dialog getOwner()
Dialog
object that can be used as the owner window
for a dialog box. A typical use is when then plugin shows a dialog box
(extension of the JDialog
class), the constructor will require
an owner Frame
or Dialog
.
public String getAppLanguage()
public String getPluginsDir()
public void setDescription(String description)
description
- an html description of the pluginpublic void setSummary(String summary)
summary
- a short summary of the pluginpublic String readFile(String filename)
filename
- the filename of the file
null
if the file does not
existpublic void mouseEntered(MouseEvent e)
mouseEntered
in interface MouseListener
public void mouseExited(MouseEvent e)
mouseExited
in interface MouseListener
public void mousePressed(MouseEvent e)
mousePressed
in interface MouseListener
public void mouseClicked(MouseEvent e)
mouseClicked
in interface MouseListener
public void mouseReleased(MouseEvent e)
mouseReleased
in interface MouseListener
public int compareTo(Plugin plugin)
compareTo
in interface Comparable<Plugin>
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |