bibliothek.gui.dock.station.toolbar

Class ListDockableStationPerspective

java.lang.Object

bibliothek.gui.dock.station.toolbar.ListDockableStationPerspective

All Implemented Interfaces:

PerspectiveDockable, PerspectiveElement, PerspectiveStation, PlaceholderListItem<PerspectiveDockable>

Direct Known Subclasses:

ToolbarContainerDockPerspective, ToolbarDockPerspective

public abstract class ListDockableStationPerspective
extends Object
implements PerspectiveStation, PerspectiveDockable

An abstract implementation of a PerspectiveStation whose children are organized in a list.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
ListDockableStationPerspective() Creates a new, empty perspective
ListDockableStationPerspective(PerspectiveDockable[] children) Creates a new perspective, adds children to this station.

Method Summary

Modifier and Type	Method and Description
void	add(int index, PerspectiveDockable dockable) Adds dockable at location index in the list of children.
void	add(PerspectiveDockable dockable) Adds dockable at the end of the list of children.
PerspectiveDockable	asDockable()
PerspectiveStation	asStation()
PerspectiveDockable	getDockable(int index)
int	getDockableCount()
protected abstract DockableProperty	getDockableProperty(int index, Path placeholder, PerspectiveDockable child, PerspectiveDockable target) Called by getDockableProperty(PerspectiveDockable, PerspectiveDockable), returns a new DockableProperty which matches the location described by index and placeholder.
DockableProperty	getDockableProperty(PerspectiveDockable child, PerspectiveDockable target)
PerspectivePlaceholderList<PerspectiveDockable>	getDockables() Gets direct access to the list of dockables, should be used with care.
PerspectiveStation	getParent()
Path	getPlaceholder()
PlaceholderMap	getPlaceholders()
int	indexOf(PerspectiveDockable dockable) Gets the location of dockable on this station.
PerspectiveDockable	remove(int index) Removes the PerspectiveDockable which is stored at location index.
boolean	remove(PerspectiveDockable dockable)
void	replace(PerspectiveDockable oldDockable, PerspectiveDockable newDockable)
protected void	setDockables(PerspectivePlaceholderList<PerspectiveDockable> dockables) Sets the list which contains all the children.
void	setParent(PerspectiveStation parent)
void	setPlaceholders(PlaceholderMap placeholders)

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.perspective.PerspectiveElement

getFactoryID

Constructor Detail

ListDockableStationPerspective

public ListDockableStationPerspective()

Creates a new, empty perspective

ListDockableStationPerspective

public ListDockableStationPerspective(PerspectiveDockable[] children)

Creates a new perspective, adds children to this station.

Parameters:

children - the children to add

Method Detail

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>

getDockableCount

public int getDockableCount()

Specified by:

getDockableCount in interface PerspectiveStation

getDockable

public PerspectiveDockable getDockable(int index)

Specified by:

getDockable in interface PerspectiveStation

indexOf

public int indexOf(PerspectiveDockable dockable)

Gets the location of dockable on this station.

Parameters:

dockable - the item to search

Returns:

the location or -1 if not found

add

public void add(PerspectiveDockable dockable)

Adds dockable at the end of the list of children.

Parameters:

dockable - the item to add, not null

add

public void add(int index,
                PerspectiveDockable dockable)

Adds dockable at location index in the list of children.

Parameters:

index - the location of the new child

dockable - the new child, not null

getDockables

@FrameworkOnly
public PerspectivePlaceholderList<PerspectiveDockable> getDockables()

Gets direct access to the list of dockables, should be used with care.

Returns:

the list of dockables

setDockables

protected void setDockables(PerspectivePlaceholderList<PerspectiveDockable> dockables)

Sets the list which contains all the children.

Parameters:

dockables - the list of the children

getDockableProperty

public DockableProperty getDockableProperty(PerspectiveDockable child,
                                            PerspectiveDockable target)

Specified by:

getDockableProperty in interface PerspectiveStation

getDockableProperty

protected abstract DockableProperty getDockableProperty(int index,
                                                        Path placeholder,
                                                        PerspectiveDockable child,
                                                        PerspectiveDockable target)

Called by getDockableProperty(PerspectiveDockable, PerspectiveDockable), returns a new DockableProperty which matches the location described by index and placeholder.

Parameters:

index - the index of the item in the list of dockables, can be -1

placeholder - the name of the item, can be null

child - the child whose location is requested

target - the item whose location is requested, this may be child

Returns:

the location of child

getPlaceholders

public PlaceholderMap getPlaceholders()

Specified by:

getPlaceholders in interface PerspectiveStation

setPlaceholders

public void setPlaceholders(PlaceholderMap placeholders)

Specified by:

setPlaceholders in interface PerspectiveStation

remove

public PerspectiveDockable remove(int index)

Removes the PerspectiveDockable which is stored at location index.

Parameters:

index - the index of the item to remove

Returns:

the item that was removed

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

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