org.eclipse.gef4.mvc.policies

Class CreationPolicy<VR>

java.lang.Object

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

org.eclipse.gef4.mvc.policies.CreationPolicy<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 CreationPolicy<VR>
extends AbstractPolicy<VR>
implements ITransactional

The CreationPolicy is an ITransactional AbstractPolicy that handles the creation of new content objects via the ContentPolicy.

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

Method Summary

Modifier and Type	Method and Description
ITransactionalOperation	commit() Returns an ITransactionalOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.
void	create(IContentPart<VR,? extends VR> parent, java.lang.Object content) Adds the given content to the collection of to-be-created contents in the specified parent.
void	init() Initializes the policy, so that the policy's "work" methods can be used.

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

commit, disableRefreshVisuals, enableRefreshVisuals, getAdaptable, getHost, init, setAdaptable

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

CreationPolicy

public CreationPolicy()

Method Detail

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.

create

public void create(IContentPart<VR,? extends VR> parent,
                   java.lang.Object content)

Adds the given content to the collection of to-be-created contents in the specified parent.

Parameters:

parent - The IContentPart where the content is inserted.

content - The Object to be created as a content-child of the given parent.

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