|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.docking.DockStation
The singleton for docking operations. To write a dockable window, you must create your own DockableWindow
s and a DockableFactory
. See Docking Package Summary
Field Summary | |
static int |
STATUS_ACCESSIBLE The user has a direct access to the dockable. |
static int |
STATUS_ACTIVE The Dockable is active (title bar is dark blue) |
static int |
STATUS_MINIMIZED The Dockable unpinned and minimized |
static int |
STATUS_PINNED The Dockable pinned |
static int |
STATUS_PRESENT The Dockable is known by the docking system |
static int |
STATUS_VISIBLE The Dockable is visible. |
Constructor Summary | |
DockStation() |
Method Summary | |
abstract boolean |
activateAnyDockable() Sets the focus in the first available dockable window. |
abstract boolean |
activateDockable(Dockable dockable) Sets the focus in the specified dockable. |
abstract void |
addDockableListener(DockableListener l, Dockable d) Dockable listeners are manipulated by the DockStation to simplify the implementation of the Dockable interface. |
abstract void |
close(Dockable dockable) Close the specified dockable. |
abstract void |
dock(Dockable dockable, Dockable ref, int nOrientation, boolean bVisible) Deprecated. Dock the comp component next to the ref component |
abstract void |
dock(Dockable dockable, Dockable ref, int nOrientation, int nExtents, boolean bVisible) Deprecated. |
abstract void |
dock(Dockable dockable, DockingParam dockingParam) Inserts the dockable into the docking system. |
abstract void |
dock(Dockable dockable, int nOrientation, boolean bVisible) Deprecated. |
abstract FloatingToolWindow |
dockFloat(Dockable dockable, java.awt.Point pt, boolean bVisible) Deprecated. |
abstract Dockable |
findDockable(ViewId viewId) searches/create a dockable based on a name. |
abstract Dockable |
getDockable(ViewId viewId) searches a dockable based on a name. |
abstract int |
getDockableStatus(Dockable dockable) |
static DockStation |
getDockStation() Returns the DockStation instance that is active in the IDE. |
abstract void |
initialize() This method is called to give this class an opportunity to hook layout listeners to the ide. |
abstract void |
install(javax.swing.JFrame frame, java.awt.Container topPanel, javax.swing.JComponent centerPanel) Initializes the docking system. |
abstract boolean |
isDockableVisible(Dockable dockable) |
abstract boolean |
isDockableVisible(java.lang.String viewId) |
abstract void |
registerDockableFactory(java.lang.String viewTypeId, DockableFactory factory) Register a factory that can create dockables. |
abstract void |
removeDockableListener(DockableListener l, Dockable d) Unregisters a dockable listener. |
abstract void |
saveLayout(PropertyAccess pa) Saves all of the docking layout. |
abstract void |
setDockableVisible(Dockable dockable, boolean bVisible) |
abstract void |
setDockableVisible(java.lang.String strViewId, boolean bVisible) Show/hide a dockable. |
static void |
setDockStation(DockStation dockStation) Publishes the specified DockStation as the active instance in the IDE. |
abstract void |
undock(Dockable dockable) Remove the dockable. |
abstract void |
unregisterDockableFactory(java.lang.String viewTypeId) Removes a factory from the registry |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.ide.addin.Controller |
handleEvent, update |
Field Detail |
public static final int STATUS_PRESENT
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field Valuespublic static final int STATUS_PINNED
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field Valuespublic static final int STATUS_MINIMIZED
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field Valuespublic static final int STATUS_ACCESSIBLE
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field Valuespublic static final int STATUS_ACTIVE
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field Valuespublic static final int STATUS_VISIBLE
getDockableStatus(oracle.ide.docking.Dockable)
, Constant Field ValuesConstructor Detail |
public DockStation()
Method Detail |
public static DockStation getDockStation()
public static void setDockStation(DockStation dockStation)
public abstract void registerDockableFactory(java.lang.String viewTypeId, DockableFactory factory)
public abstract void unregisterDockableFactory(java.lang.String viewTypeId)
public abstract void addDockableListener(DockableListener l, Dockable d)
l
- the listener to addd
- the dockable to watch. If this value is null, the listener will be registered for every dockable.public abstract void removeDockableListener(DockableListener l, Dockable d)
l
- the listener to removed
- the dockable on which the listener was registered.public abstract void initialize()
initialize
in interface Module
public abstract void install(javax.swing.JFrame frame, java.awt.Container topPanel, javax.swing.JComponent centerPanel)
frame
- The main application frame. It will be used to attach floating windowstopPanel
- usually the contentFrame.centerPanel
- the place where MDI windows will circulate.public abstract boolean isDockableVisible(java.lang.String viewId)
true
if the view identified by the given viewId
is visible.isDockableVisible( Dockable dockable )
public abstract boolean isDockableVisible(Dockable dockable)
true
if the given dockable
is visible.public abstract int getDockableStatus(Dockable dockable)
STATUS_PRESENT
, STATUS_PINNED
, STATUS_MINIMIZED
, STATUS_ACCESSIBLE
, STATUS_ACTIVE
, STATUS_VISIBLE
public abstract void dock(Dockable dockable, int nOrientation, boolean bVisible)
dock(Dockable, DockingParam)
.
Also, the visibility is now determined by the Dockable itself. Ex:
DockingParam dockingParam = new DockingParam(); dockingParam.setPosition(nOrientation); dockStation.dock(dockable, dockingParam);
dockable
- the dockable to be dockednOrientation
- describes on which side of ref the component must be attached.bVisible
- true if the window must be shownpublic abstract void dock(Dockable dockable, Dockable ref, int nOrientation, boolean bVisible)
dock(Dockable, DockingParam)
.
Also, the visibility is now determined by the Dockable itself. Ex:
DockingParam dockingParam = new DockingParam(); dockingParam.setPosition(ref, nOrientation); dockStation.dock(dockable, dockingParam);
dockable
- the dockable to be dockedref
- the dockable used as reference for orientation (ex:left of...)nOrientation
- describes on which side of ref the component must be attached. Takes values from IdeConstants.NORTH
, IdeConstants.SOUTH
, IdeConstants.WEST
, IdeConstants.EAST
or IdeConstants.CENTER
bVisible
- specifies if the dockable UI is initially visiblepublic abstract void dock(Dockable dockable, Dockable ref, int nOrientation, int nExtents, boolean bVisible)
dock(Dockable, DockingParam)
.
Also, the visibility is now determined by the Dockable itself. Ex:
DockingParam dockingParam = new DockingParam(); dockingParam.setPosition(ref, nOrientation); dockStation.dock(dockable, dockingParam);
dockable
- the dockable to be dockedref
- the dockable used as reference for orientation (ex:left of...)nOrientation
- describes on which side of ref the component must be attached. Takes values from IdeConstants.NORTH
, IdeConstants.SOUTH
, IdeConstants.WEST
, IdeConstants.EAST
or IdeConstants.CENTER
nExtents
- Number of contiguous components it covers (ex: right of 3 components starting at ref)bVisible
- specifies if the dockable UI is initially visiblepublic abstract FloatingToolWindow dockFloat(Dockable dockable, java.awt.Point pt, boolean bVisible)
dock(Dockable, DockingParam)
.
Use the following code instead:
final DockingParam dockingParam = new DockingParam(); dockingParam.setFloatingPosition(new Rectangle(100, 100, 200, 200)); DockStation.dock(dockable, dockingParam); final FloatingToolWindow floatingToolWindow = dockingParam.getFloatingToolWindow();
dockable
- the dockable to wrappt
- the place where to put the floating window in screen coordinates. If pt is null, the dockable is centered on the main application window.bVisible
- specifies if the dockable UI is initially visiblepublic abstract void dock(Dockable dockable, DockingParam dockingParam)
dockable
- the dockable to insertdockingParam
- specifies where to place the dockable.public abstract void undock(Dockable dockable)
public abstract void setDockableVisible(java.lang.String strViewId, boolean bVisible)
strViewId
- the identification of the dockable.bVisible
- true if the dockable must be shown.public abstract void setDockableVisible(Dockable dockable, boolean bVisible)
public abstract void close(Dockable dockable)
dockable
- the dockable.public abstract void saveLayout(PropertyAccess pa)
pa
- the storage objectpublic abstract boolean activateDockable(Dockable dockable)
public abstract boolean activateAnyDockable()
public abstract Dockable getDockable(ViewId viewId)
public abstract Dockable findDockable(ViewId viewId)
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.