org.drombler.commons.docking.context

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

Type Parameters:

D -

DATA -

E -

All Known Implementing Classes:

AbstractDockingAreaContainer, DockingPaneDockingAreaContainerAdapter

public interface DockingAreaContainer<D,DATA extends DockableData,E extends DockableEntry<D,DATA>>

Author:

puce

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_DOCKABLE_PROPERTY_NAME

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)
boolean	addDockingArea(DockingAreaDescriptor dockingAreaDescriptor)
void	addDockingAreaSetChangeListener(org.softsmithy.lib.util.SetChangeListener<DockingAreaDescriptor> listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Registers a PropertyChangeListener for the specified property.
E	getActiveDockable() bound property
String	getDefaultEditorAreaId()
DockablePreferences	getDockablePreferences(D dockable)
Set<E>	getDockables()
SortedSet<E>	getSortedModifiedDockables()
boolean	openAndRegisterNewView(D dockable, boolean b, 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.
void	setActiveDockable(E dockableEntry) bound property

Field Detail

ACTIVE_DOCKABLE_PROPERTY_NAME

static final String ACTIVE_DOCKABLE_PROPERTY_NAME

See Also:

Constant Field Values

Method Detail

addDockingArea

boolean addDockingArea(DockingAreaDescriptor dockingAreaDescriptor)

addDockable

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

addDockingAreaSetChangeListener

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

removeDockingAreaSetChangeListener

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

addDockableSetChangeListener

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

removeDockableSetChangeListener

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

getDefaultEditorAreaId

String getDefaultEditorAreaId()

getDockables

Set<E> getDockables()

getSortedModifiedDockables

SortedSet<E> getSortedModifiedDockables()

setActiveDockable

void setActiveDockable(E dockableEntry)

bound property

Parameters:

dockableEntry -

getActiveDockable

E getActiveDockable()

bound property

Returns:

openAndRegisterNewView

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

openView

boolean openView(D dockable,
                 boolean active)

openEditorForContent

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.

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

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

getDockablePreferences

DockablePreferences getDockablePreferences(D dockable)

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

Registers a PropertyChangeListener for the specified property.

Parameters:

propertyName - the property to observe

listener - the PropertyChangeListener to register

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)

Unegisters a PropertyChangeListener for the specified property.

Parameters:

propertyName - the property to stop to observe

listener - the PropertyChangeListener to unregister