org.eclipse.gef4.mvc.parts

Interface IContentPart<VR,V extends VR>

Type Parameters:

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

V - The visual node used by this IContentPart.

All Superinterfaces:

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

All Known Implementing Classes:

AbstractContentPart, AbstractFXContentPart

public interface IContentPart<VR,V extends VR>
extends IVisualPart<VR,V>

An IVisualPart that visualizes an underlying content element.

Noimplement:

This interface is not intended to be implemented by clients. Instead, AbstractContentPart should be sub-classed.

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
static java.lang.String	CONTENT_ANCHORAGES_PROPERTY Property name used within PropertyChangeEvents, which are fired whenever the content anchorages change ( attachToContentAnchorage(Object, String) and detachFromContentAnchorage(Object, String)).
static java.lang.String	CONTENT_CHILDREN_PROPERTY Property name used within PropertyChangeEvents, which are fired whenever the content children change ( addContentChild(Object, int) and removeContentChild(Object)).
static java.lang.String	CONTENT_PROPERTY Property name used within PropertyChangeEvents, which are fired whenever the content changes.

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

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 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 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 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 (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.
void	removeContentChild(java.lang.Object contentChild) Removes the given contentChild from this part's content children, so that it will no longer be returned by subsequent calls to getContentChildren().
void	reorderContentChild(java.lang.Object contentChild, int newIndex) Rearranges the given contentChild to the new index position.
void	setContent(java.lang.Object content) Sets this part's content to the given value.

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

addChild, addChild, addChildren, addChildren, attachAnchored, attachToAnchorage, attachToAnchorage, detachAnchored, detachFromAnchorage, detachFromAnchorage, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getRoot, getVisual, isRefreshVisual, refreshVisual, removeChild, removeChildren, reorderChild, setParent, setRefreshVisual

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

getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, setAdapter, 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

Field Detail

CONTENT_PROPERTY

static final java.lang.String CONTENT_PROPERTY

Property name used within PropertyChangeEvents, which are fired whenever the content changes.

See Also:

Constant Field Values

CONTENT_CHILDREN_PROPERTY

static final java.lang.String CONTENT_CHILDREN_PROPERTY

Property name used within PropertyChangeEvents, which are fired whenever the content children change ( addContentChild(Object, int) and removeContentChild(Object)).

See Also:

Constant Field Values

CONTENT_ANCHORAGES_PROPERTY

static final java.lang.String CONTENT_ANCHORAGES_PROPERTY

Property name used within PropertyChangeEvents, which are fired whenever the content anchorages change ( attachToContentAnchorage(Object, String) and detachFromContentAnchorage(Object, String)).

See Also:

Constant Field Values

Method Detail

addContentChild

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 getContentChildren(). Fires property change events using CONTENT_CHILDREN_PROPERTY as property name.

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

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 getContentAnchorages(). Fires property change events using CONTENT_ANCHORAGES_PROPERTY as property name.

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

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 getContentAnchorages(). Fires property change events using CONTENT_ANCHORAGES_PROPERTY as property name.

Parameters:

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

role - The role under which the attachment is established.

getContent

java.lang.Object getContent()

Returns this part's content.

Returns:

This part's content.

getContentAnchorages

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 (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.

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

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

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

Returns:

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

removeContentChild

void removeContentChild(java.lang.Object contentChild)

Removes the given contentChild from this part's content children, so that it will no longer be returned by subsequent calls to getContentChildren(). Fires property change events using CONTENT_CHILDREN_PROPERTY as property name.

Parameters:

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

reorderContentChild

void reorderContentChild(java.lang.Object contentChild,
                         int newIndex)

Rearranges the given contentChild to the new index position. Fires property change events using CONTENT_CHILDREN_PROPERTY as property name.

Parameters:

contentChild - The Object which is to be reordered.

newIndex - The index to which the content child is to be reordered.

setContent

void setContent(java.lang.Object content)

Sets this part's content to the given value. Fires property change events using CONTENT_PROPERTY as property name.

Parameters:

content - The new content for this part.