|
jrworkspace by jTEM |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jtem.jrworkspace.plugin.Plugin
de.jtem.jrworkspace.plugin.sidecontainer.template.ShrinkPanelPlugin
public abstract class ShrinkPanelPlugin
Extend this class to get a shrink panel Plugin
which will show up in the SideContainerPerspective
returned by your implementation of getPerspectivePluginClass()
.
Plugin.getPluginInfo()
to return a
descriptive PluginInfo
. This method is called in the constructor of this class and must not
return null
.
clazz.getSimpleName()
.html" is found as a resource of clazz
, then this is
attached as the help file of this plugin, where clazz
is the top level
enclosing class of the runtime class of this object. Note that in Eclipse you probably need to
remove *.html from "Filtered resources".
To turn this off override getHelpDocument()
, getHelpPath()
, and getHelpHandle()
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface de.jtem.jrworkspace.plugin.flavor.HelpFlavor |
---|
HelpFlavor.HelpListener |
Field Summary | |
---|---|
static int |
SHRINKER_BOTTOM
|
static int |
SHRINKER_DEFAULT
|
static int |
SHRINKER_LEFT
|
static int |
SHRINKER_RIGHT
|
static int |
SHRINKER_TOP
|
protected ShrinkPanel |
shrinkPanel
|
Constructor Summary | |
---|---|
ShrinkPanelPlugin()
|
Method Summary | |
---|---|
static Icon |
getDefaultIcon()
|
String |
getHelpDocument()
Returns the name of the HTML root help document |
Class<?> |
getHelpHandle()
Returns the class which is the root of the help page file system. |
Icon |
getHelpIcon()
Returns an help icon |
String |
getHelpPath()
Returns a path to the help HTML file. |
String |
getHelpStyleSheet()
Returns the name of the style sheet file to use for this help pages |
String |
getHelpTitle()
Returns the title for these help pages |
abstract Class<? extends SideContainerPerspective> |
getPerspectivePluginClass()
|
ShrinkPanel |
getShrinkPanel()
|
void |
helpCalled()
|
void |
install(Controller c)
Is called when the plug-in is installed |
void |
mainUIChanged(String uiClass)
|
void |
restoreStates(Controller c)
Is called before the installation of this plug-in. |
void |
setHelpListener(HelpFlavor.HelpListener l)
Sets the help listener which implements help functionality of the controller |
void |
setInitialPosition(int initPosition)
Set the initial position of this panel plug-in Possible values are SHRINKER_LEFT, SHRINKER_RIGHT, SHRINKER_BOTTOM, SHRINKER_TOP, SHRINKER_DEFAULT |
void |
setShowPanel(boolean show)
|
void |
storeStates(Controller c)
Is called after this plug-in has been uninstalled. |
void |
uninstall(Controller c)
Id called when this plug-in is about to be uninstalled |
Methods inherited from class de.jtem.jrworkspace.plugin.Plugin |
---|
equals, getPluginInfo, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int SHRINKER_BOTTOM
public static final int SHRINKER_DEFAULT
public static final int SHRINKER_LEFT
public static final int SHRINKER_RIGHT
public static final int SHRINKER_TOP
protected ShrinkPanel shrinkPanel
Constructor Detail |
---|
public ShrinkPanelPlugin()
Method Detail |
---|
public static Icon getDefaultIcon()
public String getHelpDocument()
HelpFlavor
getHelpDocument
in interface HelpFlavor
HelpFlavor#getHelpHandle()}
public Class<?> getHelpHandle()
HelpFlavor
String location =
HelpFlavor.getHelpPath()
+ HelpFlavor.getHelpDocument()
InputStream in =
HelpFlavor.getHelpHandle()
.getResourceAsStream(location)
getHelpHandle
in interface HelpFlavor
public Icon getHelpIcon()
HelpFlavor
getHelpIcon
in interface HelpFlavor
public String getHelpPath()
HelpFlavor
getHelpPath
in interface HelpFlavor
HelpFlavor#getHelpHandle()}
public String getHelpStyleSheet()
HelpFlavor
getHelpStyleSheet
in interface HelpFlavor
public String getHelpTitle()
HelpFlavor
getHelpTitle
in interface HelpFlavor
public abstract Class<? extends SideContainerPerspective> getPerspectivePluginClass()
public ShrinkPanel getShrinkPanel()
public void helpCalled()
helpCalled
in interface ShrinkPanel.HelpCalledListener
public void install(Controller c) throws Exception
Plugin
install
in class Plugin
c
- the applications Controller
Exception
Controller}
public void mainUIChanged(String uiClass)
mainUIChanged
in interface UIFlavor
public void restoreStates(Controller c) throws Exception
Plugin
Controller.getProperty(Class, String, Object)
on the controller provided
as argument.
restoreStates
in class Plugin
c
- this applications Controller
Exception
Controller}
public void setHelpListener(HelpFlavor.HelpListener l)
HelpFlavor
setHelpListener
in interface HelpFlavor
l
- the listenerpublic void setInitialPosition(int initPosition)
initPosition
- public void setShowPanel(boolean show)
public void storeStates(Controller c) throws Exception
Plugin
Controller.storeProperty(Class, String, Object)
on the controller provided
as argument.
storeStates
in class Plugin
Exception
Controller}
public void uninstall(Controller c) throws Exception
Plugin
uninstall
in class Plugin
c
- this applications Controller
Exception
Controller}
|
jrworkspace by jTEM |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |