bibliothek.gui.dock.station.toolbar

Class ToolbarGroupDockPerspective

java.lang.Object

bibliothek.gui.dock.station.toolbar.ToolbarGroupDockPerspective

All Implemented Interfaces:

PerspectiveDockable, PerspectiveElement, PerspectiveStation, PlaceholderListItem<PerspectiveDockable>

public class ToolbarGroupDockPerspective
extends Object
implements PerspectiveStation, PerspectiveDockable

A PerspectiveStation representing a ToolbarGroupDockStation.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
ToolbarGroupDockPerspective() Creates a new, empty station.
ToolbarGroupDockPerspective(ToolbarGroupDockStationLayout layout, Map<Integer,PerspectiveDockable> children) Creates a new station.

Method Summary

Modifier and Type	Method and Description
void	add(int column, PerspectiveDockable dockable) Adds dockable at the end of column column.
PerspectiveDockable	asDockable()
PerspectiveStation	asStation()
int	getColumnCount() Gets the number of columns, only includes columns that contain at least one child.
PerspectiveDockable	getDockable(int index)
PerspectiveDockable	getDockable(int column, int line) Gets the item that is stored in column column at line line.
int	getDockableCount()
DockableProperty	getDockableProperty(PerspectiveDockable child, PerspectiveDockable target)
PerspectivePlaceholderToolbarGrid	getDockables() Allows access to the internal data structure of this station.
ExpandedState	getExpandedState() Gets the default size of this station.
String	getFactoryID()
int	getLineCount(int column) Gets the number of items in column.
ToolbarColumnModel<PerspectiveDockable,PerspectiveDockable>	getModel() Gets access to an abstraction of the model of this station.
Orientation	getOrientation() Gets the orientation of this station.
PerspectiveStation	getParent()
Path	getPlaceholder()
PlaceholderMap	getPlaceholders()
void	insert(int column, int line, PerspectiveDockable dockable) Adds dockable to column column at position line.
void	insert(int column, PerspectiveDockable dockable) Adds a new column to the grid and inserts dockable as first child.
void	read(ToolbarGroupDockStationLayout layout, Map<Integer,PerspectiveDockable> children) Updates the layout of this station by reading layout.
void	remove(int column, int line) Removes the item at column/line.
boolean	remove(PerspectiveDockable dockable)
void	replace(PerspectiveDockable oldDockable, PerspectiveDockable newDockable)
void	setExpandedtState(ExpandedState state) Sets the default size of this station
void	setOrientation(Orientation orientation) Sets the orientation of this station.
void	setParent(PerspectiveStation parent)
void	setPlaceholders(PlaceholderMap placeholders)
PlaceholderMap	toMap(Map<PerspectiveDockable,Integer> children) Converts this station into a map of PerspectiveDockables.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolbarGroupDockPerspective

public ToolbarGroupDockPerspective()

Creates a new, empty station.

ToolbarGroupDockPerspective

public ToolbarGroupDockPerspective(ToolbarGroupDockStationLayout layout,
                                   Map<Integer,PerspectiveDockable> children)

Creates a new station.

Parameters:

layout - the layout of the station

children - the unique identifiers of the children

Method Detail

read

public void read(ToolbarGroupDockStationLayout layout,
                 Map<Integer,PerspectiveDockable> children)

Updates the layout of this station by reading layout.

Parameters:

layout - the new layout

children - the new children of this station

getDockables

public PerspectivePlaceholderToolbarGrid getDockables()

Allows access to the internal data structure of this station. Clients should be very carefull when using this structure, as there are no options to ensure the validity of the structure. If possible, clients should only read data from the structure, and should not execute any write operations.

Returns:

the internal data structure

toMap

public PlaceholderMap toMap(Map<PerspectiveDockable,Integer> children)

Converts this station into a map of PerspectiveDockables.

Parameters:

children - the unique identifiers of the children

Returns:

the map of dockables

setExpandedtState

public void setExpandedtState(ExpandedState state)

Sets the default size of this station

Parameters:

state - the size, not null

getExpandedState

public ExpandedState getExpandedState()

Gets the default size of this station.

Returns:

the size, not null

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation of this station. Please note that the orientation can be overridden by the parent DockStation.

Parameters:

orientation - the orientation, must not be null

getOrientation

public Orientation getOrientation()

Gets the orientation of this station.

Returns:

the orientation, not null

getModel

public ToolbarColumnModel<PerspectiveDockable,PerspectiveDockable> getModel()

Gets access to an abstraction of the model of this station. This is the same class that is used by the ToolbarGroupDockStation, hence it's behavior is identical.

Returns:

the model, can be monitored to receive information about changes

getDockable

public PerspectiveDockable getDockable(int column,
                                       int line)

Gets the item that is stored in column column at line line.

Parameters:

column - the column in which to search

line - the line in which the dockable should be found

Returns:

the item at column/line

getColumnCount

public int getColumnCount()

Gets the number of columns, only includes columns that contain at least one child.

Returns:

the number of non-empty columns

getLineCount

public int getLineCount(int column)

Gets the number of items in column.

Parameters:

column - the column whose size is asked

Returns:

the number of children in column

add

public void add(int column,
                PerspectiveDockable dockable)

Adds dockable at the end of column column. This method may create a new column.

Parameters:

column - the index of a column

dockable - the item to add to column

insert

public void insert(int column,
                   int line,
                   PerspectiveDockable dockable)

Adds dockable to column column at position line. This method may create a new column.

Parameters:

column - the column in which to insert the new item

line - the position in the column

dockable - the new item

insert

public void insert(int column,
                   PerspectiveDockable dockable)

Adds a new column to the grid and inserts dockable as first child. This method will try to reuse existing but empty columns if possible.

Parameters:

column - The index of the new column, can be -1 to create a column at the beginning of the list

dockable - the new item

remove

public void remove(int column,
                   int line)

Removes the item at column/line.

Parameters:

column - the column from which the dockable should be removed

line - the line in which the dockable is currently stored

getFactoryID

public String getFactoryID()

Specified by:

getFactoryID in interface PerspectiveElement

asStation

public PerspectiveStation asStation()

Specified by:

asStation in interface PerspectiveElement

asDockable

public PerspectiveDockable asDockable()

Specified by:

asDockable in interface PerspectiveElement

Specified by:

asDockable in interface PlaceholderListItem<PerspectiveDockable>

getPlaceholder

public Path getPlaceholder()

Specified by:

getPlaceholder in interface PerspectiveDockable

getParent

public PerspectiveStation getParent()

Specified by:

getParent in interface PerspectiveDockable

setParent

public void setParent(PerspectiveStation parent)

Specified by:

setParent in interface PerspectiveDockable

getDockableCount

public int getDockableCount()

Specified by:

getDockableCount in interface PerspectiveStation

getDockable

public PerspectiveDockable getDockable(int index)

Specified by:

getDockable in interface PerspectiveStation

getDockableProperty

public DockableProperty getDockableProperty(PerspectiveDockable child,
                                            PerspectiveDockable target)

Specified by:

getDockableProperty in interface PerspectiveStation

getPlaceholders

public PlaceholderMap getPlaceholders()

Specified by:

getPlaceholders in interface PerspectiveStation

setPlaceholders

public void setPlaceholders(PlaceholderMap placeholders)

Specified by:

setPlaceholders in interface PerspectiveStation

remove

public boolean remove(PerspectiveDockable dockable)

Specified by:

remove in interface PerspectiveStation

replace

public void replace(PerspectiveDockable oldDockable,
                    PerspectiveDockable newDockable)

Specified by:

replace in interface PerspectiveStation