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>

All Implemented Interfaces:

AutoCloseable, DockingAreaContainer<D,DATA,E>

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

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)

Method Summary

Modifier and Type	Method and Description
boolean	addDockable(E dockableEntry, boolean active, Context... implicitLocalContexts)
void	addDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener)
void	addDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener)
void	addImplicitLocalContext(D dockable, Context... implicitLocalContexts)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Registers a PropertyChangeListener for the specified property.
void	close()
protected void	fireActiveDockableChanged(E oldActiveDockableEntry, E newActiveDockableEntry)
protected void	fireDockableAdded(Set<E> sourceSet, E dockableEntry)
protected void	fireDockableRemoved(Set<E> sourceSet, E dockableEntry)
protected void	fireDockingAreaAdded(Set<DockingAreaDescriptor> sourceSet, DockingAreaDescriptor dockingAreaDescriptor)
protected void	fireDockingAreaRemoved(Set<DockingAreaDescriptor> sourceSet, DockingAreaDescriptor dockingAreaDescriptor)
Context	getActiveContext()
Context	getApplicationContext()
<T> T	getContent(D dockable, Class<T> contentType)
DockablePreferences	getDockablePreferences(D dockable)
boolean	openAndRegisterNewView(D dockable, boolean active, String displayName, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader)
boolean	openEditorForContent(Object content, Class<? extends D> editorType, String icon, org.softsmithy.lib.util.ResourceLoader resourceLoader) Opens an Editor for the specified content.
boolean	openView(D dockable, boolean active)
void	registerDefaultDockablePreferences(Class<?> dockableClass, DockablePreferences dockablePreferences)
void	removeDockableSetChangeListener(org.softsmithy.lib.util.SetChangeListener<E> listener)
void	removeDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Unegisters a PropertyChangeListener for the specified property.

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)

Method Detail

getActiveContext

public Context getActiveContext()

getApplicationContext

public Context getApplicationContext()

addDockable

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

Specified by:

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

addImplicitLocalContext

public void addImplicitLocalContext(D dockable,
                                    Context... implicitLocalContexts)

getContent

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

openView

public boolean openView(D dockable,
                        boolean active)

Specified by:

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

openAndRegisterNewView

public boolean openAndRegisterNewView(D dockable,
                                      boolean active,
                                      String displayName,
                                      String icon,
                                      org.softsmithy.lib.util.ResourceLoader resourceLoader)

Specified by:

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

openEditorForContent

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

registerDefaultDockablePreferences

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

Specified by:

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

getDockablePreferences

public DockablePreferences getDockablePreferences(D dockable)

Specified by:

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

addDockingAreaSetChangeListener

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

Specified by:

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

removeDockingAreaSetChangeListener

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

Specified by:

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

addDockableSetChangeListener

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

Specified by:

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

removeDockableSetChangeListener

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

Specified by:

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

fireDockingAreaAdded

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

fireDockingAreaRemoved

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

fireDockableAdded

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

fireDockableRemoved

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

fireActiveDockableChanged

protected final void fireActiveDockableChanged(E oldActiveDockableEntry,
                                               E newActiveDockableEntry)

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
                                            PropertyChangeListener listener)

Registers a PropertyChangeListener for the specified property.

Specified by:

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

Parameters:

propertyName - the property to observe

listener - the PropertyChangeListener to register

removePropertyChangeListener

public final void removePropertyChangeListener(String propertyName,
                                               PropertyChangeListener listener)

Unegisters a PropertyChangeListener for the specified property.

Specified by:

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

Parameters:

propertyName - the property to stop to observe

listener - the PropertyChangeListener to unregister

close

public void close()

Specified by:

close in interface AutoCloseable