org.eclipse.gef4.mvc.fx.policies

Class FXResizePolicy

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.policies.FXResizePolicy

All Implemented Interfaces:

IAdaptable.Bound<IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>>, ITransactional, IPolicy<javafx.scene.Node>

Direct Known Subclasses:

FXResizeConnectionPolicy

public class FXResizePolicy
extends AbstractPolicy<javafx.scene.Node>
implements ITransactional

The FXResizePolicy is a transactional policy that handles the resize of an IVisualPart.

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.
protected ForwardUndoCompositeOperation	resizeAndRevealOperation The ForwardUndoCompositeOperation that assembles the resize operation and the reveal operation.
protected FXResizeNodeOperation	resizeOperation The FXResizeNodeOperation that is used to resize the host's visual.

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

NOOP, UNEXECUTABLE

Constructor Summary

Constructors

Constructor and Description
FXResizePolicy()

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.
protected Dimension	getInitialSize(javafx.scene.Node visualToResize) Returns the current size of the passed-in Node, i.e. the width and height of its layout-bounds.
protected double	getMinimumHeight() Returns the minimum height.
protected double	getMinimumWidth() Returns the minimum width.
protected javafx.scene.Node	getVisualToResize() Returns the Node that should be resized.
void	init() Initializes the policy, so that the policy's "work" methods can be used.
void	performResize(double dw, double dh) Resizes the visual by the given delta width and delta height.
protected void	updateOperation(double layoutDw, double layoutDh) Updates the resize operation to use the given delta width and delta height.

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.

resizeOperation

protected FXResizeNodeOperation resizeOperation

The FXResizeNodeOperation that is used to resize the host's visual.

resizeAndRevealOperation

protected ForwardUndoCompositeOperation resizeAndRevealOperation

The ForwardUndoCompositeOperation that assembles the resize operation and the reveal operation.

Constructor Detail

FXResizePolicy

public FXResizePolicy()

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.

getInitialSize

protected Dimension getInitialSize(javafx.scene.Node visualToResize)

Returns the current size of the passed-in Node, i.e. the width and height of its layout-bounds.

Parameters:

visualToResize - The Node for which to return the current size.

Returns:

The current size of the passed-in Node.

getMinimumHeight

protected double getMinimumHeight()

Returns the minimum height. The height of a Node cannot be changed below this limit.

Returns:

The minimum height.

getMinimumWidth

protected double getMinimumWidth()

Returns the minimum width. The width of a Node cannot be changed below this limit.

Returns:

The minimum width.

getVisualToResize

protected javafx.scene.Node getVisualToResize()

Returns the Node that should be resized. Per default, this is the host's visual.

Returns:

The Node that should be resized.

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

performResize

public void performResize(double dw,
                          double dh)

Resizes the visual by the given delta width and delta height.

Parameters:

dw - The delta width.

dh - The delta height.

updateOperation

protected void updateOperation(double layoutDw,
                               double layoutDh)

Updates the resize operation to use the given delta width and delta height.

Parameters:

layoutDw - The new delta width.

layoutDh - The new delta height.