AbstractVisualPart (GEF4 MVC API Reference)

java.lang.Object
- org.eclipse.gef4.mvc.parts.AbstractVisualPart<VR,V>

Type Parameters:

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

V - The visual node used by this AbstractVisualPart.

All Implemented Interfaces:

IActivatable, IAdaptable, IDisposable, IPropertyChangeNotifier, IVisualPart<VR,V>

Direct Known Subclasses:

AbstractContentPart, AbstractFeedbackPart, AbstractHandlePart, AbstractRootPart
```
public abstract class AbstractVisualPart<VR,V extends VR>
extends java.lang.Object
implements IVisualPart<VR,V>
```

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.mvc.parts.IVisualPart
ANCHORAGES_PROPERTY, ANCHOREDS_PROPERTY, CHILDREN_PROPERTY, PARENT_PROPERTY

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
`AbstractVisualPart()` Creates a new `AbstractVisualPart` 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

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activates this `IVisualPart` (if it is not already active) by setting (and propagating) the new active state first and delegating to `doActivate()` afterwards.
`void`	`addAnchorage(IVisualPart<VR,? extends VR> anchorage)`
`void`	`addAnchorage(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)`
`void`	`addAnchored(IVisualPart<VR,? extends VR> anchored)` Used by an anchored `IVisualPart` to establish an anchorage-anchored relationship with this anchorage `IVisualPart`.
`void`	`addChild(IVisualPart<VR,? extends VR> child)`
`void`	`addChild(IVisualPart<VR,? extends VR> child, int index)`
`void`	`addChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children)`
`void`	`addChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children, int index)`
`protected void`	`addChildVisual(IVisualPart<VR,? extends VR> child, int index)` Performs the addition of the child's visual to this `IVisualPart`'s visual.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`protected void`	`attachToAnchorageVisual(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)`
`protected abstract V`	`createVisual()`
`void`	`deactivate()` Deactivates this `IVisualPart` (if it is active) by delegating to `doDeactivate()` first and setting (and propagating) the new active state afterwards.
`protected void`	`detachFromAnchorageVisual(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)`
`void`	`dispose()`
`protected void`	`doActivate()`
`protected void`	`doDeactivate()`
`protected abstract void`	`doRefreshVisual(V visual)`
`<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)`
`com.google.common.collect.SetMultimap<IVisualPart<VR,? extends VR>,java.lang.String>`	`getAnchorages()`
`com.google.common.collect.Multiset<IVisualPart<VR,? extends VR>>`	`getAnchoreds()`
`java.util.Map<AdapterKey<? extends IBehavior<VR>>,IBehavior<VR>>`	`getBehaviors()`
`java.util.List<IVisualPart<VR,? extends VR>>`	`getChildren()`
`IVisualPart<VR,? extends VR>`	`getParent()`
`java.util.Map<AdapterKey<? extends IPolicy<VR>>,IPolicy<VR>>`	`getPolicies()`
`IRootPart<VR,? extends VR>`	`getRoot()` Returns the `IRootPart`.
`protected IViewer<VR>`	`getViewer()`
`V`	`getVisual()`
`boolean`	`isActive()`
`boolean`	`isRefreshVisual()`
`void`	`refreshVisual()` Refreshes this `IVisualPart`'s visuals.
`protected void`	`register(IViewer<VR> viewer)` Called when a link to the Viewer is obtained.
`protected void`	`registerAtVisualPartMap(IViewer<VR> viewer, V visual)`
`void`	`removeAnchorage(IVisualPart<VR,? extends VR> anchorage)`
`void`	`removeAnchorage(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)`
`void`	`removeAnchored(IVisualPart<VR,? extends VR> anchored)` Used by an anchored `IVisualPart` to unestablish an anchorage-anchored relationship with this anchorage `IVisualPart`.
`void`	`removeChild(IVisualPart<VR,? extends VR> child)`
`void`	`removeChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children)`
`protected void`	`removeChildVisual(IVisualPart<VR,? extends VR> child, int index)` Removes the child's visual from this `IVisualPart`'s visual.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`reorderChild(IVisualPart<VR,? extends VR> child, int index)` Moves a child `IVisualPart` into a lower index than it currently occupies.
`<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`.
`void`	`setParent(IVisualPart<VR,? extends VR> newParent)` Sets the parent `IVisualPart`.
`void`	`setRefreshVisual(boolean isRefreshVisual)` Allows to temporarily turn `IVisualPart.refreshVisual()` into a no-op operation.
`protected void`	`unregister(IViewer<VR> viewer)` Called when the link to the Viewer is lost.
`protected void`	`unregisterFromVisualPartMap(IViewer<VR> viewer, V visual)`
`<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

- 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
  - AbstractVisualPart
```
public AbstractVisualPart()
```
    Creates a new AbstractVisualPart 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 final void activate()
```
    Activates this IVisualPart (if it is not already active) by setting (and propagating) the new active state first and delegating to doActivate() afterwards. During the call to doActivate(), isActive() will thus already return true. If the IVisualPart is already active, this operation will be a no-op.
    
    Specified by:
    
    activate in interface IActivatable
    
    See Also:
    
    deactivate(), isActive()
  - addAnchorage
