bibliothek.gui.dock.station.toolbar.layout
Class DockablePlaceholderToolbarGrid<P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>

java.lang.Object
  extended by bibliothek.gui.dock.station.toolbar.layout.PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P>
      extended by bibliothek.gui.dock.station.toolbar.layout.DockablePlaceholderToolbarGrid<P>
Type Parameters:
P - the kind of object that represents a Dockable

public class DockablePlaceholderToolbarGrid<P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
extends PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P>

An implementation of PlaceholderToolbarGrid that uses Dockables and DockStations.

Author:
Benjamin Sigg

Constructor Summary
DockablePlaceholderToolbarGrid()
          Creates and initializes a new grid
 
Method Summary
protected  bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> createColumn()
          Creates one column.
protected  GridPlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> createGrid()
          Creates a new GridPlaceholderList.
protected  void fill(bibliothek.gui.Dockable dockable, bibliothek.gui.dock.station.support.ConvertedPlaceholderListItem item)
          Called by PlaceholderToolbarGrid.toMap(Map), this method should read persistent data from dockable and write that data into item.
 bibliothek.gui.dock.station.toolbar.layout.DockablePlaceholderToolbarGrid.Model getModel()
          Gets access to a simplified view of this grid.
protected  Set<bibliothek.util.Path> getPlaceholders(bibliothek.gui.Dockable dockable)
          Gets all placeholders that are associated with dockable.
protected  void onInserted()
          Called if all columns were inserted at the same time.
protected  void onInserted(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column, int index)
          Called if a new column column was added to this grid.
protected  void onInserted(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column, int columnIndex, P item, int itemIndex)
          Called if item was added to the column column.
protected  void onRemoved()
          Called if all columns were removed from this grid
protected  void onRemoved(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column, int index)
          Called if the column column was removed from this grid.
protected  void onRemoved(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column, int columnIndex, P item, int itemIndex)
          Called if item was removed to the column column.
 
Methods inherited from class bibliothek.gui.dock.station.toolbar.layout.PlaceholderToolbarGrid
allColumns, bind, clear, columns, fromMap, fromMap, get, get, get, getColumn, getColumn, getColumn, getColumnContent, getColumnCount, getLine, getLine, getLine, getLine, getLineCount, getStrategy, getTotalColumnCount, hasPlaceholder, init, insert, insert, insert, insertPlaceholder, items, move, put, remove, setStrategy, size, toMap, toMap, unbind
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DockablePlaceholderToolbarGrid

public DockablePlaceholderToolbarGrid()
Creates and initializes a new grid

Method Detail

getModel

public bibliothek.gui.dock.station.toolbar.layout.DockablePlaceholderToolbarGrid.Model getModel()
Gets access to a simplified view of this grid.

Returns:
the simplified view, never null

createColumn

protected bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> createColumn()
Description copied from class: PlaceholderToolbarGrid
Creates one column.

Specified by:
createColumn in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Returns:
a new, empty list

createGrid

protected GridPlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> createGrid()
Description copied from class: PlaceholderToolbarGrid
Creates a new GridPlaceholderList.

Specified by:
createGrid in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Returns:
the new, empty grid

getPlaceholders

protected Set<bibliothek.util.Path> getPlaceholders(bibliothek.gui.Dockable dockable)
Description copied from class: PlaceholderToolbarGrid
Gets all placeholders that are associated with dockable.

Specified by:
getPlaceholders in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
dockable - some element used by this grid
Returns:
the placeholders

fill

protected void fill(bibliothek.gui.Dockable dockable,
                    bibliothek.gui.dock.station.support.ConvertedPlaceholderListItem item)
Description copied from class: PlaceholderToolbarGrid
Called by PlaceholderToolbarGrid.toMap(Map), this method should read persistent data from dockable and write that data into item.

Specified by:
fill in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
dockable - the dockable to read
item - the item to write into

onInserted

protected void onInserted(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column,
                          int columnIndex,
                          P item,
                          int itemIndex)
Description copied from class: PlaceholderToolbarGrid
Called if item was added to the column column.

Specified by:
onInserted in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
column - a visible column
columnIndex - the index of the column
item - a new item of column
itemIndex - the index of the new item

onRemoved

protected void onRemoved(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column,
                         int columnIndex,
                         P item,
                         int itemIndex)
Description copied from class: PlaceholderToolbarGrid
Called if item was removed to the column column.

Specified by:
onRemoved in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
column - a visible column
columnIndex - the index of the column
item - the removed item of column
itemIndex - the index the item had before removing

onInserted

protected void onInserted(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column,
                          int index)
Description copied from class: PlaceholderToolbarGrid
Called if a new column column was added to this grid. The column may not contain any elements when this method is called.

Specified by:
onInserted in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
column - the new column
index - the index of the new column

onRemoved

protected void onRemoved(bibliothek.gui.dock.station.support.PlaceholderList<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P> column,
                         int index)
Description copied from class: PlaceholderToolbarGrid
Called if the column column was removed from this grid. The column may still contain elements when it is removed.

Specified by:
onRemoved in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>
Parameters:
column - the removed column
index - the index the column had before it was removed

onInserted

protected void onInserted()
Description copied from class: PlaceholderToolbarGrid
Called if all columns were inserted at the same time. This means that the grid previously was completely empty.

Specified by:
onInserted in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>

onRemoved

protected void onRemoved()
Description copied from class: PlaceholderToolbarGrid
Called if all columns were removed from this grid

Specified by:
onRemoved in class PlaceholderToolbarGrid<bibliothek.gui.Dockable,bibliothek.gui.DockStation,P extends bibliothek.gui.dock.station.support.PlaceholderListItem<bibliothek.gui.Dockable>>