|
Extension SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ide.keyboard.KeyboardDockable
This addin creates a dockable window with the current keyboard mappings. This is an internal debugging feature only.
Fields inherited from interface oracle.ide.docking.Dockable |
TYPE_DISCARDABLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE |
Constructor Summary | |
KeyboardDockable()
|
Method Summary | |
void |
addTitleChangeListener(TitleChangeListener l)
Adds a title change listener to a dockable. |
boolean |
canShutdown()
This method is invoked by the AddinManager before the IDE
terminates. |
Dockable |
getDockable(ViewId viewId)
|
javax.swing.JComponent |
getHostedComponent()
Gets the root component of the user interface to be docked or floated. |
int |
getMenuPreferredMnemonic()
Gets mnemonic used in the menus of the docking for showing/hiding the dockable. |
java.lang.String |
getMenuTitle()
Gets the text to display in the menus of the docking for showing/hiding the dockable. |
Site |
getSite()
Gets the current site where this dockable is docked or floated. |
java.awt.dnd.DropTargetListener |
getTabDropListener()
Gets the drop target listener for drop events on the tab. |
javax.swing.Icon |
getTabIcon()
Gets the icon to display in a tab along side the name. |
java.lang.String |
getTabName()
Gets the name to display in a tab. |
java.lang.String |
getTitleName()
Gets title to display in a title bar. |
int |
getType()
Gets the types of dockable accepted by a specific dockable implementation. |
java.lang.String |
getUniqueName()
Gets a unique name identifying this dockable. |
float |
ideVersion()
This method is called to determine the ide version number for which this Addin was implemented. |
void |
initialize()
Invoked by the AddinManager after the instance of the
Addin is instantiated. |
void |
install()
This method is called by the docking system if the DockableFactory has been installed for the first time. |
void |
loadLayout(PropertyAccess p)
reloads the layout information of this dockable. |
void |
removeTitleChangeListener(TitleChangeListener l)
Removes the specified title change listener from the dockable. |
void |
saveLayout(PropertyAccess p)
Saves the layout information of this dockable. |
void |
setSite(Site site)
Sets the current site where this dockable is docked or floated. |
void |
shutdown()
This method is invoked by the AddinManager when the IDE
terminates. |
float |
version()
This method is called to determine the Addin version number,
(i.e. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public KeyboardDockable()
Method Detail |
public java.lang.String getTabName()
Dockable
getTabName
in interface Dockable
oracle.ide.docking.Dockable
Dockable.getTabIcon()
public javax.swing.Icon getTabIcon()
Dockable
getTabIcon
in interface Dockable
oracle.ide.docking.Dockable
Dockable.getTabName()
public java.lang.String getTitleName()
Dockable
getTitleName
in interface Dockable
oracle.ide.docking.Dockable
Dockable.getTabIcon()
public java.lang.String getUniqueName()
Dockable
getUniqueName
in interface Dockable
oracle.ide.docking.Dockable
public int getType()
Dockable
getType
in interface Dockable
oracle.ide.docking.Dockable
public Site getSite()
Dockable
getSite
in interface Dockable
oracle.ide.docking.Dockable
Dockable.setSite(oracle.ide.docking.Site)
public void setSite(Site site)
Dockable
setSite
in interface Dockable
oracle.ide.docking.Dockable
site
- the site to set.Dockable.getSite()
public javax.swing.JComponent getHostedComponent()
Dockable
getHostedComponent
in interface Dockable
oracle.ide.docking.Dockable
public void addTitleChangeListener(TitleChangeListener l)
Dockable
addTitleChangeListener
in interface Dockable
oracle.ide.docking.Dockable
l
- a TitleChangeListener instance.public void removeTitleChangeListener(TitleChangeListener l)
Dockable
removeTitleChangeListener
in interface Dockable
oracle.ide.docking.Dockable
l
- a TitleChangeListener instance.public void saveLayout(PropertyAccess p)
Dockable
saveLayout
in interface Dockable
oracle.ide.docking.Dockable
p
- the storage objectpublic void loadLayout(PropertyAccess p)
Dockable
loadLayout
in interface Dockable
oracle.ide.docking.Dockable
p
- the storage objectpublic java.awt.dnd.DropTargetListener getTabDropListener()
Dockable
If handling drop events on the tab is not necessary, the implementation of this method should return null.
Note that this method may called repeatedly during a drag and drop operation, so it should be fast.
getTabDropListener
in interface Dockable
oracle.ide.docking.Dockable
public java.lang.String getMenuTitle()
Dockable
getMenuTitle
in interface Dockable
oracle.ide.docking.Dockable
public int getMenuPreferredMnemonic()
Dockable
getMenuPreferredMnemonic
in interface Dockable
oracle.ide.docking.Dockable
public Dockable getDockable(ViewId viewId)
getDockable
in interface DockableFactory
oracle.ide.docking.DockableFactory
public void install()
DockableFactory
install
in interface DockableFactory
public void initialize()
Addin
AddinManager
after the instance of the
Addin
is instantiated. When invoked, The Addin
should register and menu items, and actions required for use during this
classes lifecycle. Addin
authors should take care to ensure
that any extraneous initialization is not preformed on this method, and
any startup code that can be delayed until a later time is delayed, as
the Addin
's are synchronously initialized during the
startup of the IDE, and each Addin
has the potential to
negatively impact the startup time of the product.initialize
in interface Addin
oracle.ide.addin.Addin
AddinManager
public void shutdown()
Addin
AddinManager
when the IDE
terminates. Any non java resources (file handles, database connections,
etc) which are still being held by this Addin
should be
released by this method immediately. This method is not guaranteed to
be called, but on normal terminations of the IDE, this method will be
invoked.shutdown
in interface Addin
public float version()
Addin
Addin
version number,
(i.e. 1.0)
version
in interface Addin
oracle.ide.addin.Addin
public float ideVersion()
Addin
Addin
was implemented.
ideVersion
in interface Addin
oracle.ide.addin.Addin
public boolean canShutdown()
Addin
AddinManager
before the IDE
terminates. Addins should NOT use this method to release resources.
They should only use this method to give users the opportunity to
cancel the exit process if there is some process started by this
addin still running.
Implementations should return false
to cancel the shutdown
process.canShutdown
in interface Addin
|
Extension SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |