org.eclipse.gef4.mvc.policies

Class ContentPolicy<VR>

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<VR>

org.eclipse.gef4.mvc.policies.ContentPolicy<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:

IAdaptable.Bound<IVisualPart<VR,? extends VR>>, ITransactional, IPolicy<VR>

public class ContentPolicy<VR>
extends AbstractPolicy<VR>
implements ITransactional

A (transaction) policy to handle content changes, i.e. adding/removing of content children, as well as attaching/detaching to/from content anchorages.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.mvc.operations.ITransactional

ITransactional.NoOperation, ITransactional.UnexecutableOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized Stores the initialized flag for this policy, i.e.

Fields inherited from interface org.eclipse.gef4.mvc.operations.ITransactional

NOOP, UNEXECUTABLE

Constructor Summary

Constructors

Constructor and Description
ContentPolicy()

Method Summary

Modifier and Type	Method and Description
void	addContentChild(java.lang.Object contentChild, int index) Creates and records operations to add the given contentChild to the host of this ContentPolicy at the specified index.
void	attachToContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role) Creates and records operations to attach the host of this ContentPolicy to the specified contentAnchorage under the specified role.
ITransactionalOperation	commit() Returns an ITransactionalOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.
void	deleteContent() Creates and records operations to delete the host of this ContentPolicy from the content model, i.e. detaches all content anchoreds, detaches from all content anchorages, and removes from its parent's content children.
void	detachAllContentAnchoreds() Creates and records operations to detach all content anchoreds from the host of this ContentPolicy.
void	detachFromAllContentAnchorages() Creates and records operations to detach the host of this ContentPolicy from all content anchorages.
void	detachFromContentAnchorage(java.lang.Object contentAnchorage, java.lang.String role) Creates and records operations to detach the host of this ContentPolicy from the specified contentAnchorage under the specified role.
IContentPart<VR,? extends VR>	getHost() Returns the host of this IPolicy, i.e. the IVisualPart this IPolicy is attached to.
void	init() Initializes the policy, so that the policy's "work" methods can be used.
void	removeContentChild(java.lang.Object contentChild) Creates and records operations to remove the given contentChild from the content children of the host of this ContentPolicy.
void	removeFromParent() Creates and records operations to remove the content of this ContentPolicy's host from its parent.
void	setAdaptable(IVisualPart<VR,? extends VR> adaptable)

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractPolicy

commit, disableRefreshVisuals, enableRefreshVisuals, getAdaptable, init

Methods inherited from class java.lang.Object

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

Field Detail

initialized

protected boolean initialized

Stores the initialized flag for this policy, i.e. true after init() was called, and false after commit() was called, respectively.

Constructor Detail

ContentPolicy

public ContentPolicy()

Method Detail

addContentChild

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

Creates and records operations to add the given contentChild to the host of this ContentPolicy at the specified index.

Parameters:

contentChild - The content Object that is to be added to the host of this ContentPolicy.

index - The index of the new content child.

attachToContentAnchorage

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

Creates and records operations to attach the host of this ContentPolicy to the specified contentAnchorage under the specified role.

Parameters:

contentAnchorage - The content Object to which the host of this ContentPolicy is to be attached.

role - The role for the attachment.

commit

public ITransactionalOperation commit()

Description copied from interface: ITransactional

Returns an ITransactionalOperation that performs all manipulations applied by the policy since the last ITransactional.init() call. When called multiple times in sequence, only the first call will yield an operation, the subsequent calls will yield null.

You can return ITransactional.NOOP if no changes have to be applied. The domain will filter out all ITransactional.NOOPs before their execution.

You can return ITransactional.UNEXECUTABLE to prevent any composite operation that contains the ITransactional.UNEXECUTABLE from execution.

Specified by:

commit in interface ITransactional

Returns:

An ITransactionalOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.

deleteContent

public void deleteContent()

Creates and records operations to delete the host of this ContentPolicy from the content model, i.e. detaches all content anchoreds, detaches from all content anchorages, and removes from its parent's content children.

detachAllContentAnchoreds

public void detachAllContentAnchoreds()

Creates and records operations to detach all content anchoreds from the host of this ContentPolicy.

detachFromAllContentAnchorages

public void detachFromAllContentAnchorages()

Creates and records operations to detach the host of this ContentPolicy from all content anchorages.

detachFromContentAnchorage

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

Creates and records operations to detach the host of this ContentPolicy from the specified contentAnchorage under the specified role.

Parameters:

contentAnchorage - The content Object from which the getHost() of this ContentPolicy is detached.

role - The role under which the anchorage is detached.

getHost

public IContentPart<VR,? extends VR> getHost()

Description copied from interface: IPolicy

Returns the host of this IPolicy, i.e. the IVisualPart this IPolicy is attached to.

Specified by:

getHost in interface IPolicy<VR>

Overrides:

getHost in class AbstractPolicy<VR>

Returns:

The host of this IPolicy.

init

public void init()

Description copied from interface: ITransactional

Initializes the policy, so that the policy's "work" methods can be used. Calling a "work" method while the policy is not initialized will result in an IllegalStateException. It is safe to call ITransactional.init() multiple times in sequence.

Specified by:

init in interface ITransactional

removeContentChild

public void removeContentChild(java.lang.Object contentChild)

Creates and records operations to remove the given contentChild from the content children of the host of this ContentPolicy.

Parameters:

contentChild - The content Object that is removed from content children of the host of this ContentPolicy.

removeFromParent

public void removeFromParent()

Creates and records operations to remove the content of this ContentPolicy's host from its parent.

setAdaptable

public void setAdaptable(IVisualPart<VR,? extends VR> adaptable)

Specified by:

setAdaptable in interface IAdaptable.Bound<IVisualPart<VR,? extends VR>>

Overrides:

setAdaptable in class AbstractPolicy<VR>