protected class SplitDockStation.Access extends Object implements SplitDockAccess
SplitDockStation.| Modifier | Constructor and Description |
|---|---|
protected |
Access() |
| Modifier and Type | Method and Description |
|---|---|
void |
addHandle(StationChildHandle dockable,
DockHierarchyLock.Token token)
Adds the new
handle to the station and adds
the displayer to the station. |
void |
arm()
Prepares
this to fire an event to
DockStationListener.dockablesRepositioned(DockStation, Dockable[]). |
Leaf |
createLeaf(long id)
Creates a new
Leaf. |
Node |
createNode(long id)
Creates a new
Node. |
Placeholder |
createPlaceholder(long id)
Creates a new
Placeholder. |
Root |
createRoot(long id)
Creates a new
Root. |
void |
dockableSelected(Dockable dockable) |
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. |
void |
fire()
Fires an event to
DockStationListener.dockablesRepositioned(DockStation, Dockable[]). |
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
Spans. |
DockTitleVersion |
getTitleVersion()
Gets the kind of title
owner uses. |
boolean |
isArmed()
Tells whether this
SplitDockStation.Access currently is withholding events. |
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 putInfo)
Checks whether
info is valid or not. |
public StationChildHandle getFullScreenDockable()
SplitDockAccessDockableDisplayer which is currently in fullscreen-mode.getFullScreenDockable in interface SplitDockAccessnullpublic DockTitleVersion getTitleVersion()
SplitDockAccessowner uses.getTitleVersion in interface SplitDockAccessnullpublic SplitDockStation getOwner()
SplitDockAccessgetOwner in interface SplitDockAccesspublic double validateDivider(double divider,
Node node)
SplitDockAccessvalidateDivider in interface SplitDockAccessdivider - The value of the dividernode - the node for which the divider is validateddivider.public StationChildHandle newHandle(Dockable dockable)
SplitDockAccessnewHandle in interface SplitDockAccessdockable - the target for the new handlepublic void addHandle(StationChildHandle dockable, DockHierarchyLock.Token token)
SplitDockAccesshandle to the station and adds
the displayer to the station. Binds the dockable.addHandle in interface SplitDockAccessdockable - 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 silentlypublic void removeHandle(StationChildHandle handle, DockHierarchyLock.Token token)
SplitDockAccessremoveHandle in interface SplitDockAccesshandle - 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 silentlypublic boolean drop(Dockable dockable, SplitDockProperty property, SplitNode root)
SplitDockAccessDockable such that the boundaries given
by property are full filled.drop in interface SplitDockAccessdockable - 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 foundpublic PutInfo validatePutInfo(PutInfo putInfo)
SplitDockAccessinfo is valid or not.validatePutInfo in interface SplitDockAccessputInfo - the preferred drop locationinfo if it is valid, null otherwisepublic void repositioned(SplitNode node)
SplitDockAccessDockStationListener.dockablesRepositioned(bibliothek.gui.DockStation, Dockable[])
for all Dockables that are in node or children of node.repositioned in interface SplitDockAccessnode - the source of the eventpublic boolean isArmed()
SplitDockStation.Access currently is withholding events.public void dockableSelected(Dockable dockable)
public void arm()
this to fire an event to
DockStationListener.dockablesRepositioned(DockStation, Dockable[]).public void fire()
DockStationListener.dockablesRepositioned(DockStation, Dockable[]).public long uniqueID()
SplitDockAccessSplitNode.uniqueID in interface SplitDockAccesspublic boolean isTreeAutoCleanupEnabled()
SplitDockAccessisTreeAutoCleanupEnabled in interface SplitDockAccesstrue if auto-removal is enabledpublic SplitPlaceholderSet getPlaceholderSet()
SplitDockAccessgetPlaceholderSet in interface SplitDockAccesspublic SplitSpanStrategy getSpanStrategy()
SplitDockAccessSpans.getSpanStrategy in interface SplitDockAccessSpanFactorypublic Leaf createLeaf(long id)
SplitDockAccessLeaf.createLeaf in interface SplitDockAccessid - the unique identifier of the leafpublic Node createNode(long id)
SplitDockAccessNode.createNode in interface SplitDockAccessid - the unique identifier of the nodepublic Placeholder createPlaceholder(long id)
SplitDockAccessPlaceholder.createPlaceholder in interface SplitDockAccessid - the unique identifier of this placeholderpublic Root createRoot(long id)
Root.id - the unique identifier of the new rootpublic void setDropInfo(PutInfo putInfo)
SplitDockAccesssetDropInfo in interface SplitDockAccessputInfo - the current drop informationpublic void unsetDropInfo()
SplitDockAccessunsetDropInfo in interface SplitDockAccesspublic void drop(DockHierarchyLock.Token token, PutInfo putInfo, StationDropItem item)
SplitDockAccessDockable given by putInfo to this station.drop in interface SplitDockAccesstoken - 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 Dockableitem - detailed information about the drag and drop operation that is going onpublic void move(PutInfo putInfo, StationDropItem item)
SplitDockAccessdockable described by putInfo at a new locationmove in interface SplitDockAccessputInfo - description of the new locationitem - more information about the drag and drop operation that is currently happeningCopyright © 2017 Docking Frames. All rights reserved.