oracle.ide.docking
Interface Dockable

All Known Implementing Classes:

AbstractPinnable, BookmarkDockable, ChangeListWindow, oracle.ideri.navigator.DefaultNavigatorWindow, DockableView, DockableWindow, DrawerDockableWindow, DrawerWindow, ExplorerWindow, InspectorWindow, LogWindow, NavigatorWindow, PaletteWindow, PaletteWindow, ProjectNavigatorWindow

public interface Dockable

A Dockable interface.

The Dockable interface should be implemented by graphical user interfaces that want docking support. Addin developers will typically extend DockableWindow and should not implement Dockable directly.

See Also:

Docking Package Summary

Field Summary

static int	DEFAULT_VISIBILITY_MINIMIZED
static int	DEFAULT_VISIBILITY_RAISED If the window is tabbed with others, makes this window the active one.
static int	DEFAULT_VISIBILITY_VISIBLE Makes the window visible
static int	TYPE_DISCARDABLE If a Dockable has no corresponding menu View+xxx, it is discardable.
static int	TYPE_GLOBAL_VISIBLE The visibility of Dockables with this type is determined globally.
static int	TYPE_NO_BUTTONS Deprecated. No replacement -- option no longer supported. Buttons are always present on dockable title bars.
static int	TYPE_NORMAL If a Dockable has a corresponding menu View+xxx.
static int	TYPE_NOT_TABBED Deprecated. No replacement -- option has no effect.
static int	TYPE_RECYCLABLE Recyclable dockables are allowed to change the hosted component.
static int	TYPE_TRUNCATE_TITLE Deprecated. No replacement -- option no longer supported. Dockable titles are always truncated to fit the available space.

Method Summary

void	addTitleChangeListener(TitleChangeListener l) Adds a title change listener to a dockable.
void	afterAutoExpanding() Called after this dockable is displayed "auto-expanded."
void	afterRestoringFromAutoExpansion(int orientation, java.awt.Dimension autoExpandedWindowSize, boolean userResized) Called after this dockable is restored from being displayed "auto-expanded."
void	beforeAutoExpanding() Called before this dockable is going to be displayed "auto-expanded."
java.awt.Dimension	getAutoExpansionPreferredSize(int orientation)
java.awt.Dimension	getAutoExpansionSize(int orientation, javax.swing.JPanel dockedTitledPanel)
int	getDefaultVisibility(Layout layout) The first time a Dockable is exposed to a layout, if the dockable is not of type TYPE_GLOBAL_VISIBLE, it will be asked if it wants to be shown in that layout.
javax.swing.JComponent	getHostedComponent() Gets the root component of the user interface to be docked or floated.
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.
boolean	isAutoExpandable()
boolean	isAutoExpandableEnabled()
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	setAutoExpandable(boolean autoExpandable) Enables/disables "auto-expansion" in this dockable.
void	setAutoExpandableEnabled(boolean autoExpandableEnabled) Enables or disables the "auto-expand" feature in this dockable.
void	setSite(Site site) Sets the current site where this dockable is docked or floated.

Field Detail

TYPE_NORMAL

static final int TYPE_NORMAL

If a Dockable has a corresponding menu View+xxx.

See Also:

Constant Field Values

TYPE_DISCARDABLE

static final int TYPE_DISCARDABLE

If a Dockable has no corresponding menu View+xxx, it is discardable.

See Also:

Constant Field Values

TYPE_RECYCLABLE

static final int TYPE_RECYCLABLE

Recyclable dockables are allowed to change the hosted component. When a dock panel is closed, the JComponent of recyclable dockable is removed from the panel. This allows to reuse dockables to re-use previously used dockables. Note that TYPE_DISCARDABLE and TYPE_RECYCLABLE should be exclusive since discardable means that the dockable itself will be removed including the JComponent.

See Also:

Constant Field Values

TYPE_NO_BUTTONS

static final int TYPE_NO_BUTTONS

Deprecated. No replacement -- option no longer supported. Buttons are always present on dockable title bars.

does not show buttons in the title bar

See Also:

Constant Field Values

TYPE_NOT_TABBED

static final int TYPE_NOT_TABBED

Deprecated. No replacement -- option has no effect.

does not allow to be tabbed together with another dockable

See Also:

Constant Field Values

TYPE_TRUNCATE_TITLE

static final int TYPE_TRUNCATE_TITLE

Deprecated. No replacement -- option no longer supported. Dockable titles are always truncated to fit the available space.

If set, partial titles can be shown in the title bar. If not, the title is not shown at all if there is not enough space.

See Also:

Constant Field Values

TYPE_GLOBAL_VISIBLE

static final int TYPE_GLOBAL_VISIBLE

The visibility of Dockables with this type is determined globally. If the user closes the window in one layout, the window will be hidden in every layout.

See Also:

Constant Field Values

DEFAULT_VISIBILITY_VISIBLE

static final int DEFAULT_VISIBILITY_VISIBLE

Makes the window visible

See Also:

getDefaultVisibility(oracle.ide.layout.Layout), Constant Field Values

DEFAULT_VISIBILITY_MINIMIZED