```
public void addAnchorage(IVisualPart<VR,? extends VR> anchorage)
```
    Specified by:
    
    addAnchorage in interface IVisualPart<VR,V extends VR>
  - addAnchorage
```
public void addAnchorage(IVisualPart<VR,? extends VR> anchorage,
                         java.lang.String role)
```
    Specified by:
    
    addAnchorage in interface IVisualPart<VR,V extends VR>
  - addAnchored
```
public void addAnchored(IVisualPart<VR,? extends VR> anchored)
```
    Description copied from interface: IVisualPart
    
    Used by an anchored IVisualPart to establish an anchorage-anchored relationship with this anchorage IVisualPart.
    Clients should never call this operation directly but instead add the anchorage to its anchored via the IVisualPart.addAnchorage(IVisualPart) and IVisualPart.addAnchorage(IVisualPart, String) operations, which will indirectly lead to a call here.
    
    Specified by:
    
    addAnchored in interface IVisualPart<VR,V extends VR>
    
    Parameters:
    
    anchored - An IVisualPart to attach to this anchorage IVisualPart as anchored.
  - addChild
```
public void addChild(IVisualPart<VR,? extends VR> child)
```
    Specified by:
    
    addChild in interface IVisualPart<VR,V extends VR>
  - addChild
```
public void addChild(IVisualPart<VR,? extends VR> child,
                     int index)
```
    Specified by:
    
    addChild in interface IVisualPart<VR,V extends VR>
  - addChildren
```
public void addChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children)
```
    Specified by:
    
    addChildren in interface IVisualPart<VR,V extends VR>
  - addChildren
```
public void addChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children,
                        int index)
```
    Specified by:
    
    addChildren in interface IVisualPart<VR,V extends VR>
  - addChildVisual
```
protected void addChildVisual(IVisualPart<VR,? extends VR> child,
                              int index)
```
    Performs the addition of the child's visual to this IVisualPart's visual.
    
    Parameters:
    
    child - The IVisualPart being added
    
    index - The child's position
    
    See Also:
    
    addChild(IVisualPart, int)
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Specified by:
    
    addPropertyChangeListener in interface IPropertyChangeNotifier
  - attachToAnchorageVisual
```
protected void attachToAnchorageVisual(IVisualPart<VR,? extends VR> anchorage,
                                       java.lang.String role)
```
  - createVisual
```
protected abstract V createVisual()
```
  - deactivate
```
public final void deactivate()
```
    Deactivates this IVisualPart (if it is active) by delegating to doDeactivate() first and setting (and propagating) the new active state afterwards. During the call to doDeactivate(), isActive() will thus still return true. If the IVisualPart is not active, this operation will be a no-op.
    
    Specified by:
    
    deactivate in interface IActivatable
    
    See Also:
    
    activate(), isActive()
  - detachFromAnchorageVisual
