Extension SDK

oracle.ide.keyboard
Class KeyboardDockable

java.lang.Object
  |
  +--oracle.ide.keyboard.KeyboardDockable
All Implemented Interfaces:
Addin, Dockable, DockableFactory

public final class KeyboardDockable
extends java.lang.Object
implements Dockable, DockableFactory, Addin

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

KeyboardDockable

public KeyboardDockable()
Method Detail

getTabName

public java.lang.String getTabName()
Description copied from interface: Dockable
Gets the name to display in a tab.
Specified by:
getTabName in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the name to display in a tab.
See Also:
Dockable.getTabIcon()

getTabIcon

public javax.swing.Icon getTabIcon()
Description copied from interface: Dockable
Gets the icon to display in a tab along side the name.
Specified by:
getTabIcon in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the the icon to display in a tab.
See Also:
Dockable.getTabName()

getTitleName

public java.lang.String getTitleName()
Description copied from interface: Dockable
Gets title to display in a title bar.
Specified by:
getTitleName in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the title to display in a title bar.
See Also:
Dockable.getTabIcon()

getUniqueName

public java.lang.String getUniqueName()
Description copied from interface: Dockable
Gets a unique name identifying this dockable. This name is used to register the dockable in the DockingRegistry. In general, the unique name should be generated by using the fully qualified name of the class implementing a dockable and adding an instance counter to that name.
Specified by:
getUniqueName in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
a unique name used for registration purposes.

getType

public int getType()
Description copied from interface: Dockable
Gets the types of dockable accepted by a specific dockable implementation. The constants above define some standard types. These types can be OR(ed) together.
Specified by:
getType in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the type accepted by this dockable implementation.

getSite

public Site getSite()
Description copied from interface: Dockable
Gets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.
Specified by:
getSite in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the current site.
See Also:
Dockable.setSite(oracle.ide.docking.Site)

setSite

public void setSite(Site site)
Description copied from interface: Dockable
Sets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.
Specified by:
setSite in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Parameters:
site - the site to set.
See Also:
Dockable.getSite()

getHostedComponent

public javax.swing.JComponent getHostedComponent()
Description copied from interface: Dockable
Gets the root component of the user interface to be docked or floated.
Specified by:
getHostedComponent in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the root component.

addTitleChangeListener

public void addTitleChangeListener(TitleChangeListener l)
Description copied from interface: Dockable
Adds a title change listener to a dockable. TitleChangeEvents should be trigger by a dockable whenever their title information changes.
Specified by:
addTitleChangeListener in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Parameters:
l - a TitleChangeListener instance.

removeTitleChangeListener

public void removeTitleChangeListener(TitleChangeListener l)
Description copied from interface: Dockable
Removes the specified title change listener from the dockable.
Specified by:
removeTitleChangeListener in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Parameters:
l - a TitleChangeListener instance.

saveLayout

public void saveLayout(PropertyAccess p)
Description copied from interface: Dockable
Saves the layout information of this dockable.
Specified by:
saveLayout in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Parameters:
p - the storage object

loadLayout

public void loadLayout(PropertyAccess p)
Description copied from interface: Dockable
reloads the layout information of this dockable.
Specified by:
loadLayout in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Parameters:
p - the storage object

getTabDropListener

public java.awt.dnd.DropTargetListener getTabDropListener()
Description copied from interface: Dockable
Gets the drop target listener for drop events on the tab. The TitledPanel will forward drop events to the appropriate listener for each tab.

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.

Specified by:
getTabDropListener in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the drop target listener

getMenuTitle

public java.lang.String getMenuTitle()
Description copied from interface: Dockable
Gets the text to display in the menus of the docking for showing/hiding the dockable.
Specified by:
getMenuTitle in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the string to display in the menu

getMenuPreferredMnemonic

public int getMenuPreferredMnemonic()
Description copied from interface: Dockable
Gets mnemonic used in the menus of the docking for showing/hiding the dockable.
Specified by:
getMenuPreferredMnemonic in interface Dockable
Following copied from interface: oracle.ide.docking.Dockable
Returns:
the mnemonic

getDockable

public Dockable getDockable(ViewId viewId)
Specified by:
getDockable in interface DockableFactory
Following copied from interface: oracle.ide.docking.DockableFactory
Returns:
a new Dockable corresponding the the view ID

install

public void install()
Description copied from interface: DockableFactory
This method is called by the docking system if the DockableFactory has been installed for the first time. This is the time for the addins to dock windows.
Specified by:
install in interface DockableFactory

initialize

public void initialize()
Description copied from interface: Addin
Invoked by the 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.
Specified by:
initialize in interface Addin
Following copied from interface: oracle.ide.addin.Addin
See Also:
AddinManager

shutdown

public void shutdown()
Description copied from interface: Addin
This method is invoked by the 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.
Specified by:
shutdown in interface Addin

version

public float version()
Description copied from interface: Addin
This method is called to determine the Addin version number, (i.e. 1.0)

Specified by:
version in interface Addin
Following copied from interface: oracle.ide.addin.Addin
Returns:
the version number.

ideVersion

public float ideVersion()
Description copied from interface: Addin
This method is called to determine the ide version number for which this Addin was implemented.

Specified by:
ideVersion in interface Addin
Following copied from interface: oracle.ide.addin.Addin
Returns:
the ide version number, (i.e. 5.0).

canShutdown

public boolean canShutdown()
Description copied from interface: Addin
This method is invoked by the 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.
Specified by:
canShutdown in interface Addin

Extension SDK