org.eclipse.gef4.mvc.parts

Class AbstractContentPart<VR,V extends VR>

java.lang.Object

org.eclipse.gef4.mvc.parts.AbstractVisualPart<VR,V>

org.eclipse.gef4.mvc.parts.AbstractContentPart<VR,V>

Type Parameters:

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

V - The visual node used by this AbstractContentPart.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFXContentPart

public abstract class AbstractContentPart<VR,V extends VR>
extends AbstractVisualPart<VR,V>
implements IContentPart<VR,V>

The abstract base implementation of IContentPart, intended to be sub-classed by clients to create their own custom IContentPart.

Nested Class Summary

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

IAdaptable.Bound<A extends IAdaptable>

Field Summary

Fields inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

pcs

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

CONTENT_PROPERTY

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
AbstractContentPart()

Method Summary

Modifier and Type	Method and Description
void	addContentChild(java.lang.Object contentChild, int index) Inserts the given contentChild as a child to this part's content, so that it will be returned by subsequent calls to IContentPart.getContentChildren().
void	attachToContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role) Attaches this part's content to the given contentAnchorage under the specified role, so that it will be returned by subsequent calls to IContentPart.getContentAnchorages().
void	detachFromContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role) Detaches this part's content from the given contentAnchorage under the specified role, so that it will no longer be returned by subsequent calls to IContentPart.getContentAnchorages().
java.lang.Object	getContent() Returns this part's content.
com.google.common.collect.SetMultimap<? extends java.lang.Object,java.lang.String>	getContentAnchorages() Returns the content objects that are to be regarded as anchorages of this IContentPart's content (IContentPart.getContent()) with an (optional) role qualifier for each anchorage-anchored link that has to be established.
java.util.List<? extends java.lang.Object>	getContentChildren() Returns a List of all of this part's content children.
protected void	register(IViewer<VR> viewer) Called when a link to the Viewer is obtained.
protected void	registerAtContentPartMap(IViewer<VR> viewer, java.lang.Object content) Registers the model in the IViewer.getContentPartMap().
void	removeContentChild(java.lang.Object contentChild, int index) Removes the given contentChild from this part's content children, so that it will no longer be returned by subsequent calls to IContentPart.getContentChildren().
void	setContent(java.lang.Object content) Set the primary model object that this EditPart represents.
protected void	unregister(IViewer<VR> viewer) Called when the link to the Viewer is lost.
protected void	unregisterFromContentPartMap(IViewer<VR> viewer, java.lang.Object content) Unregisters the model in the IViewer.getContentPartMap().

Methods inherited from class org.eclipse.gef4.mvc.parts.AbstractVisualPart

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, registerAtVisualPartMap, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, removeChildVisual, removePropertyChangeListener, reorderChild, setAdapter, setAdapter, setAdapter, setAdapters, setParent, setRefreshVisual, unregisterFromVisualPartMap, unsetAdapter

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.parts.IVisualPart

addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getRoot, getVisual, isRefreshVisual, refreshVisual, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual

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

getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, setAdapter, setAdapter, setAdapter, unsetAdapter

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

activate, deactivate, isActive

Methods inherited from interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.gef4.common.dispose.IDisposable

dispose

Constructor Detail

AbstractContentPart

public AbstractContentPart()

Method Detail

addContentChild

public void addContentChild(java.lang.Object contentChild,
                            int index)

Description copied from interface: IContentPart

Inserts the given contentChild as a child to this part's content, so that it will be returned by subsequent calls to IContentPart.getContentChildren().

Specified by:

addContentChild in interface IContentPart<VR,V extends VR>

Parameters:

contentChild - An Object which should be added as a child to this part's content.

index - The index at which the contentChild should be added.

attachToContentAnchorage

public void attachToContentAnchorage(java.lang.Object contentAnchorage,
                                     java.lang.String role)

Description copied from interface: IContentPart

Attaches this part's content to the given contentAnchorage under the specified role, so that it will be returned by subsequent calls to IContentPart.getContentAnchorages().