```
protected void detachFromAnchorageVisual(IVisualPart<VR,? extends VR> anchorage,
                                         java.lang.String role)
```
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface IDisposable
  - doActivate
```
protected void doActivate()
```
  - doDeactivate
```
protected void doDeactivate()
```
  - doRefreshVisual
```
protected abstract void doRefreshVisual(V visual)
```
  - 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
  - getAnchorages
```
public com.google.common.collect.SetMultimap<IVisualPart<VR,? extends VR>,java.lang.String> getAnchorages()
```
    Specified by:
    
    getAnchorages in interface IVisualPart<VR,V extends VR>
  - getAnchoreds
```
public com.google.common.collect.Multiset<IVisualPart<VR,? extends VR>> getAnchoreds()
```
    Specified by:
    
    getAnchoreds in interface IVisualPart<VR,V extends VR>
  - getBehaviors
```
public java.util.Map<AdapterKey<? extends IBehavior<VR>>,IBehavior<VR>> getBehaviors()
```
    Specified by:
    
    getBehaviors in interface IVisualPart<VR,V extends VR>
  - getChildren
```
public java.util.List<IVisualPart<VR,? extends VR>> getChildren()
```
    Specified by:
    
    getChildren in interface IVisualPart<VR,V extends VR>
  - getParent
```
public IVisualPart<VR,? extends VR> getParent()
```
    Specified by:
    
    getParent in interface IVisualPart<VR,V extends VR>
  - getPolicies
```
public java.util.Map<AdapterKey<? extends IPolicy<VR>>,IPolicy<VR>> getPolicies()
```
    Specified by:
    
    getPolicies in interface IVisualPart<VR,V extends VR>
  - getRoot
```
public IRootPart<VR,? extends VR> getRoot()
```
    Description copied from interface: IVisualPart
    
    Returns the IRootPart. This method should only be called internally or by helpers such as edit policies. The root can be used to get the viewer.
    
    Specified by:
    
    getRoot in interface IVisualPart<VR,V extends VR>
    
    Returns:
    
    null or the IRootPart
  - getViewer
```
protected IViewer<VR> getViewer()
```
  - getVisual
```
public V getVisual()
```
    Specified by:
    
    getVisual in interface IVisualPart<VR,V extends VR>
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface IActivatable
    
    Returns:
    
    true if this IVisualPart is active.
  - isRefreshVisual
```
public boolean isRefreshVisual()
```
    Specified by:
    
    isRefreshVisual in interface IVisualPart<VR,V extends VR>
  - refreshVisual
```
public final void refreshVisual()
```
    Refreshes this IVisualPart's visuals. Delegates to doRefreshVisual(Object) in case isRefreshVisual() is not set to false.
    
    Specified by:
    
    refreshVisual in interface IVisualPart<VR,V extends VR>
  - register
```
protected void register(IViewer<VR> viewer)
```
    Called when a link to the Viewer is obtained.
    
    Parameters:
    
    viewer - The viewer to register at.
  - registerAtVisualPartMap
```
protected void registerAtVisualPartMap(IViewer<VR> viewer,
                                       V visual)
```
  - removeAnchorage
```
public void removeAnchorage(IVisualPart<VR,? extends VR> anchorage)
```
    Specified by:
    
    removeAnchorage in interface IVisualPart<VR,V extends VR>
  - removeAnchorage
```
public void removeAnchorage(IVisualPart<VR,? extends VR> anchorage,
                            java.lang.String role)
```
    Specified by:
    
    removeAnchorage in interface IVisualPart<VR,V extends VR>
  - removeAnchored
```
public void removeAnchored(IVisualPart<VR,? extends VR> anchored)
```
    Description copied from interface: IVisualPart
    
    Used by an anchored IVisualPart to unestablish an anchorage-anchored relationship with this anchorage IVisualPart.
    Clients should never call this operation directly but instead remove the anchorage from its anchored via the IVisualPart.removeAnchorage(IVisualPart) or IVisualPart.removeAnchorage(IVisualPart, String) operations, which will indirectly lead to a call here.
    
    Specified by:
    
    removeAnchored in interface IVisualPart<VR,V extends VR>
    
    Parameters:
    
    anchored - An IVisualPart (currently attached as anchored to this anchorage IVisualPart) to detach from this anchorage IVisualPart as anchored.
  - removeChild
