org.eclipse.gef4.mvc.viewer

Class AbstractViewer<VR>

java.lang.Object

org.eclipse.gef4.mvc.viewer.AbstractViewer<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Implemented Interfaces:

IActivatable, IAdaptable, IAdaptable.Bound<IDomain<VR>>, IDisposable, IPropertyChangeNotifier, IViewer<VR>

Direct Known Subclasses:

FXViewer

public abstract class AbstractViewer<VR>
extends java.lang.Object
implements IViewer<VR>, IAdaptable.Bound<IDomain<VR>>

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	pcs A PropertyChangeSupport that is used as a delegate to notify listeners about changes to this object.

Fields inherited from interface org.eclipse.gef4.common.adapt.IAdaptable

ADAPTERS_PROPERTY

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractViewer() Creates a new AbstractViewer instance, setting the AdaptableScope for each of its IAdaptable-compliant types (super classes implementing IAdaptable and super-interfaces extending IAdaptable) to the newly created instance (see AdaptableScopes#scopeTo(IAdaptable)).

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	deactivate()
void	dispose()
IDomain<VR>	getAdaptable()
<T> T	getAdapter(AdapterKey<? super T> key)
<T> T	getAdapter(java.lang.Class<? super T> classKey)
<T> T	getAdapter(com.google.common.reflect.TypeToken<? super T> key)
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(java.lang.Class<? super T> classKey)
<T> java.util.Map<AdapterKey<? extends T>,T>	getAdapters(com.google.common.reflect.TypeToken<? super T> key)
java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>>	getContentPartMap() Returns the Map for registering IContentParts by their content.
IDomain<VR>	getDomain() Returns the IDomain this IViewer is bound to.
IRootPart<VR,? extends VR>	getRootPart() Returns the IRootPart of this viewer.
java.util.Map<VR,IVisualPart<VR,? extends VR>>	getVisualPartMap() Returns the Map for registering IVisualParts by their visual.
boolean	isActive()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setAdaptable(IDomain<VR> domain)
<T> void	setAdapter(AdapterKey<? super T> key, T adapter)
<T> void	setAdapter(java.lang.Class<? super T> key, T adapter)
<T> void	setAdapter(com.google.common.reflect.TypeToken<? super T> key, T adapter)
void	setAdapters(java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys) Adds the set of adapters to this IAdaptable.
<T> T	unsetAdapter(AdapterKey<? super T> key)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gef4.mvc.viewer.IViewer

reveal

Field Detail

pcs

protected java.beans.PropertyChangeSupport pcs

A PropertyChangeSupport that is used as a delegate to notify listeners about changes to this object. May be used by subclasses to trigger the notification of listeners.

Constructor Detail

AbstractViewer

public AbstractViewer()

Creates a new AbstractViewer instance, setting the AdaptableScope for each of its IAdaptable-compliant types (super classes implementing IAdaptable and super-interfaces extending IAdaptable) to the newly created instance (see AdaptableScopes#scopeTo(IAdaptable)).

Method Detail

activate

public void activate()

Specified by:

activate in interface IActivatable

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

deactivate

public void deactivate()

Specified by:

deactivate in interface IActivatable

dispose

public void dispose()

Specified by:

dispose in interface IDisposable

getAdaptable

public IDomain<VR> getAdaptable()

Specified by:

getAdaptable in interface IAdaptable.Bound<IDomain<VR>>

getAdapter

public <T> T getAdapter(AdapterKey<? super T> key)

Specified by:

getAdapter in interface IAdaptable

getAdapter

public <T> T getAdapter(java.lang.Class<? super T> classKey)

Specified by:

getAdapter in interface IAdaptable

getAdapter

public <T> T getAdapter(com.google.common.reflect.TypeToken<? super T> key)

Specified by:

getAdapter in interface IAdaptable

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(java.lang.Class<? super T> classKey)

Specified by:

getAdapters in interface IAdaptable

getAdapters

public <T> java.util.Map<AdapterKey<? extends T>,T> getAdapters(com.google.common.reflect.TypeToken<? super T> key)

Specified by:

getAdapters in interface IAdaptable

getContentPartMap

public java.util.Map<java.lang.Object,IContentPart<VR,? extends VR>> getContentPartMap()

Description copied from interface: IViewer

Returns the Map for registering IContentParts by their content.

Specified by:

getContentPartMap in interface IViewer<VR>

Returns:

The content part map

See Also:

IViewer.getContentPartMap()

getDomain

public IDomain<VR> getDomain()

Description copied from interface: IViewer

Returns the IDomain this IViewer is bound to.

Specified by:

getDomain in interface IViewer<VR>

Returns:

The IDomain this IViewer is bound to, or null if this IViewer is not (yet) bound to an IDomain.

See Also:

IViewer.getDomain()

getRootPart

public IRootPart<VR,? extends VR> getRootPart()

Description copied from interface: IViewer

Returns the IRootPart of this viewer. The IRootPart is a special IVisualPart that serves as the parent to all contained IContentParts, IHandleParts, and IFeedbackParts.

Specified by:

getRootPart in interface IViewer<VR>

Returns:

The IRootPart of this viewer.

getVisualPartMap

public java.util.Map<VR,IVisualPart<VR,? extends VR>> getVisualPartMap()

Description copied from interface: IViewer

Returns the Map for registering IVisualParts by their visual. This map is used for hit-testing. Hit testing is performed by first determining which visual is hit, and then mapping that to an IVisualPart.

Specified by:

getVisualPartMap in interface IViewer<VR>

Returns:

The visual part map

See Also:

IViewer.getVisualPartMap()

isActive

public boolean isActive()

Specified by:

isActive in interface IActivatable

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

setAdaptable

public void setAdaptable(IDomain<VR> domain)

Specified by:

setAdaptable in interface IAdaptable.Bound<IDomain<VR>>

setAdapter

public <T> void setAdapter(AdapterKey<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapter

public <T> void setAdapter(java.lang.Class<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapter

public <T> void setAdapter(com.google.common.reflect.TypeToken<? super T> key,
                           T adapter)

Specified by:

setAdapter in interface IAdaptable

setAdapters

@Inject(optional=true)
public void setAdapters(@AdapterMap
                                               java.util.Map<AdapterKey<?>,java.lang.Object> adaptersWithKeys)

Adds the set of adapters to this IAdaptable. This method should not be used by clients but is intended for injection of adapters by means of an AdapterMapInjector.

IMPORTANT: If sub-classes override this method, they will have to transfer the inject annotation to the overwritten method to ensure that adapter map injection is still functional.

Parameters:

adaptersWithKeys - The adapters to add to this IAdaptable (by means of injection)

See Also:

AdapterMap

unsetAdapter

public <T> T unsetAdapter(AdapterKey<? super T> key)

Specified by:

unsetAdapter in interface IAdaptable