Specified by:

attachToContentAnchorage in interface IContentPart<VR,V extends VR>

Parameters:

contentAnchorage - An Object to which this part's content should be attached to.

role - The role under which the attachment is to be established.

detachFromContentAnchorage

public void detachFromContentAnchorage(java.lang.Object contentAnchorage,
                                       java.lang.String role)

Description copied from interface: IContentPart

Detaches this part's content from the given contentAnchorage under the specified role, so that it will no longer be returned by subsequent calls to IContentPart.getContentAnchorages().

Specified by:

detachFromContentAnchorage in interface IContentPart<VR,V extends VR>

Parameters:

contentAnchorage - An Object from which this part's content should be detached from.

role - The role under which the attachment is established.

getContent

public java.lang.Object getContent()

Description copied from interface: IContentPart

Returns this part's content.

Specified by:

getContent in interface IContentPart<VR,V extends VR>

Returns:

This part's content.

See Also:

IContentPart.getContent()

getContentAnchorages

public com.google.common.collect.SetMultimap<? extends java.lang.Object,java.lang.String> getContentAnchorages()

Description copied from interface: IContentPart

Returns the content objects that are to be regarded as anchorages of this IContentPart's content (IContentPart.getContent()) with an (optional) role qualifier for each anchorage-anchored link that has to be established.

In case of a connection, one anchorage could have the "START" role, and another the "END" role. Using the role mechanism, the same anchorage may also have both roles, which can, for instance, be used for self connections.

Specified by:

getContentAnchorages in interface IContentPart<VR,V extends VR>

Returns:

A SetMultimap of the content anchorages with a role to qualify each anchorage-anchored link. If there is only a single anchorage-anchored link to a respective anchorage, its role may be left undefined (i.e. the map will contain an entry of the form (anchorage, null)).

getContentChildren

public java.util.List<? extends java.lang.Object> getContentChildren()

Description copied from interface: IContentPart

Returns a List of all of this part's content children.

Specified by:

getContentChildren in interface IContentPart<VR,V extends VR>

Returns:

A List of all of this part's content children.

register

protected void register(IViewer<VR> viewer)

Description copied from class: AbstractVisualPart

Called when a link to the Viewer is obtained.

Overrides:

register in class AbstractVisualPart<VR,V extends VR>

Parameters:

viewer - The viewer to register at.

registerAtContentPartMap

protected void registerAtContentPartMap(IViewer<VR> viewer,
                                        java.lang.Object content)

Registers the model in the IViewer.getContentPartMap(). Subclasses should only extend this method if they need to register this EditPart in additional ways.

Parameters:

viewer - The viewer to register at.

content - The content to register.

removeContentChild

public void removeContentChild(java.lang.Object contentChild,
                               int index)

Description copied from interface: IContentPart

Removes the given contentChild from this part's content children, so that it will no longer be returned by subsequent calls to IContentPart.getContentChildren().

Specified by:

removeContentChild in interface IContentPart<VR,V extends VR>

Parameters:

contentChild - An Object which should be removed from this part's content children.

index - The index of the contentChild that is removed.

setContent

public void setContent(java.lang.Object content)

Set the primary model object that this EditPart represents. This method is used by an EditPartFactory when creating an EditPart.

Specified by:

setContent in interface IContentPart<VR,V extends VR>

Parameters:

content - The new content for this part.

See Also:

IContentPart.setContent(Object)

unregister

protected void unregister(IViewer<VR> viewer)

Description copied from class: AbstractVisualPart

Called when the link to the Viewer is lost.

Overrides:

unregister in class AbstractVisualPart<VR,V extends VR>

Parameters:

viewer - The viewer to unregister from.

unregisterFromContentPartMap

protected void unregisterFromContentPartMap(IViewer<VR> viewer,
                                            java.lang.Object content)

Unregisters the model in the IViewer.getContentPartMap(). Subclasses should only extend this method if they need to unregister this EditPart in additional ways.

Parameters:

viewer - The viewer to unregister from.

content - The content to unregister.