```
public void removeChild(IVisualPart<VR,? extends VR> child)
```
    Specified by:
    
    removeChild in interface IVisualPart<VR,V extends VR>
  - removeChildren
```
public void removeChildren(java.util.List<? extends IVisualPart<VR,? extends VR>> children)
```
    Specified by:
    
    removeChildren in interface IVisualPart<VR,V extends VR>
  - removeChildVisual
```
protected void removeChildVisual(IVisualPart<VR,? extends VR> child,
                                 int index)
```
    Removes the child's visual from this IVisualPart's visual.
    
    Parameters:
    
    child - The child IVisualPart.
    
    index - The index of the child whose visual is to be removed.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Specified by:
    
    removePropertyChangeListener in interface IPropertyChangeNotifier
  - reorderChild
```
public void reorderChild(IVisualPart<VR,? extends VR> child,
                         int index)
```
    Moves a child IVisualPart into a lower index than it currently occupies.
    
    Specified by:
    
    reorderChild in interface IVisualPart<VR,V extends VR>
    
    Parameters:
    
    child - the child IVisualPart being reordered
    
    index - new index for the child
  - 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
  - setParent
```
public void setParent(IVisualPart<VR,? extends VR> newParent)
```
    Sets the parent IVisualPart.
    
    Specified by:
    
    setParent in interface IVisualPart<VR,V extends VR>
    
    Parameters:
    
    newParent - The new parent IVisualPart or null.
  - setRefreshVisual
```
public void setRefreshVisual(boolean isRefreshVisual)
```
    Description copied from interface: IVisualPart
    
    Allows to temporarily turn IVisualPart.refreshVisual() into a no-op operation. This may for instance be used to disable visual updates that are initiated by the model (in case of IContentParts) while interacting with the IVisualPart.
    
    Specified by:
    
    setRefreshVisual in interface IVisualPart<VR,V extends VR>
    
    Parameters:
    
    isRefreshVisual - Whether IVisualPart.refreshVisual() should perform updates of the visual (true) or behave like a no-op operation ( false).
  - unregister
```
protected void unregister(IViewer<VR> viewer)
```
    Called when the link to the Viewer is lost.
    
    Parameters:
    
    viewer - The viewer to unregister from.
  - unregisterFromVisualPartMap
```
protected void unregisterFromVisualPartMap(IViewer<VR> viewer,
                                           V visual)
```
  - unsetAdapter
```
public <T> T unsetAdapter(AdapterKey<? super T> key)
```
    Specified by:
    
    unsetAdapter in interface IAdaptable

Class AbstractVisualPart<VR,V extends VR>

Nested Class Summary

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

Field Summary

Fields inherited from interface org.eclipse.gef4.mvc.parts.IVisualPart

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pcs

Constructor Detail

AbstractVisualPart

Method Detail

activate

addAnchorage

addAnchorage

addAnchored

addChild

addChild

addChildren

addChildren

addChildVisual

addPropertyChangeListener

attachToAnchorageVisual

createVisual

deactivate

detachFromAnchorageVisual

dispose

doActivate

doDeactivate

doRefreshVisual

getAdapter

getAdapter

getAdapter

getAdapters

getAdapters

getAnchorages

getAnchoreds

getBehaviors

getChildren

getParent

getPolicies

getRoot

getViewer

getVisual

isActive

isRefreshVisual

refreshVisual

register

registerAtVisualPartMap

removeAnchorage

removeAnchorage

removeAnchored

removeChild

removeChildren

removeChildVisual

removePropertyChangeListener

reorderChild

setAdapter

setAdapter

setAdapter

setAdapters

setParent

setRefreshVisual

unregister

unregisterFromVisualPartMap

unsetAdapter