|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SHTMLPlugin
Defines an interface all plug-ins for application SimplyHTML have to implement.
Field Summary | |
---|---|
static int |
DOCK_LOCATION_BOTTOM
indicates docking requested on bottom of a given container |
static int |
DOCK_LOCATION_LEFT
indicates docking requested on the left of a given container |
static int |
DOCK_LOCATION_NONE
indicates docking is not requested |
static int |
DOCK_LOCATION_RIGHT
indicates docking requested on the right of a given container |
static int |
DOCK_LOCATION_TOP
indicates docking requested on top of a given container |
Method Summary | |
---|---|
javax.swing.JComponent |
getComponent()
get the component that this plug-in produces, if any |
int |
getDockLocation()
get the location the component returned by getDockComponent() shall be docked at. |
java.lang.String |
getGUIName()
get the name of the plug-in as it shall appear on a GUI. |
javax.swing.JMenuItem |
getHelpMenu()
get a menu item providing documentation about this plug-in. |
java.lang.String |
getInternalName()
get the name used internally for this plug-in |
com.lightdev.app.shtm.SHTMLPanelImpl |
getOwner()
get the owner of this plug-in |
javax.swing.Action |
getOwnerAction(java.lang.String cmd)
get an action from the resource bundle of the owner of this plug-in |
java.lang.String |
getOwnerResString(java.lang.String nm)
get a string from the resource bundle of the owner of this plug-in |
javax.swing.JMenuItem |
getPluginMenu()
get a menu of actions this plug-in provides. |
void |
initHelpMenu()
|
void |
initPlugin(com.lightdev.app.shtm.SHTMLPanelImpl owner,
java.lang.String internalName,
java.lang.String pluginMenuId,
java.lang.String helpMenuId)
init the plug-in this is called by the PluginManager directly after instantiating the plug-in |
boolean |
isActive()
get the status of the plug-in |
void |
setDockLocation(int location)
set the location the component returned by getDockComponent() shall be docked at. |
void |
setOwner(com.lightdev.app.shtm.SHTMLPanelImpl owner)
set the owner of this plug-in |
void |
setStatus(boolean isActive)
set status of plug-in |
void |
showInitialInfo()
|
Field Detail |
---|
static final int DOCK_LOCATION_NONE
static final int DOCK_LOCATION_TOP
static final int DOCK_LOCATION_RIGHT
static final int DOCK_LOCATION_BOTTOM
static final int DOCK_LOCATION_LEFT
Method Detail |
---|
java.lang.String getGUIName()
java.lang.String getInternalName()
javax.swing.JMenuItem getPluginMenu()
JMenu
is a decendant of JMenuItem
so this method may return a single menu item up to a whole
structure of submenus in its return value.
javax.swing.JMenuItem getHelpMenu()
JMenu
is a decendant of JMenuItem
so this method may return a single menu item up to a whole
structure of submenus in its return value.
int getDockLocation()
void setDockLocation(int location)
location
- the dock location, one of DOCK_LOCATION_TOP, DOCK_LOCATION_BOTTOM,
DOCK_LOCATION.LEFT, DOCK_LOCATION_RIGHT or DOCK_LOCATION_NONE, if the
component shall not dock.javax.swing.JComponent getComponent()
boolean isActive()
void setStatus(boolean isActive)
isActive
- indicates whether or not the plug-in shall be activatedvoid setOwner(com.lightdev.app.shtm.SHTMLPanelImpl owner)
owner
- the main frame of the instance of SimplyHTML creating the plug-incom.lightdev.app.shtm.SHTMLPanelImpl getOwner()
java.lang.String getOwnerResString(java.lang.String nm)
nm
- the name of the string resource to get
javax.swing.Action getOwnerAction(java.lang.String cmd)
cmd
- the name of the action to get
void initPlugin(com.lightdev.app.shtm.SHTMLPanelImpl owner, java.lang.String internalName, java.lang.String pluginMenuId, java.lang.String helpMenuId)
owner
- the owner of this plug-ininternalName
- the internal name this plug-in shall havepluginMenuId
- the id of the plug-in menu in the TextResources,
or null if no plugin-in menu is to be createdhelpMenuId
- the id of the help menu for this plug-in in the
TextResources, or null if no help menu is to be createdvoid initHelpMenu()
void showInitialInfo()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |