bibliothek.gui.dock.station.toolbar.layout

Class GridPlaceholderList<D,S,P extends PlaceholderListItem<D>>

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<D,S,P>

Type Parameters:

D - the kind of object that should be treated as Dockable

S - the kind of object that should be treated as DockStation

P - the type of item which represents a Dockable

Direct Known Subclasses:

DockableGridPlaceholderList, PerspectiveGridPlaceholderList

public abstract class GridPlaceholderList<D,S,P extends PlaceholderListItem<D>>
extends PlaceholderList<ColumnItem<D,S,P>,ColumnItem<D,S,P>,Column<D,S,P>>

This PlaceholderList stores Columns as items, where one Column is just another PlaceholderList.

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
GridPlaceholderList()

Method Summary

Modifier and Type	Method and Description
Column<D,S,P>	createColumn(PlaceholderList<D,S,P> content) Factory method creating an new Column that can be added to this list.
protected ColumnItem<D,S,P>[]	getChildren(ColumnItem<D,S,P> station)
PlaceholderListItemConverter<D,P>	getConverter() Gets the converter that is used to read and write Columns.
protected abstract D[]	getItemChildren(S station) Gets all the children of station
protected abstract Path	getItemPlaceholder(D dockable) Gest the placeholder of dockable.
protected abstract PlaceholderMap	getItemPlaceholders(S station) Gets all the placeholders of station
protected Path	getPlaceholder(ColumnItem<D,S,P> dockable)
protected PlaceholderMap	getPlaceholders(ColumnItem<D,S,P> station)
protected abstract S	itemToStation(D dockable) Converts the item dockable to a station.
void	setConverter(PlaceholderListItemConverter<D,P> converter) Sets the PlaceholderListItemConverter which should be used to convert the internal lists of this grid.
protected abstract void	setItemPlaceholders(S station, PlaceholderMap map) Sets the placeholders that are to be used by station
protected void	setPlaceholders(ColumnItem<D,S,P> station, PlaceholderMap map)
protected ColumnItem<D,S,P>	toStation(ColumnItem<D,S,P> dockable)
protected String	toString(ColumnItem<D,S,P> dockable)

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

GridPlaceholderList

public GridPlaceholderList()

Method Detail

createColumn

public Column<D,S,P> createColumn(PlaceholderList<D,S,P> content)

Factory method creating an new Column that can be added to this list.

Parameters:

content - the content of the column, not null

Returns:

a new, empty column that is yet unknown to this list

setConverter

public void setConverter(PlaceholderListItemConverter<D,P> converter)

Sets the PlaceholderListItemConverter which should be used to convert the internal lists of this grid.

Parameters:

converter - the converter to use, can be null

getConverter

public PlaceholderListItemConverter<D,P> getConverter()

Gets the converter that is used to read and write Columns.

Returns:

the converter, never null

getPlaceholder

protected Path getPlaceholder(ColumnItem<D,S,P> dockable)

Specified by:

getPlaceholder in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

toString

protected String toString(ColumnItem<D,S,P> dockable)

Specified by:

toString in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

toStation

protected ColumnItem<D,S,P> toStation(ColumnItem<D,S,P> dockable)

Specified by:

toStation in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

getPlaceholders

protected PlaceholderMap getPlaceholders(ColumnItem<D,S,P> station)

Specified by:

getPlaceholders in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

setPlaceholders

protected void setPlaceholders(ColumnItem<D,S,P> station,
                               PlaceholderMap map)

Specified by:

setPlaceholders in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

getChildren

protected ColumnItem<D,S,P>[] getChildren(ColumnItem<D,S,P> station)

Specified by:

getChildren in class PlaceholderList<ColumnItem<D,S,P extends PlaceholderListItem<D>>,ColumnItem<D,S,P extends PlaceholderListItem<D>>,Column<D,S,P extends PlaceholderListItem<D>>>

itemToStation

protected abstract S itemToStation(D dockable)

Converts the item dockable to a station.

Parameters:

dockable - the item to convert

Returns:

the converted item or null

getItemChildren

protected abstract D[] getItemChildren(S station)

Gets all the children of station

Parameters:

station - the station whose children are searched

Returns:

all the children

getItemPlaceholder

protected abstract Path getItemPlaceholder(D dockable)

Gest the placeholder of dockable.

Parameters:

dockable - some element of this grid

Returns:

the placeholder or null

getItemPlaceholders

protected abstract PlaceholderMap getItemPlaceholders(S station)

Gets all the placeholders of station

Parameters:

station - some station

Returns:

all the placeholders, can be null

setItemPlaceholders

protected abstract void setItemPlaceholders(S station,
                                            PlaceholderMap map)

Sets the placeholders that are to be used by station

Parameters:

station - the station whose layout is to be updated

map - the new placeholders, never null