public class SplitDockPlaceholderMapping extends java.lang.Object implements PlaceholderMapping
PlaceholderMapping
representing the placeholders on a SplitDockStation
.Constructor and Description |
---|
SplitDockPlaceholderMapping(SplitDockStation station)
Creates a new mapping for
station . |
Modifier and Type | Method and Description |
---|---|
void |
addPlaceholder(Dockable dockable,
Path placeholder)
First searches the location of
dockable , then adds placeholder to that
location. |
Dockable |
getDockableAt(Path placeholder)
Searches for the placeholder
placeholder and gets the Dockable that is currently sitting
at the location described by placeholder . |
DockableProperty |
getLocationAt(Path placeholder)
Gets a
DockableProperty that describes the location of placeholder . |
SplitDockStation |
getStation()
Gets the
DockStation which created this mapping in its DockStation.getPlaceholderMapping() . |
boolean |
hasPlaceholder(Path placeholder)
Tells whether the
station has any reference to placeholder . |
void |
removePlaceholder(Path placeholder)
Removes all occurrences of
placeholder from this station. |
public SplitDockPlaceholderMapping(SplitDockStation station)
station
. Clients should not call this method, instead they
should call SplitDockStation.getPlaceholderMapping()
.station
- the source of the mappingpublic SplitDockStation getStation()
PlaceholderMapping
DockStation
which created this mapping in its DockStation.getPlaceholderMapping()
.getStation
in interface PlaceholderMapping
public void addPlaceholder(Dockable dockable, Path placeholder)
PlaceholderMapping
dockable
, then adds placeholder
to that
location. If another dockable is dropped on this station, and that item is associated with placeholder
,
then it will be put at the same position as dockable
.
This method will remove placeholder
from any other position on the station.addPlaceholder
in interface PlaceholderMapping
dockable
- a child of this station, must not be null
placeholder
- the placeholder to add, must not be null
public void removePlaceholder(Path placeholder)
PlaceholderMapping
placeholder
from this station.removePlaceholder
in interface PlaceholderMapping
placeholder
- the placeholder to remove, must not be null
public Dockable getDockableAt(Path placeholder)
PlaceholderMapping
placeholder
and gets the Dockable
that is currently sitting
at the location described by placeholder
.getDockableAt
in interface PlaceholderMapping
placeholder
- the placeholder to searchplaceholder
, or null
either because placeholder
could not be found, or because placeholder
describes a position that does currently not contain
a Dockable
public DockableProperty getLocationAt(Path placeholder)
PlaceholderMapping
DockableProperty
that describes the location of placeholder
. The result of this
method is undefined if placeholder
is not found.getLocationAt
in interface PlaceholderMapping
placeholder
- the placeholder whose location is searchednull
if placeholder
is not foundpublic boolean hasPlaceholder(Path placeholder)
PlaceholderMapping
station
has any reference to placeholder
.hasPlaceholder
in interface PlaceholderMapping
placeholder
- the placeholder to searchtrue
if placeholder
was found