org.drombler.commons.docking.context

Class AbstractDockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

java.lang.Object

org.drombler.commons.docking.context.AbstractDockingAreaContainer<D,DATA,E>

Type Parameters:

D - the Dockable type

DATA - the Dockable data type

E - the Dockable entry type

All Implemented Interfaces:

AutoCloseable, DockingAreaContainer<D,DATA,E>, org.softsmithy.lib.beans.Bean

Direct Known Subclasses:

DockingPaneDockingAreaContainerAdapter

public abstract class AbstractDockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>
extends Object
implements DockingAreaContainer<D,DATA,E>, AutoCloseable

An abstract base class for DockingAreaContainer implementations.

Field Summary

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

ACTIVE_DOCKABLE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractDockingAreaContainer(DockableEntryFactory<D,DATA,E> dockableEntryFactory, DockableDataFactory<DATA> dockableDataFactory, ContextManager contextManager) Creates a new instance of this class.

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.
void	addDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener) Adds a Docking Area set change listener.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	close()
void	closeAndUnregisterView(E viewEntry) Closes and unregisters a view.
void	closeEditors(Class<? extends D> editorType) Closes all editors of the specified type.
protected void	fireActiveDockableChanged(E oldActiveDockableEntry, E newActiveDockableEntry) Fires a property change event for the 'activeDockable' property.
protected void	fireDockableAdded(Set<E> sourceSet, E dockableEntry) Fires an elementAdded event to the Dockable SetChangeListeners.
protected void	fireDockableRemoved(Set<E> sourceSet, E dockableEntry) Fires an elementRemoved event to the Dockable SetChangeListeners.
protected void	fireDockingAreaAdded(Set<DockingAreaDescriptor> sourceSet, DockingAreaDescriptor dockingAreaDescriptor) Fires an elementAdded event to the Docking Area SetChangeListeners.
protected void	fireDockingAreaRemoved(Set<DockingAreaDescriptor> sourceSet, DockingAreaDescriptor dockingAreaDescriptor) Fires an elementRemoved event to the Docking Area SetChangeListeners.
<T> T	getContent(D dockable, Class<T> contentType) Gets the content of the specified type from the local context of the specified Dockable.
DockablePreferences	getDockablePreferences(D dockable) Gets the DockablePreferences for the specified Dockable.
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	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
DockablePreferences	unregisterDefaultDockablePreferences(Class<?> dockableClass) Unregisters the default DockablePreferences for the specified Dockable class.

Methods inherited from class java.lang.Object

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

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

addDockingArea, getActiveDockable, getDefaultEditorAreaId, getDockables, getSortedModifiedDockables, setActiveDockable

Constructor Detail

AbstractDockingAreaContainer

public AbstractDockingAreaContainer(DockableEntryFactory<D,DATA,E> dockableEntryFactory,
                                    DockableDataFactory<DATA> dockableDataFactory,
                                    ContextManager contextManager)

Creates a new instance of this class.

Parameters:

dockableEntryFactory - the Dockable entry factory

dockableDataFactory - the Dockable data factory

contextManager - the context manager

Method Detail

addDockable

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

Adds a Dockable to this container.

Specified by:

addDockable in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

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

getContent

public <T> T getContent(D dockable,
                        Class<T> contentType)

Gets the content of the specified type from the local context of the specified Dockable.

Type Parameters:

T - the content type

Parameters:

dockable - the Dockable

contentType - the content type

Returns:

the content

openAndRegisterNewView

public 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.

Specified by:

openAndRegisterNewView in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

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

public void closeAndUnregisterView(E viewEntry)

Closes and unregisters a view.

Specified by:

closeAndUnregisterView in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

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

openEditorForContent

public 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.

Specified by:

openEditorForContent in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

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

public void closeEditors(Class<? extends D> editorType)

Closes all editors of the specified type.

Specified by:

closeEditors in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

editorType - the editor type

registerDefaultDockablePreferences

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

Registers the default DockablePreferences for the specified Dockable class.

Specified by:

registerDefaultDockablePreferences in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

dockableClass - the Dockable class

dockablePreferences - the default DockablePreferences

unregisterDefaultDockablePreferences

public DockablePreferences unregisterDefaultDockablePreferences(Class<?> dockableClass)

Unregisters the default DockablePreferences for the specified Dockable class.

Specified by:

unregisterDefaultDockablePreferences in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

dockableClass - the Dockable class

Returns:

the previously registered DockablePreferences if any, else null

getDockablePreferences

public DockablePreferences getDockablePreferences(D dockable)

Gets the DockablePreferences for the specified Dockable.

Specified by:

getDockablePreferences in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

dockable - the Dockable

Returns:

the DockablePreferences

addDockingAreaSetChangeListener

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

Adds a Docking Area set change listener.

Specified by:

addDockingAreaSetChangeListener in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

listener - a Docking Area set change listener

removeDockingAreaSetChangeListener

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

Removes a Docking Area set change listener.

Specified by:

removeDockingAreaSetChangeListener in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

listener - a Docking Area set change listener

addDockableSetChangeListener

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

Adds a Dockable set change listener.

Specified by:

addDockableSetChangeListener in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

listener - a Dockable set change listener

removeDockableSetChangeListener

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

Removes a Dockable set change listener.

Specified by:

removeDockableSetChangeListener in interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Parameters:

listener - a Dockable set change listener

fireDockingAreaAdded

protected final void fireDockingAreaAdded(Set<DockingAreaDescriptor> sourceSet,
                                          DockingAreaDescriptor dockingAreaDescriptor)

Fires an elementAdded event to the Docking Area SetChangeListeners.

Parameters:

sourceSet - the source set

dockingAreaDescriptor - the Docking Area descriptor which was added to the set

fireDockingAreaRemoved

protected final void fireDockingAreaRemoved(Set<DockingAreaDescriptor> sourceSet,
                                            DockingAreaDescriptor dockingAreaDescriptor)

Fires an elementRemoved event to the Docking Area SetChangeListeners.

Parameters:

sourceSet - the source set

dockingAreaDescriptor - the Docking Area descriptor which was removed from the set

fireDockableAdded

protected final void fireDockableAdded(Set<E> sourceSet,
                                       E dockableEntry)

Fires an elementAdded event to the Dockable SetChangeListeners.

Parameters:

sourceSet - the source set

dockableEntry - the Dockable entry which was added to the set

fireDockableRemoved

protected final void fireDockableRemoved(Set<E> sourceSet,
                                         E dockableEntry)

Fires an elementRemoved event to the Dockable SetChangeListeners.

Parameters:

sourceSet - the source set

dockableEntry - the Dockable entry which was removed from the set

fireActiveDockableChanged

protected final void fireActiveDockableChanged(E oldActiveDockableEntry,
                                               E newActiveDockableEntry)

Fires a property change event for the 'activeDockable' property.

Parameters:

oldActiveDockableEntry - the previously active Dockable entry if any, else null

newActiveDockableEntry - the new active Dockable entry if any, else null

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
                                            PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.softsmithy.lib.beans.Bean

removePropertyChangeListener

public final void removePropertyChangeListener(String propertyName,
                                               PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.softsmithy.lib.beans.Bean

close

public void close()

Specified by:

close in interface AutoCloseable