org.drombler.commons.docking

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

java.lang.Object

org.drombler.commons.docking.DockingManager<D,DATA,E>

Type Parameters:

D - the Dockable type

DATA - the Dockable data type

E - the Dockable entry type

All Implemented Interfaces:

AutoCloseable

public class DockingManager<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>
extends Object
implements AutoCloseable

The docking manager manages Dockable views and editors along with their associated Dockable data and Dockable preferences.

Author:

puce

Constructor Summary

Constructors

Constructor and Description
DockingManager(DockableEntryFactory<D,DATA,E> dockableEntryFactory, DockableDataFactory<DATA> dockableDataFactory, org.softsmithy.lib.util.Injector<? super D>... additionalInjectors) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	containsRegisteredEditor(Object uniqueKey) Checks if their is a registered editor Dockable for the provided unique key of some content.
E	createAndRegisterViewEntry(Class<? extends D> viewType, String displayName, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader) Creates and registers a view DockableEntry.
E	createEditorEntry(Object content, Class<? extends D> editorType, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader) Creates an editor DockableEntry.
DockablePreferences	getDockablePreferences(D dockable) Gets the Dockable preferences for the provided Dockable instance.
E	getRegisteredEditor(Object uniqueKey) Gets the registered editor Dockable for the provided unique key of some content.
void	registerDefaultDockablePreferences(Class<?> dockableClass, DockablePreferences dockablePreferences) Registers the default DockablePreferences for the provided Dockable class.
void	registerEditor(Object uniqueKey, E dockableEntry) Registers an editor for an non-null unique key of some content.
DockablePreferences	unregisterDefaultDockablePreferences(Class<?> dockableClass) Unregisters the default DockablePreferences for the provided Dockable class.
void	unregisterEditor(E editorEntry) Unregisters an editor Dockable entry.
void	unregisterView(E viewEntry) Unregisters a view Dockable entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingManager

public DockingManager(DockableEntryFactory<D,DATA,E> dockableEntryFactory,
                      DockableDataFactory<DATA> dockableDataFactory,
                      org.softsmithy.lib.util.Injector<? super D>... additionalInjectors)

Creates a new instance of this class.

Parameters:

dockableEntryFactory - the Dockable entry factory

dockableDataFactory - the Dockable data factory

additionalInjectors - additional injectors to be applied to Dockables

Method Detail

containsRegisteredEditor

public boolean containsRegisteredEditor(Object uniqueKey)

Checks if their is a registered editor Dockable for the provided unique key of some content. A unique key can e.g. be a file path or a business key of a business object.

Parameters:

uniqueKey - the unique key of some content

Returns:

true if this manager contains a registered editor for the provided unique key, else false

getRegisteredEditor

public E getRegisteredEditor(Object uniqueKey)

Gets the registered editor Dockable for the provided unique key of some content. A unique key can e.g. be a file path or a business key of a business object.

Parameters:

uniqueKey - the unique key of some content

Returns:

the registered editor Dockable for the provided unique key of some content, if there is one, else null

createEditorEntry

public E createEditorEntry(Object content,
                           Class<? extends D> editorType,
                           String icon,
                           org.softsmithy.lib.util.ResourceLoader resourceLoader)
                    throws SecurityException,
                           InvocationTargetException,
                           IllegalAccessException,
                           IllegalArgumentException,
                           NoSuchMethodException,
                           InstantiationException

Creates an editor DockableEntry.

Parameters:

content - the content to create the editor for

editorType - the editor type

icon - the icon name pattern

resourceLoader - the resource loader to load the icon

Returns:

a new editor Dockable entry

Throws:

SecurityException

InvocationTargetException

IllegalAccessException

IllegalArgumentException

NoSuchMethodException

InstantiationException

See Also:

DockableKind.EDITOR

registerDefaultDockablePreferences

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

Registers the default DockablePreferences for the provided Dockable class.

Parameters:

dockableClass - the Dockable class

dockablePreferences - the default Dockable preferences

unregisterDefaultDockablePreferences

public DockablePreferences unregisterDefaultDockablePreferences(Class<?> dockableClass)

Unregisters the default DockablePreferences for the provided Dockable class.

Parameters:

dockableClass - the Dockable class

Returns:

the previously registered default Dockable preferences if any, else null

getDockablePreferences

public DockablePreferences getDockablePreferences(D dockable)

Gets the Dockable preferences for the provided Dockable instance.

Parameters:

dockable - the Dockable instance

Returns:

the Dockable preferences for the provided Dockable instance

createAndRegisterViewEntry

public E createAndRegisterViewEntry(Class<? extends D> viewType,
                                    String displayName,
                                    String icon,
                                    org.softsmithy.lib.util.ResourceLoader resourceLoader)
                             throws InstantiationException,
                                    IllegalAccessException

Creates and registers a view DockableEntry.

Parameters:

viewType - the view type

displayName - the display name to be used as the title

icon - the icon name pattern

resourceLoader - the resource loader

Returns:

the view Dockable entry

Throws:

InstantiationException

IllegalAccessException

registerEditor

public void registerEditor(Object uniqueKey,
                           E dockableEntry)

Registers an editor for an non-null unique key of some content. A unique key can e.g. be a file path or a business key of a business object.

Parameters:

uniqueKey - the unique id

dockableEntry - the editor Dockable entry

unregisterEditor

public void unregisterEditor(E editorEntry)
                      throws Exception

Unregisters an editor Dockable entry.

Parameters:

editorEntry - the editor Dockable entry to unregister

Throws:

Exception

unregisterView

public void unregisterView(E viewEntry)
                    throws Exception

Unregisters a view Dockable entry.

Parameters:

viewEntry - the view Dockable entry to unregister

Throws:

Exception

close

public void close()

Specified by:

close in interface AutoCloseable