oracle.ide.docking
Class DockableView

java.lang.Object
  oracle.ide.view.View
      oracle.ide.docking.DockableView

All Implemented Interfaces:

ControllerProvider, Dockable, Helpable

Direct Known Subclasses:

DockableWindow

public abstract class DockableView

extends View

implements Dockable

This interface is the bridge between the Dockable interface docking system and the oracle.ide.addin.View interface. Addin writers should extend DockableWindow, and not implement this interface directly.

See Also:

Docking Package Summary

Field Summary

static int	CLOSED stateChange constant.
static int	HIDDEN stateChange constant.
static int	SHOWN stateChange constant.

Fields inherited from class oracle.ide.view.View

EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Fields inherited from interface oracle.ide.docking.Dockable

DEFAULT_VISIBILITY_MINIMIZED, DEFAULT_VISIBILITY_RAISED, DEFAULT_VISIBILITY_VISIBLE, TYPE_DISCARDABLE, TYPE_GLOBAL_VISIBLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE

Constructor Summary

DockableView()

Method Summary

abstract void	setDockableVisible(boolean bVisible) Shows/hides the dockable.
abstract void	setType(int type) Set the dockable type.

Methods inherited from class oracle.ide.view.View

activate, addViewListener, addViewSelectionListener, close, deactivate, fireViewClosed, fireViewSelectionChanged, getContext, getContext, getContextMenu, getController, getGUI, getHelpInfo, getId, getSelection, getSelectionFromUI, getToolbar, isVisible, loadManifestToolbar, loadManifestToolbar, newId, owner, removeViewListener, removeViewSelectionListener, scheduleUpdateSelection, setId, setOwner, setToolbarVisible, show, updateSelection, updateSelectionImpl, updateTitle, updateToolbarActions, updateVisibleActions, updateVisibleActions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.ide.docking.Dockable

addTitleChangeListener, getDefaultVisibility, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getTabIcon, getTabName, getTitleName, getType, getUniqueName, loadLayout, removeTitleChangeListener, saveLayout, setSite

Field Detail

SHOWN

public static final int SHOWN

stateChange constant.

Used when the UI is made visible or accessible.
Accessible means it is tabbed with other dockable windows. In this case, the SHOWN stateChange will be sent although the JComponent.isVisible==false.

SHOWN will be used when a layout is loaded as well as when the API is used.

See Also:

Constant Field Values

HIDDEN

public static final int HIDDEN

stateChange constant.

HIDDEN is the counterpart of SHOWN
It will be called when the user pressed the 'X' button, and when the layout changes (even if the dockable is visible in both layouts)

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

stateChange constant.

CLOSED is sent to Dockable that return TYPE_DISCARDABLE on getType().
CLOSED is sent when the close button is pressed after HIDDEN only if the dockable is alone in a window or tabbed only with other discardable windows.

See Also:

Constant Field Values

Constructor Detail

DockableView

public DockableView()

Method Detail

setDockableVisible

public abstract void setDockableVisible(boolean bVisible)

Shows/hides the dockable. This should be called in place of setVisible

setType

public abstract void setType(int type)

Set the dockable type.