oracle.ide.docking
Class DockingParam

java.lang.Object
  oracle.ide.docking.DockingParam

public class DockingParam

extends java.lang.Object

This class is used to specify how to dock a dockable

See Also:

DockStation.dock(oracle.ide.docking.Dockable, oracle.ide.docking.DockingParam)

Constructor Summary

DockingParam()

Method Summary

int	getAlternateOrientation()
int	getExtents()
java.awt.Rectangle	getFloatingPosition()
FloatingToolWindow	getFloatingToolWindow()
int	getOrientation()
Dockable	getReference()
boolean	isFloating()
java.lang.Boolean	isFloatOnTop()
boolean	isPinned() Deprecated.
boolean	isVisible() Deprecated.
void	setActive(boolean active) Deprecated. The positioning API is now different than the visibility API and the activation depends on the visibility
void	setExtents(int extents) When used in conjunction with setPosition(Dockable, int), allows to place the dockable next, under or above multiple other dockables.
void	setFloating(boolean floating)
void	setFloatingPosition(java.awt.Rectangle floatingPosition)
void	setFloatingToolWindow(FloatingToolWindow floatingToolWindow) This method is used by the docking system when the window is floated.
void	setFloatOnTop(boolean floatOnTop)
void	setFloatOnTop(java.lang.Boolean floatOnTop) Instructs how to place the floating window.
void	setPinned(boolean pinned) Deprecated.
void	setPosition(Dockable reference, int position) Docks the window relative to another dockable.
void	setPosition(Dockable reference, int position, int alternateAbsolutePosition) Same as setPosition(Dockable, int) but if the Dockable is not found, the window will be placed at the alternateAbsolutePosition.
void	setPosition(int orientation) Docks the window at the end of one of the 4 docking zone around the editors.
void	setTabbedWith(Dockable reference) Docks the window together with one (or more) dockable window.
void	setVisible(boolean visible) Deprecated. The dockable must now tell if it wants to be visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingParam

public DockingParam()

Method Detail

setPosition

public void setPosition(int orientation)

Docks the window at the end of one of the 4 docking zone around the editors.

Parameters:

orientation - specifies in which zone to place the dockable Takes values from IdeConstants.NORTH, IdeConstants.SOUTH, IdeConstants.WEST, IdeConstants.EAST or IdeConstants.CENTER

setPosition

public void setPosition(Dockable reference,
                        int position)

Docks the window relative to another dockable.

Parameters:

position - specifies where to place the dockable relative to the reference Takes values from IdeConstants.NORTH, IdeConstants.SOUTH, IdeConstants.WEST, IdeConstants.EAST or IdeConstants.CENTER

setPosition

public void setPosition(Dockable reference,
                        int position,
                        int alternateAbsolutePosition)

Same as setPosition(Dockable, int) but if the Dockable is not found, the window will be placed at the alternateAbsolutePosition. For example, setPosition(referenceWindow, IdeConstant.SOUTH, IdeConstant.EAST) will try to position the window under referenceWindow but it the window does not exist (addin not enable), the window will be placed in the right panel.

Parameters:

position - specifies where to place the dockable relative to the reference Takes values from IdeConstants.NORTH, IdeConstants.SOUTH, IdeConstants.WEST, IdeConstants.EAST or IdeConstants.CENTER

alternateAbsolutePosition - an alternate position in the main window if reference is not found

setTabbedWith

public void setTabbedWith(Dockable reference)

Docks the window together with one (or more) dockable window.

Parameters:

reference - The other dockable with which your dockable will be attached

setFloatingPosition

public void setFloatingPosition(java.awt.Rectangle floatingPosition)

getFloatingPosition

public java.awt.Rectangle getFloatingPosition()

isFloating

public boolean isFloating()

setFloating

public void setFloating(boolean floating)

setFloatOnTop

public void setFloatOnTop(boolean floatOnTop)

setFloatOnTop

public void setFloatOnTop(java.lang.Boolean floatOnTop)

Instructs how to place the floating window. You can force a window to be always on top (Boolean.TRUE), force it to not always be on top (Boolean.FALSE) or use the user's preference (null)

Parameters:

floatOnTop -

isFloatOnTop

public java.lang.Boolean isFloatOnTop()

getReference

public Dockable getReference()

getOrientation

public int getOrientation()

getAlternateOrientation

public int getAlternateOrientation()

getExtents

public int getExtents()

setExtents

public void setExtents(int extents)

When used in conjunction with setPosition(Dockable, int), allows to place the dockable next, under or above multiple other dockables. For example, setPosition(navigator, EAST) followed by setExtents(2) would place the dockable on the right of both the navigator and the structure window.

Parameters:

extents -

isVisible

public boolean isVisible()

Deprecated.

setVisible

public void setVisible(boolean visible)

Deprecated. The dockable must now tell if it wants to be visible.

Use this method if you want your dockable window to be initially hidden. By default, the dockable will be shown

Parameters:

visible -

isPinned

public boolean isPinned()

Deprecated.

setPinned

public void setPinned(boolean pinned)

Deprecated.

setActive

public void setActive(boolean active)

Deprecated. The positioning API is now different than the visibility API and the activation depends on the visibility

By default, when dockable are tabbed together, the last one to be added is on top. User setActive(false) if you do not want your tab to be raised.

Parameters:

active -

setFloatingToolWindow

public void setFloatingToolWindow(FloatingToolWindow floatingToolWindow)

This method is used by the docking system when the window is floated.

Parameters:

floatingToolWindow -

getFloatingToolWindow

public FloatingToolWindow getFloatingToolWindow()

Returns:

If the dockable has been floated, this method will return the floating container.