bibliothek.gui.dock.common.perspective
Class CGridPerspective.CommonSplitDockPerspective

java.lang.Object
  bibliothek.gui.dock.station.split.SplitDockPerspective
      bibliothek.gui.dock.common.perspective.CGridPerspective.CommonSplitDockPerspective

All Implemented Interfaces:

CommonDockStationPerspective, CommonElementPerspective, PerspectiveDockable, PerspectiveElement, PerspectiveStation, PlaceholderListItem<PerspectiveDockable>

Enclosing class:

CGridPerspective

public class CGridPerspective.CommonSplitDockPerspective
extends SplitDockPerspective
implements CommonDockStationPerspective

The type of object that is used by a CGridPerspective as intern representation.

Author:

Benjamin Sigg

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.station.split.SplitDockPerspective

SplitDockPerspective.Entry, SplitDockPerspective.EntryListener, SplitDockPerspective.Leaf, SplitDockPerspective.Node, SplitDockPerspective.Root

Constructor Summary

CGridPerspective.CommonSplitDockPerspective()

Method Summary

protected PerspectiveDockable	combine(PerspectiveDockable[] dockables, PerspectiveDockable selection) Combines several dockables to one dockable.
String	getConverterID() Gets the unique identifier of the DockFactory that is actually used to layout this perspective.
PerspectiveDockable	getDockable(int index) Gets the index'th child of this station.
int	getDockableCount() Gets the number of children this station has.
CElementPerspective	getElement() Gets the element that is represented by this PerspectiveElement.
String	getFactoryID() Gets the identifier of the DockFactory that will be able to understand the layout information this element generates.
Path	getPlaceholder() Gets the placeholder which is associated with this Dockable.
SplitDockPerspective.Root	getRoot() Gets the root of the tree that is the layout of this station.
void	read(PerspectiveSplitDockTree tree, PerspectiveDockable fullscreen) Reads the contents of tree and replaces any content of this perspective

Methods inherited from class bibliothek.gui.dock.station.split.SplitDockPerspective

addListener, addPlaceholder, asDockable, asStation, fireAdded, fireRemoved, getDockablePathProperty, getDockableProperty, getFullscreen, getLeaf, getParent, getPlaceholders, hasFullscreenAction, listeners, remove, removeListener, replace, setFullscreen, setHasFullscreenAction, setParent, setPlaceholders

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

asDockable, asStation

Constructor Detail

CGridPerspective.CommonSplitDockPerspective

public CGridPerspective.CommonSplitDockPerspective()

Method Detail

getElement

public CElementPerspective getElement()

Description copied from interface: CommonElementPerspective

Gets the element that is represented by this PerspectiveElement.

Specified by:

getElement in interface CommonElementPerspective

Returns:

the represented element, not null

getFactoryID

public String getFactoryID()

Description copied from interface: PerspectiveElement

Gets the identifier of the DockFactory that will be able to understand the layout information this element generates.

Specified by:

getFactoryID in interface CommonDockStationPerspective

Specified by:

getFactoryID in interface PerspectiveElement

Overrides:

getFactoryID in class SplitDockPerspective

Returns:

the factories identifier

getConverterID

public String getConverterID()

Description copied from interface: CommonDockStationPerspective

Gets the unique identifier of the DockFactory that is actually used to layout this perspective.

Specified by:

getConverterID in interface CommonDockStationPerspective

Returns:

the identifier of the actual factory

See Also:

CommonDockStation.getConverterID()

read

public void read(PerspectiveSplitDockTree tree,
                 PerspectiveDockable fullscreen)

Description copied from class: SplitDockPerspective

Reads the contents of tree and replaces any content of this perspective

Overrides:

read in class SplitDockPerspective

Parameters:

tree - the tree that represents this perspective

fullscreen - the one child that is currently in fullscreen-mode, can be null

combine

protected PerspectiveDockable combine(PerspectiveDockable[] dockables,
                                      PerspectiveDockable selection)

Description copied from class: SplitDockPerspective

Combines several dockables to one dockable.

Overrides:

combine in class SplitDockPerspective

Parameters:

dockables - the element to combine

selection - the selected element, can be null

Returns:

the combination

getPlaceholder

public Path getPlaceholder()

Description copied from interface: PerspectiveDockable

Gets the placeholder which is associated with this Dockable.

Specified by:

getPlaceholder in interface PerspectiveDockable

Overrides:

getPlaceholder in class SplitDockPerspective

Returns:

the placeholder, can be null

getRoot

public SplitDockPerspective.Root getRoot()

Description copied from class: SplitDockPerspective

Gets the root of the tree that is the layout of this station.

Overrides:

getRoot in class SplitDockPerspective

Returns:

the root of the tree, not null

getDockableCount

public int getDockableCount()

Description copied from interface: PerspectiveStation

Gets the number of children this station has.

Specified by:

getDockableCount in interface PerspectiveStation

Overrides:

getDockableCount in class SplitDockPerspective

Returns:

the number of children

getDockable

public PerspectiveDockable getDockable(int index)

Description copied from interface: PerspectiveStation

Gets the index'th child of this station.

Specified by:

getDockable in interface PerspectiveStation

Overrides:

getDockable in class SplitDockPerspective

Parameters:

index - the index of a child

Returns:

the child, not null