public class DockingParam
extends java.lang.Object
Constructor and Description |
---|
DockingParam() |
Modifier and Type | Method and Description |
---|---|
int |
getAlternateOrientation() |
int |
getExtents() |
java.awt.Rectangle |
getFloatingPosition() |
FloatingToolWindow |
getFloatingToolWindow() |
int |
getOrientation() |
Dockable |
getReference() |
boolean |
isFloating() |
java.lang.Boolean |
isFloatOnTop() |
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 |
setHosted(DockableWindow hostingDockable,
int position)
Will host the dockable window inside the
hostingDockable |
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 |
setReference(Dockable newReference) |
void |
setTabbedWith(Dockable reference)
Docks the window together with one (or more) dockable window.
|
java.lang.String |
toString() |
public void setPosition(int orientation)
orientation
- specifies in which zone to place the dockable
Takes values from IdeConstants.NORTH
,
IdeConstants.SOUTH
, IdeConstants.WEST
, IdeConstants.EAST
or IdeConstants.TABBED
public void setPosition(Dockable reference, int position)
position
- specifies where to place the dockable relative to the reference
Takes values from IdeConstants.NORTH
,
IdeConstants.SOUTH
, IdeConstants.WEST
, IdeConstants.EAST
,
IdeConstants.TABBED
or IdeConstants.HOSTED
public void setPosition(Dockable reference, int position, int alternateAbsolutePosition)
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.position
- specifies where to place the dockable relative to the reference
Takes values from IdeConstants.NORTH
,
IdeConstants.SOUTH
, IdeConstants.WEST
, IdeConstants.EAST
or IdeConstants.TABBED
alternateAbsolutePosition
- an alternate position in the main window if reference
is not foundpublic void setTabbedWith(Dockable reference)
reference
- The other dockable with which your dockable will be attachedpublic void setFloatingPosition(java.awt.Rectangle floatingPosition)
public java.awt.Rectangle getFloatingPosition()
public boolean isFloating()
public void setFloating(boolean floating)
public void setFloatOnTop(boolean floatOnTop)
public void setFloatOnTop(java.lang.Boolean floatOnTop)
floatOnTop
- public java.lang.Boolean isFloatOnTop()
public Dockable getReference()
public int getOrientation()
public int getAlternateOrientation()
public int getExtents()
public void setExtents(int extents)
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.extents
- public void setFloatingToolWindow(FloatingToolWindow floatingToolWindow)
floatingToolWindow
- public FloatingToolWindow getFloatingToolWindow()
public void setHosted(DockableWindow hostingDockable, int position)
hostingDockable
hostingDockable
- The DrawerDockableWindow
that will receive the dockable.position
- IdeConstants.BEFORE
to add at the beginning or IdeConstants.AFTER
to add at the endpublic void setReference(Dockable newReference)
public java.lang.String toString()
toString
in class java.lang.Object