static final int DEFAULT_VISIBILITY_MINIMIZED

See Also:

getDefaultVisibility(oracle.ide.layout.Layout), Constant Field Values

DEFAULT_VISIBILITY_RAISED

static final int DEFAULT_VISIBILITY_RAISED

If the window is tabbed with others, makes this window the active one. The operation is not garanteed if another window in the same tab also wants to be raised.

See Also:

getDefaultVisibility(oracle.ide.layout.Layout), Constant Field Values

Method Detail

getTabName

java.lang.String getTabName()

Gets the name to display in a tab.

Returns:

the name to display in a tab.

See Also:

getTabIcon()

getTabIcon

javax.swing.Icon getTabIcon()

Gets the icon to display in a tab along side the name.

Returns:

the the icon to display in a tab.

See Also:

getTabName()

getTitleName

java.lang.String getTitleName()

Gets title to display in a title bar.

Returns:

the title to display in a title bar.

See Also:

getTabIcon()

getUniqueName

java.lang.String getUniqueName()

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.

Returns:

a unique name used for registration purposes.

getType

int getType()

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.

Returns:

the type accepted by this dockable implementation.

getSite

Site getSite()

Gets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.

Returns:

the current site.

See Also:

setSite(oracle.ide.docking.Site)

setSite

void setSite(Site site)

Sets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.

Parameters:

site - the site to set.

See Also:

getSite()

getHostedComponent

javax.swing.JComponent getHostedComponent()

Gets the root component of the user interface to be docked or floated.

Returns:

the root component.

addTitleChangeListener

void addTitleChangeListener(TitleChangeListener l)

Adds a title change listener to a dockable. TitleChangeEvents should be trigger by a dockable whenever their title information changes.

Parameters:

l - a TitleChangeListener instance.

removeTitleChangeListener

void removeTitleChangeListener(TitleChangeListener l)

Removes the specified title change listener from the dockable.

Parameters:

l - a TitleChangeListener instance.

saveLayout

void saveLayout(PropertyAccess p)

Saves the layout information of this dockable.

Parameters:

p - the storage object

loadLayout

void loadLayout(PropertyAccess p)

reloads the layout information of this dockable.

Parameters:

p - the storage object

getTabDropListener

java.awt.dnd.DropTargetListener getTabDropListener()

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.

Returns:

the drop target listener

getMenuTitle

java.lang.String getMenuTitle()

Gets the text to display in the menus of the docking for showing/hiding the dockable.

Returns:

the string to display in the menu

getDefaultVisibility

int getDefaultVisibility(Layout layout)

The first time a Dockable is exposed to a layout, if the dockable is not of type TYPE_GLOBAL_VISIBLE, it will be asked if it wants to be shown in that layout.

Parameters:

layout -

isAutoExpandable

boolean isAutoExpandable()

Returns:

true if this dockable can be auto-expanded. Auto-expansion is the ability to be automatically expanded when the user hovers over a hot spot (usually the dockable's tab or the whole dockable if it is fully visible). This effect is similar to the expansion shown when a dockable is minimized and a user hover over the minimized dockable.

setAutoExpandable

void setAutoExpandable(boolean autoExpandable)

Enables/disables "auto-expansion" in this dockable.

Parameters:

autoExpandable - the new value for "auto-expansion".

See Also:

isAutoExpandable()

isAutoExpandableEnabled

boolean isAutoExpandableEnabled()

Returns:

true if this dockable is "auto-expandable" and if the "auto-expand" feature is enabled.

See Also:

isAutoExpandable()

setAutoExpandableEnabled

void setAutoExpandableEnabled(boolean autoExpandableEnabled)

Enables or disables the "auto-expand" feature in this dockable. This method has effect only if isAutoExpandable() is true

Parameters:

autoExpandableEnabled - the new value to enable/disable the "auto-expand" feature in this dockable.

beforeAutoExpanding

void beforeAutoExpanding()

Called before this dockable is going to be displayed "auto-expanded."

afterAutoExpanding

void afterAutoExpanding()

Called after this dockable is displayed "auto-expanded."

afterRestoringFromAutoExpansion

void afterRestoringFromAutoExpansion(int orientation,
                                     java.awt.Dimension autoExpandedWindowSize,
                                     boolean userResized)

Called after this dockable is restored from being displayed "auto-expanded."

Parameters:

orientation - the orientation of this dockable

See Also:

IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH

getAutoExpansionSize

java.awt.Dimension getAutoExpansionSize(int orientation,
                                        javax.swing.JPanel dockedTitledPanel)

Parameters:

orientation - the orientation of this dockable

dockedTitledPanel - the titled panel holding the dockable to be shown "auto-expanded"

Returns:

the size of this dockable when shown in "auto-expansion" mode.

See Also:

IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH

getAutoExpansionPreferredSize

java.awt.Dimension getAutoExpansionPreferredSize(int orientation)

Parameters:

orientation - the orientation of this dockable

Returns:

the user's preferred size of this dockable when in "auto-expansion" mode.

See Also:

IdeConstants.WEST, IdeConstants.EAST, IdeConstants.NORTH, IdeConstants.SOUTH