bibliothek.gui.dock.station.toolbar.layout

Class DockableGridPlaceholderList<P extends PlaceholderListItem<Dockable>>

java.lang.Object

bibliothek.gui.dock.station.support.PlaceholderList<ColumnItem<D,S,P>,ColumnItem<D,S,P>,Column<D,S,P>>

bibliothek.gui.dock.station.toolbar.layout.GridPlaceholderList<Dockable,DockStation,P>

bibliothek.gui.dock.station.toolbar.layout.DockableGridPlaceholderList<P>

Type Parameters:

P - the kind of object that represents a Dockable

public class DockableGridPlaceholderList<P extends PlaceholderListItem<Dockable>>
extends GridPlaceholderList<Dockable,DockStation,P>

Represents a list of lists of Dockables and placeholders.
Note: this class does not validate its content in any way, it is the clients responsibility to keep the list clean. A good wrapper is PlaceholderToolbarGrid, which adds several convenient methods and ensures that the list of lists always is cleaned up correctly.

Author:

Benjamin Sigg

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.station.support.PlaceholderList

PlaceholderList.Filter<M>, PlaceholderList.Item, PlaceholderList.Level

Field Summary

Fields inherited from class bibliothek.gui.dock.station.support.PlaceholderList

PLACEHOLDER_MAP_FORMAT

Constructor Summary

Constructors

Constructor and Description
DockableGridPlaceholderList()

Method Summary

Modifier and Type	Method and Description
protected Dockable[]	getItemChildren(DockStation station) Gets all the children of station
protected Path	getItemPlaceholder(Dockable dockable) Gest the placeholder of dockable.
protected PlaceholderMap	getItemPlaceholders(DockStation station) Gets all the placeholders of station
protected DockStation	itemToStation(Dockable dockable) Converts the item dockable to a station.
protected void	setItemPlaceholders(DockStation station, PlaceholderMap map) Sets the placeholders that are to be used by station

Methods inherited from class bibliothek.gui.dock.station.toolbar.layout.GridPlaceholderList

createColumn, getChildren, getConverter, getPlaceholder, getPlaceholders, setConverter, setPlaceholders, toStation, toString

Methods inherited from class bibliothek.gui.dock.station.support.PlaceholderList

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DockableGridPlaceholderList

public DockableGridPlaceholderList()

Method Detail

itemToStation

protected DockStation itemToStation(Dockable dockable)

Description copied from class: GridPlaceholderList

Converts the item dockable to a station.

Specified by:

itemToStation in class GridPlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>

Parameters:

dockable - the item to convert

Returns:

the converted item or null

getItemChildren

protected Dockable[] getItemChildren(DockStation station)

Description copied from class: GridPlaceholderList

Gets all the children of station

Specified by:

getItemChildren in class GridPlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>

Parameters:

station - the station whose children are searched

Returns:

all the children

getItemPlaceholder

protected Path getItemPlaceholder(Dockable dockable)

Description copied from class: GridPlaceholderList

Gest the placeholder of dockable.

Specified by:

getItemPlaceholder in class GridPlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>

Parameters:

dockable - some element of this grid

Returns:

the placeholder or null

getItemPlaceholders

protected PlaceholderMap getItemPlaceholders(DockStation station)

Description copied from class: GridPlaceholderList

Gets all the placeholders of station

Specified by:

getItemPlaceholders in class GridPlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>

Parameters:

station - some station

Returns:

all the placeholders, can be null

setItemPlaceholders

protected void setItemPlaceholders(DockStation station,
                                   PlaceholderMap map)

Description copied from class: GridPlaceholderList

Sets the placeholders that are to be used by station

Specified by:

setItemPlaceholders in class GridPlaceholderList<Dockable,DockStation,P extends PlaceholderListItem<Dockable>>

Parameters:

station - the station whose layout is to be updated

map - the new placeholders, never null