org.drombler.commons.docking.context

Interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Type Parameters:

D - the Dockable type

DATA - the Dockable data type

E - the Dockable entry type

All Superinterfaces:

org.softsmithy.lib.beans.Bean

All Known Implementing Classes:

AbstractDockingAreaContainer, DockingPaneDockingAreaContainerAdapter

public interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>
extends org.softsmithy.lib.beans.Bean

A Docking Area container. A Docking Area container contains a set of Docking Areas and a set of Dockables (Dockable entries), which are possibly attached to a Docking Area.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_DOCKABLE_PROPERTY_NAME The name of the 'activeDockable' property.

Method Summary

Modifier and Type	Method and Description
boolean	addDockable(E dockableEntry, boolean active, Context... implicitLocalContexts) Adds a Dockable to this container.
void	addDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener) Adds a Dockable set change listener.
boolean	addDockingArea(DockingAreaDescriptor dockingAreaDescriptor) Adds a Docking Area to this container.
void	addDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener) Adds a Docking Area set change listener.
void	closeAndUnregisterView(E viewEntry) Closes and unregisters a view.
void	closeEditors(Class<? extends D> editorType) Closes all editors of the specified type.
E	getActiveDockable() Gets the active Dockable.
String	getDefaultEditorAreaId() Gets the default editor Docking Area id.
DockablePreferences	getDockablePreferences(D dockable) Gets the DockablePreferences for the specified Dockable.
Set<E>	getDockables() Gets all Dockables of this Docking Area container.
SortedSet<E>	getSortedModifiedDockables() Gets all modified Dockables of this Docking Area container, sorted by their titles.
E	openAndRegisterNewView(Class<? extends D> viewType, boolean active, String displayName, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader) Opens and registers a new view Dockable.
E	openEditorForContent(Object content, Class<? extends D> editorType, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader) Opens an Editor for the specified content.
void	registerDefaultDockablePreferences(Class<?> dockableClass, DockablePreferences dockablePreferences) Registers the default DockablePreferences for the specified Dockable class.
void	removeDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener) Removes a Dockable set change listener.
void	removeDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener) Removes a Docking Area set change listener.
void	setActiveDockable(E dockableEntry) Sets the active Dockable.
DockablePreferences	unregisterDefaultDockablePreferences(Class<?> dockableClass) Unregisters the default DockablePreferences for the specified Dockable class.

Methods inherited from interface org.softsmithy.lib.beans.Bean

addPropertyChangeListener, removePropertyChangeListener

Field Detail

ACTIVE_DOCKABLE_PROPERTY_NAME

static final String ACTIVE_DOCKABLE_PROPERTY_NAME

The name of the 'activeDockable' property.

See Also:

(), Constant Field Values

Method Detail

addDockingArea

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

addDockable

boolean addDockable(E dockableEntry,
                    boolean active,
                    Context... implicitLocalContexts)

Adds a Dockable to this container.

Parameters:

dockableEntry - the Dockable entry to add

active - flag if the added Dockable entry should be active

implicitLocalContexts - a list of implicit local contexts to be associated with the Dockable

Returns:

true, if the Dockable was added, else false

addDockingAreaSetChangeListener

void addDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener)

Adds a Docking Area set change listener.

Parameters:

listener - a Docking Area set change listener

removeDockingAreaSetChangeListener

void removeDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener)

Removes a Docking Area set change listener.

Parameters:

listener - a Docking Area set change listener

addDockableSetChangeListener

void addDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener)

Adds a Dockable set change listener.

Parameters:

listener - a Dockable set change listener

removeDockableSetChangeListener

void removeDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener)

Removes a Dockable set change listener.

Parameters:

listener - a Dockable set change listener

getDefaultEditorAreaId

String getDefaultEditorAreaId()

Gets the default editor Docking Area id.

Returns:

the default editor Docking Area id

See Also:

DockingAreaKind.EDITOR

getDockables

Set<E> getDockables()

Gets all Dockables of this Docking Area container.

Returns:

all Dockables of this Docking Area container

getSortedModifiedDockables

SortedSet<E> 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

void setActiveDockable(E dockableEntry)

Sets the active Dockable.

This is a bound property.

Parameters:

dockableEntry - the Dockable to set active

See Also:

ACTIVE_DOCKABLE_PROPERTY_NAME

getActiveDockable

E getActiveDockable()

Gets the active Dockable.

This is a bound property.

Returns:

the active Dockable

See Also:

ACTIVE_DOCKABLE_PROPERTY_NAME

openAndRegisterNewView

E openAndRegisterNewView(Class<? extends D> viewType,
                         boolean active,
                         String displayName,
                         String icon,
                         org.softsmithy.lib.util.ResourceLoader resourceLoader)

Opens and registers a new view Dockable.

Parameters:

viewType - the view type

active - flag if the new view should be set as the active Dockable in this container.

displayName - the display name of th the view

icon - the icon name pattern to get icon for the view

resourceLoader - the resource loader to load the icon

Returns:

the Dockable entry for the view

closeAndUnregisterView

void closeAndUnregisterView(E viewEntry)

Closes and unregisters a view.

Parameters:

viewEntry - the view entry for the view to close and unregister

openEditorForContent

E openEditorForContent(Object content,
                       Class<? extends D> editorType,
                       String icon,
                       org.softsmithy.lib.util.ResourceLoader resourceLoader)

Opens an Editor for the specified content. If there is already an open Editor for the specified content, no new Editor will be opened but the existing one will be set active.

Parameters:

content - the content for the editor to open/ select.

editorType - the type of the Editor. It must provide a constructor which takes the specified content as its single parameter.

icon - the icon to use for the Editor

resourceLoader - the ResourceLoader to load the icon

Returns:

true if the Editor could be opened/ selected else false

closeEditors

void closeEditors(Class<? extends D> editorType)

Closes all editors of the specified type.

Parameters:

editorType - the editor type

registerDefaultDockablePreferences

void registerDefaultDockablePreferences(Class<?> dockableClass,
                                        DockablePreferences dockablePreferences)

Registers the default DockablePreferences for the specified Dockable class.

Parameters:

dockableClass - the Dockable class

dockablePreferences - the default DockablePreferences

unregisterDefaultDockablePreferences

DockablePreferences unregisterDefaultDockablePreferences(Class<?> dockableClass)

Unregisters the default DockablePreferences for the specified Dockable class.

Parameters:

dockableClass - the Dockable class

Returns:

the previously registered DockablePreferences if any, else null

getDockablePreferences

DockablePreferences getDockablePreferences(D dockable)

Gets the DockablePreferences for the specified Dockable.

Parameters:

dockable - the Dockable

Returns:

the DockablePreferences