bibliothek.gui.dock.station.support
Class ConvertedPlaceholderListItem

java.lang.Object
  extended by bibliothek.gui.dock.station.support.PlaceholderMetaMap
      extended by bibliothek.gui.dock.station.support.ConvertedPlaceholderListItem

public class ConvertedPlaceholderListItem
extends PlaceholderMetaMap

Data about a Dockable that was stored in a PlaceholderList.

Author:
Benjamin Sigg

Constructor Summary
ConvertedPlaceholderListItem()
           
 
Method Summary
 Path getPlaceholder()
          Gets the placeholder that is associated with this item.
 PlaceholderMap getPlaceholderMap()
          Gets additional information about this item.
 void setPlaceholder(Path placeholder)
          Associates a placeholder with this item.
 void setPlaceholderMap(PlaceholderMap map)
          Associates a map of data with this item.
 
Methods inherited from class bibliothek.gui.dock.station.support.PlaceholderMetaMap
contains, get, getBoolean, getDouble, getInt, getLong, getString, keys, put, putBoolean, putInt, putLong, putString, putValue, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConvertedPlaceholderListItem

public ConvertedPlaceholderListItem()
Method Detail

setPlaceholder

public void setPlaceholder(Path placeholder)
Associates a placeholder with this item. A PlaceholderList will insert this placeholder into its set of placeholders.

Parameters:
placeholder - the placeholder, can be null

getPlaceholder

public Path getPlaceholder()
Gets the placeholder that is associated with this item.

Returns:
the placeholder, can be null
See Also:
setPlaceholder(Path)

setPlaceholderMap

public void setPlaceholderMap(PlaceholderMap map)
Associates a map of data with this item. Notice that keys for this map must be valid placeholders. Clients may need to use the empty key (calling PlaceholderMap.newKey(Path...) with no arguments).
The map will be ignored if there is already a map associated with this item by the list itself.

Parameters:
map - the data, can be null

getPlaceholderMap

public PlaceholderMap getPlaceholderMap()
Gets additional information about this item. This is the map that was actually written, not necessarily the map that was set by setPlaceholderMap(PlaceholderMap).

Returns:
additional information, can be null
See Also:
setPlaceholderMap(PlaceholderMap)