org.eclipse.gef4.mvc.parts

Class AbstractRootPart<VR,V extends VR>

java.lang.Object

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

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

Type Parameters:

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

V - The visual node used by this AbstractRootPart.

All Implemented Interfaces:

IActivatable, IAdaptable, IAdaptable.Bound<IViewer<VR>>, IDisposable, IPropertyChangeNotifier, IRootPart<VR,V>, IVisualPart<VR,V>

Direct Known Subclasses:

AbstractFXRootPart

public abstract class AbstractRootPart<VR,V extends VR>
extends AbstractVisualPart<VR,V>
implements IRootPart<VR,V>

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

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

Method Summary

Modifier and Type	Method and Description
protected void	attachToAnchorageVisual(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)
protected void	detachFromAnchorageVisual(IVisualPart<VR,? extends VR> anchorage, java.lang.String role)
protected void	doActivate()
protected void	doDeactivate()
IViewer<VR>	getAdaptable()
java.util.List<IContentPart<VR,? extends VR>>	getContentPartChildren() Returns all children of type IContentPart contained by this IRootPart.
java.util.List<IFeedbackPart<VR,? extends VR>>	getFeedbackPartChildren() Returns all children of type IFeedbackPart contained by this IRootPart.
java.util.List<IHandlePart<VR,? extends VR>>	getHandlePartChildren() Returns all children of type IHandlePart contained by this IRootPart.
IRootPart<VR,? extends VR>	getRoot() Returns the IRootPart.
IViewer<VR>	getViewer() Returns the IViewer this IRootPart is bound to.
void	setAdaptable(IViewer<VR> viewer)

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

activate, addAnchorage, addAnchorage, addAnchored, addChild, addChild, addChildren, addChildren, addChildVisual, addPropertyChangeListener, createVisual, deactivate, dispose, doRefreshVisual, getAdapter, getAdapter, getAdapter, getAdapters, getAdapters, getAnchorages, getAnchoreds, getBehaviors, getChildren, getParent, getPolicies, getVisual, isActive, isRefreshVisual, refreshVisual, register, registerAtVisualPartMap, removeAnchorage, removeAnchorage, removeAnchored, removeChild, removeChildren, removeChildVisual, removePropertyChangeListener, reorderChild, setAdapter, setAdapter, setAdapter, setAdapters, setParent, setRefreshVisual, unregister, 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, 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

AbstractRootPart

public AbstractRootPart()

Method Detail

attachToAnchorageVisual

protected void attachToAnchorageVisual(IVisualPart<VR,? extends VR> anchorage,
                                       java.lang.String role)

Overrides:

attachToAnchorageVisual in class AbstractVisualPart<VR,V extends VR>

detachFromAnchorageVisual

protected void detachFromAnchorageVisual(IVisualPart<VR,? extends VR> anchorage,
                                         java.lang.String role)

Overrides:

detachFromAnchorageVisual in class AbstractVisualPart<VR,V extends VR>

doActivate

protected void doActivate()

Overrides:

doActivate in class AbstractVisualPart<VR,V extends VR>

doDeactivate

protected void doDeactivate()

Overrides:

doDeactivate in class AbstractVisualPart<VR,V extends VR>

getAdaptable

public IViewer<VR> getAdaptable()

Specified by:

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

getContentPartChildren

public java.util.List<IContentPart<VR,? extends VR>> getContentPartChildren()

Description copied from interface: IRootPart

Returns all children of type IContentPart contained by this IRootPart.

Specified by:

getContentPartChildren in interface IRootPart<VR,V extends VR>

Returns:

A list containing all IContentPart children.

getFeedbackPartChildren

public java.util.List<IFeedbackPart<VR,? extends VR>> getFeedbackPartChildren()

Description copied from interface: IRootPart

Returns all children of type IFeedbackPart contained by this IRootPart.

Specified by:

getFeedbackPartChildren in interface IRootPart<VR,V extends VR>

Returns:

A list containing all IFeedbackPart children.

getHandlePartChildren

public java.util.List<IHandlePart<VR,? extends VR>> getHandlePartChildren()

Description copied from interface: IRootPart

Returns all children of type IHandlePart contained by this IRootPart.

Specified by:

getHandlePartChildren in interface IRootPart<VR,V extends VR>

Returns:

A list containing all IHandlePart children.

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>

Overrides:

getRoot in class AbstractVisualPart<VR,V extends VR>

Returns:

null or the IRootPart

getViewer

public IViewer<VR> getViewer()

Description copied from interface: IRootPart

Returns the IViewer this IRootPart is bound to.

Specified by:

getViewer in interface IRootPart<VR,V extends VR>

Overrides:

getViewer in class AbstractVisualPart<VR,V extends VR>

Returns:

The IViewer this IRootPart is attached to.

setAdaptable

public void setAdaptable(IViewer<VR> viewer)

Specified by:

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