public interface PlaceholderMapping
DockStation
. Placeholders are unique identifiers that can be attached
to certain locations on a station. During runtime placeholders may be replaced by real Dockable
s.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 . |
DockStation |
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. |
DockStation getStation()
DockStation
which created this mapping in its DockStation.getPlaceholderMapping()
.void addPlaceholder(Dockable dockable, Path placeholder)
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.dockable
- a child of this station, must not be null
placeholder
- the placeholder to add, must not be null
java.lang.IllegalArgumentException
- if dockable
is not a child of this station, or if any argument is null
boolean hasPlaceholder(Path placeholder)
station
has any reference to placeholder
.placeholder
- the placeholder to searchtrue
if placeholder
was foundDockable getDockableAt(Path placeholder)
placeholder
and gets the Dockable
that is currently sitting
at the location described by placeholder
.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
DockableProperty getLocationAt(Path placeholder)
DockableProperty
that describes the location of placeholder
. The result of this
method is undefined if placeholder
is not found.placeholder
- the placeholder whose location is searchednull
if placeholder
is not foundvoid removePlaceholder(Path placeholder)
placeholder
from this station.placeholder
- the placeholder to remove, must not be null