P
- the kind of object that represents a Dockable
public class DockablePlaceholderList<P extends PlaceholderListItem<Dockable>> extends PlaceholderList<Dockable,DockStation,P>
PlaceholderList
that works with real Dockable
s.PlaceholderList.Filter<M>, PlaceholderList.Item, PlaceholderList.Level
PLACEHOLDER_MAP_FORMAT
Constructor and Description |
---|
DockablePlaceholderList()
Creates a new and empty list.
|
DockablePlaceholderList(PlaceholderMap map)
Creates a new list reading all the data that is stored in
map . |
DockablePlaceholderList(PlaceholderMap map,
PlaceholderListItemConverter<Dockable,P> converter)
Creates a new list reading all the data that is stored in
map . |
Modifier and Type | Method and Description |
---|---|
protected Dockable[] |
getChildren(DockStation station)
Gets all the children of
station . |
protected Path |
getPlaceholder(Dockable dockable)
Gets the placeholder which matches
dockable . |
protected PlaceholderMap |
getPlaceholders(DockStation station)
Gets all the placeholders that are used by
station . |
protected void |
setPlaceholders(DockStation station,
PlaceholderMap map)
Sets all the placeholders that should be used by
station . |
static <P extends PlaceholderListItem<Dockable>> |
simulatedRead(PlaceholderMap map,
PlaceholderListItemConverter<Dockable,P> converter)
Simulates a call to
PlaceholderList.read(PlaceholderMap, PlaceholderListItemConverter) and makes all calls to converter
that would be made in a real read as well. |
PlaceholderMap |
toMap()
Converts this list into a
PlaceholderMap , any remaining Dockable or
DockStation will be converted into its placeholder using the currently installed
PlaceholderStrategy . |
protected DockStation |
toStation(Dockable dockable)
Converts
dockable to the representation of a DockStation . |
protected java.lang.String |
toString(Dockable dockable)
Gets a representation of
dockable as string. |
addPlaceholder, baseToLevel, bind, clear, dockables, getDockableAt, getDockableIndex, getItem, getItem, getListIndex, getListIndex, getMap, getMetaMap, getNextListIndex, getStrategy, hasPlaceholder, insertAllPlaceholders, levelToBase, list, listPlaceholders, purePlaceholders, put, put, read, read, remove, remove, removeAll, removeAll, setStrategy, size, toMap, toString, unbind
public DockablePlaceholderList()
public DockablePlaceholderList(PlaceholderMap map)
map
. This
constructor stores all placeholders that are described in map
, obsolete
placeholders may be deleted as soon as a PlaceholderStrategy
is set.map
- the map to read, not null
java.lang.IllegalArgumentException
- if map
was not written by a PlaceholderList
public DockablePlaceholderList(PlaceholderMap map, PlaceholderListItemConverter<Dockable,P> converter)
map
. This
constructor stores all placeholders that are described in map
, obsolete
placeholders may be deleted as soon as a PlaceholderStrategy
is set.map
- the map to read, not null
converter
- used to convert items back to dockables, not null
java.lang.IllegalArgumentException
- if map
was not written by a PlaceholderList
public static <P extends PlaceholderListItem<Dockable>> void simulatedRead(PlaceholderMap map, PlaceholderListItemConverter<Dockable,P> converter)
PlaceholderList.read(PlaceholderMap, PlaceholderListItemConverter)
and makes all calls to converter
that would be made in a real read as well.P
- the kind of data converter
handlesmap
- the map to readconverter
- used to convert items back to dockables, not null
public PlaceholderMap toMap()
PlaceholderMap
, any remaining Dockable
or
DockStation
will be converted into its placeholder using the currently installed
PlaceholderStrategy
.null
protected Path getPlaceholder(Dockable dockable)
PlaceholderList
dockable
.getPlaceholder
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
dockable
- some random dockabledockable
, can be null
protected DockStation toStation(Dockable dockable)
PlaceholderList
dockable
to the representation of a DockStation
.toStation
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
dockable
- some random dockabledockable
as station, can be null
protected Dockable[] getChildren(DockStation station)
PlaceholderList
station
.getChildren
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
station
- some station whose children are searchedprotected PlaceholderMap getPlaceholders(DockStation station)
PlaceholderList
station
.getPlaceholders
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
station
- some random representation of a DockStation
null
protected void setPlaceholders(DockStation station, PlaceholderMap map)
PlaceholderList
station
.setPlaceholders
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
station
- a representation of a DockStation
map
- the map of placeholders, not null
protected java.lang.String toString(Dockable dockable)
PlaceholderList
dockable
as string.toString
in class PlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>
dockable
- some random dockable, not null