public interface SplitDockAccess
SplitDockStation
. An access
is granted only to a few selected friend classes.Modifier and Type | Method and Description |
---|---|
void |
addHandle(StationChildHandle handle,
DockHierarchyLock.Token token)
Adds the new
handle to the station and adds
the displayer to the station. |
Leaf |
createLeaf(long id)
Creates a new
Leaf . |
Node |
createNode(long id)
Creates a new
Node . |
Placeholder |
createPlaceholder(long id)
Creates a new
Placeholder . |
boolean |
drop(Dockable dockable,
SplitDockProperty property,
SplitNode root)
Tries to add
Dockable such that the boundaries given
by property are full filled. |
void |
drop(DockHierarchyLock.Token token,
PutInfo putInfo,
StationDropItem item)
Adds the
Dockable given by putInfo to this station. |
StationChildHandle |
getFullScreenDockable()
Gets the
DockableDisplayer which is currently in fullscreen-mode. |
SplitDockStation |
getOwner()
Gets the station to which this object grants access.
|
SplitPlaceholderSet |
getPlaceholderSet()
Gets the set which keeps track of all placeholders and makes sure that
no placeholder is used twice.
|
SplitSpanStrategy |
getSpanStrategy()
Gets the object that manages all
Span s. |
DockTitleVersion |
getTitleVersion()
Gets the kind of title
owner uses. |
boolean |
isTreeAutoCleanupEnabled()
Tells whether nodes can currently be automatically removed from the tree.
|
void |
move(PutInfo putInfo,
StationDropItem item)
Moves the
dockable described by putInfo at a new location |
StationChildHandle |
newHandle(Dockable dockable)
Creates a new handle but does not take any other action.
|
void |
removeHandle(StationChildHandle handle,
DockHierarchyLock.Token token)
Removes an element from the station.
|
void |
repositioned(SplitNode node)
Invoked whenever a node changes its shape.
|
void |
setDropInfo(PutInfo putInfo)
Sets the current information telling where and how an item is to be dropped.
|
long |
uniqueID()
Creates a unique id for a
SplitNode . |
void |
unsetDropInfo()
Resets the information telling where and how an item is to be dropped.
|
double |
validateDivider(double divider,
Node node)
Tests whether the given value of the divider is a legal value or not.
|
PutInfo |
validatePutInfo(PutInfo info)
Checks whether
info is valid or not. |
SplitDockStation getOwner()
DockTitleVersion getTitleVersion()
owner
uses.null
StationChildHandle getFullScreenDockable()
DockableDisplayer
which is currently in fullscreen-mode.null
double validateDivider(double divider, Node node)
divider
- The value of the dividernode
- the node for which the divider is validateddivider
.StationChildHandle newHandle(Dockable dockable)
dockable
- the target for the new handlevoid addHandle(StationChildHandle handle, DockHierarchyLock.Token token)
handle
to the station and adds
the displayer to the station. Binds the dockable
.handle
- the new handletoken
- if null
, then a token will be acquired by this method
and this method will fire events, otherwise this methods is executed silentlyvoid removeHandle(StationChildHandle handle, DockHierarchyLock.Token token)
handle
- the element to removetoken
- if null
, then a token will be acquired by this method
and this method will fire events, otherwise this methods is executed silentlyboolean drop(Dockable dockable, SplitDockProperty property, SplitNode root)
Dockable
such that the boundaries given
by property
are full filled.dockable
- a new child of this stationproperty
- the preferred location of the childroot
- the root of all possible parents where the child could be insertedtrue
if the child could be added, false
if no location could be foundvoid repositioned(SplitNode node)
DockStationListener.dockablesRepositioned(bibliothek.gui.DockStation, Dockable[])
for all Dockable
s that are in node
or children of node
.node
- the source of the eventPutInfo validatePutInfo(PutInfo info)
info
is valid or not.info
- the preferred drop locationinfo
if it is valid, null
otherwiselong uniqueID()
SplitNode
.boolean isTreeAutoCleanupEnabled()
true
if auto-removal is enabledSplitPlaceholderSet getPlaceholderSet()
SplitSpanStrategy getSpanStrategy()
Span
s.SpanFactory
Leaf createLeaf(long id)
Leaf
.id
- the unique identifier of the leafNode createNode(long id)
Node
.id
- the unique identifier of the nodePlaceholder createPlaceholder(long id)
Placeholder
.id
- the unique identifier of this placeholdervoid setDropInfo(PutInfo putInfo)
putInfo
- the current drop informationvoid unsetDropInfo()
void move(PutInfo putInfo, StationDropItem item)
dockable
described by putInfo
at a new locationputInfo
- description of the new locationitem
- more information about the drag and drop operation that is currently happeningvoid drop(DockHierarchyLock.Token token, PutInfo putInfo, StationDropItem item)
Dockable
given by putInfo
to this station.token
- if null
, then a token will be acquired by this method
and this method will fire events, otherwise this methods is executed silentlyputInfo
- information about where to drop the new Dockable
item
- detailed information about the drag and drop operation that is going on