org.drombler.commons.docking.fx.context

Class DockingPaneDockingAreaContainerAdapter

java.lang.Object

org.drombler.commons.docking.context.AbstractDockingAreaContainer<Node,FXDockableData,FXDockableEntry>

org.drombler.commons.docking.fx.context.DockingPaneDockingAreaContainerAdapter

All Implemented Interfaces:

AutoCloseable, DockingAreaContainer<Node,FXDockableData,FXDockableEntry>, org.softsmithy.lib.beans.Bean

public class DockingPaneDockingAreaContainerAdapter
extends AbstractDockingAreaContainer<Node,FXDockableData,FXDockableEntry>

An adapter to use a DockingPane as a DockingAreaContainer.

Author:

puce

Field Summary

Fields inherited from interface org.drombler.commons.docking.context.DockingAreaContainer

ACTIVE_DOCKABLE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
DockingPaneDockingAreaContainerAdapter(DockingPane dockingPane, ContextManager contextManager) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	addDockingArea(DockingAreaDescriptor dockingAreaDescriptor) Adds a Docking Area to this container.
FXDockableEntry	getActiveDockable() Gets the active Dockable.
String	getDefaultEditorAreaId() Gets the default editor Docking Area id.
Set<FXDockableEntry>	getDockables() Gets all Dockables of this Docking Area container.
SortedSet<FXDockableEntry>	getSortedModifiedDockables() Gets all modified Dockables of this Docking Area container, sorted by their titles.
void	setActiveDockable(FXDockableEntry dockableEntry) Sets the active Dockable.

Methods inherited from class org.drombler.commons.docking.context.AbstractDockingAreaContainer

addDockable, addDockableSetChangeListener, addDockingAreaSetChangeListener, addPropertyChangeListener, close, closeAndUnregisterView, closeEditors, fireActiveDockableChanged, fireDockableAdded, fireDockableRemoved, fireDockingAreaAdded, fireDockingAreaRemoved, getContent, getDockablePreferences, openAndRegisterNewView, openEditorForContent, registerDefaultDockablePreferences, removeDockableSetChangeListener, removeDockingAreaSetChangeListener, removePropertyChangeListener, unregisterDefaultDockablePreferences

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingPaneDockingAreaContainerAdapter

public DockingPaneDockingAreaContainerAdapter(DockingPane dockingPane,
                                              ContextManager contextManager)

Creates a new instance of this class.

Parameters:

dockingPane - the DockingPane

contextManager - the ContextManager

Method Detail

addDockingArea

public boolean addDockingArea(DockingAreaDescriptor dockingAreaDescriptor)

Adds a Docking Area to this container.

Parameters:

dockingAreaDescriptor - the Docking Area descriptor

Returns:

true, if it was added, else false

getDefaultEditorAreaId

public String getDefaultEditorAreaId()

Gets the default editor Docking Area id.

Returns:

the default editor Docking Area id

See Also:

DockingAreaKind.EDITOR

getDockables

public Set<FXDockableEntry> getDockables()

Gets all Dockables of this Docking Area container.

Returns:

all Dockables of this Docking Area container

getSortedModifiedDockables

public SortedSet<FXDockableEntry> getSortedModifiedDockables()

Gets all modified Dockables of this Docking Area container, sorted by their titles.

Returns:

all Dockables of this Docking Area container

See Also:

DockableData.getTitle()

setActiveDockable

public void setActiveDockable(FXDockableEntry dockableEntry)

Sets the active Dockable.

This is a bound property.

Parameters:

dockableEntry - the Dockable to set active

See Also:

DockingAreaContainer.ACTIVE_DOCKABLE_PROPERTY_NAME

getActiveDockable

public FXDockableEntry getActiveDockable()

Gets the active Dockable.

This is a bound property.

Returns:

the active Dockable

See Also:

DockingAreaContainer.ACTIVE_DOCKABLE_PROPERTY_NAME