com.luciad.view.lightspeed.editor.handle

LuciadLightspeedClass ALsp3StepEditHandle

java.lang.Object

com.luciad.view.lightspeed.editor.handle.ALspHandle

com.luciad.view.lightspeed.editor.handle.ALspEditHandle

com.luciad.view.lightspeed.editor.handle.ALsp3StepEditHandle

Direct Known Subclasses:

ALspObjectTranslationHandle, ALspOutlineResizeHandle, TLspPointTranslationHandle

public abstract class ALsp3StepEditHandle
extends ALspEditHandle

Convenience handle class that separates the handling of AWT events into 3 steps. These steps include:

• Activation: First the handle checks if the handle can be activated. If so, onActivate is called. When a handle is active, the subsequent events will be passed to it. A handle remains active until it is deactivated by onDeactivate.
• Processing: If a handle is active, the handle checks if it can process an event. If so, process is called. This step is typically performed for multiple events. When an event is processed, it returns a TLspEditHandleResult, which contains the partially processed event, and a list of edit operations to perform.
• Deactivation: If a handle is active the handle checks if it can be deactivated. If so, onDeactivate is called, and the handle becomes inactive (isActive returns false).

Subclasses should implement the above methods to obtain the desired behavior.

Note: This handle checks if it can be deactivated before it checks if it can process an event.

Since:

2012.0

Field Summary

Fields inherited from class com.luciad.view.lightspeed.editor.handle.ALspHandle

PRIORITY_2D_CONTOUR, PRIORITY_2D_POINT, PRIORITY_2D_SHAPE, PRIORITY_3D_CONTOUR, PRIORITY_3D_POINT, PRIORITY_3D_SHAPE, PRIORITY_MULTIPLE_SHAPES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALsp3StepEditHandle(Object aGeometry) Creates a new ALsp3StepEditHandle for the given object.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canActivate(AWTEvent aEvent, TLspEditContext aEditContext) Checks whether the handle can be activated.
protected boolean	canActivate(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of canActivate(AWTEvent, TLspEditContext).
protected abstract boolean	canDeactivate(AWTEvent aEvent, TLspEditContext aEditContext) Checks whether the handle can be deactivated.
protected boolean	canDeactivate(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of canDeactivate(AWTEvent, TLspEditContext).
protected abstract boolean	canProcess(AWTEvent aEvent, TLspEditContext aEditContext) Checks whether the given event should be processed.
protected boolean	canProcess(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of canProcess(AWTEvent, TLspEditContext).
TLspEditHandleResult	handleAWTEvent(AWTEvent aEvent, TLspEditContext aEditContext) Handle the given input event for the given edit context.
TLspEditHandleResultFX	handleFXEvent(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of handleAWTEvent(AWTEvent, TLspEditContext).
boolean	isActive() Checks whether this handle is active.
protected abstract TLspEditHandleResult	onActivate(AWTEvent aEvent, TLspEditContext aEditContext) Called when this handle is activated (after canActivate has returned true.
protected TLspEditHandleResultFX	onActivate(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of onActivate(AWTEvent, TLspEditContext).
protected abstract TLspEditHandleResult	onDeactivate(AWTEvent aEvent, TLspEditContext aEditContext) Performs some action with the event after the handle is deactivated.
protected TLspEditHandleResultFX	onDeactivate(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of onDeactivate(AWTEvent, TLspEditContext).
protected abstract TLspEditHandleResult	process(AWTEvent aEvent, TLspEditContext aEditContext) Process the given event.
protected TLspEditHandleResultFX	process(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of process(AWTEvent, TLspEditContext).

Methods inherited from class com.luciad.view.lightspeed.editor.handle.ALspEditHandle

getGeometry, requestsFocus, requestsFocus

Methods inherited from class com.luciad.view.lightspeed.editor.handle.ALspHandle

getCursor, getCursorFX, getPriority, getProperties, getStyleTargetProviders, setCursor, setCursorFX, setPriority

Methods inherited from class java.lang.Object

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

Constructor Detail

ALsp3StepEditHandle

protected ALsp3StepEditHandle(Object aGeometry)

Creates a new ALsp3StepEditHandle for the given object.

Parameters:

aGeometry - the geometry that is edited by this handle. Null is allowed, for instance if editing doesn't involve geometry directly.

Method Detail

isActive

public final boolean isActive()

Checks whether this handle is active. When a handle is active, it will be the first candidate to receive events. If a handle is inactive, it might still receive events (possibly making it active) if all other active handles didn't process an event.

This method returns true in between canActivate returning true, and onDeactivate being called. Otherwise this method returns false.

Specified by:

isActive in class ALspHandle

Returns:

true if active, false otherwise

handleAWTEvent

public TLspEditHandleResult handleAWTEvent(AWTEvent aEvent,
                                           TLspEditContext aEditContext)

Handle the given input event for the given edit context. The edit handle can choose the operation to perform based on the type and state of the input event.

When the edit handle has processed the input event, this method will return a edit handle result containing a null event to indicate that the event has been consumed. Note that sometimes an event might be partially consumed (which is often the case with touch events), in which case this method will return an edit handle result with an altered version of the given input event.

If incoming event should be ignored, this method should return a TLspEditHandleResult without any edit operations, and an unconsumed AWTEvent. An unconsumed AWTEvent means that it should contain the original, unmodified aEvent parameter passed to this method. This result indicates that the event was not consumed, and that some other object needs to consume the event instead.

As a side effect, a handle is allowed to activate or deactivate itself as a result of processing an input event.

This method performs the handling of AWT events into 3 steps.

• Activation: First the handle checks if the handle can be activated. If so, onActivate is called.
• Processing: If a handle is active, the handle checks if it can process an event. If so, process is called. This step is typically performed for multiple events.
• Deactivation: If a handle is active the handle checks if it can be deactivated. If so, onDeactivate is called, and the handle becomes inactive (isActive returns false).

Subclasses should implement the above methods to obtain the desired behavior.

Note: This handle checks if it can be deactivated before it checks if it can process an event.

Specified by:

handleAWTEvent in class ALspEditHandle

Parameters:

aEvent - the input event

aEditContext - the edit context, containing, amongst others, information about the layer for which this handle is operating, the view, the object for which this handle was created, the geometry that this handle was created for, the paint representation in which geometry exists, and the sensitivity with which the event should be handled

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

See Also:

ALspHandle.isActive()

handleFXEvent

public TLspEditHandleResultFX handleFXEvent(javafx.event.Event aEvent,
                                            TLspEditContext aEditContext)

JavaFX equivalent of handleAWTEvent(AWTEvent, TLspEditContext).

Overrides:

handleFXEvent in class ALspEditHandle

Parameters:

aEvent - the input event

aEditContext - the edit context, containing, amongst others, information about the layer for which this handle is operating, the view, the object for which this handle was created, the geometry that this handle was created for, the paint representation in which geometry exists, and the sensitivity with which the event should be handled

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

Since:

2020.0

onActivate

protected abstract TLspEditHandleResult onActivate(AWTEvent aEvent,
                                                   TLspEditContext aEditContext)

Called when this handle is activated (after canActivate has returned true.

Parameters:

aEvent - the event that caused the handle to be activated

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext), canActivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

onActivate

protected TLspEditHandleResultFX onActivate(javafx.event.Event aEvent,
                                            TLspEditContext aEditContext)

JavaFX equivalent of onActivate(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that caused the handle to be activated

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

Since:

2020.0

onDeactivate

protected abstract TLspEditHandleResult onDeactivate(AWTEvent aEvent,
                                                     TLspEditContext aEditContext)

Performs some action with the event after the handle is deactivated.

Parameters:

aEvent - the event that caused the handle to be deactivated

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext), canDeactivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

onDeactivate

protected TLspEditHandleResultFX onDeactivate(javafx.event.Event aEvent,
                                              TLspEditContext aEditContext)

JavaFX equivalent of onDeactivate(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that caused the handle to be deactivated

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

Since:

2020.0

process

protected abstract TLspEditHandleResult process(AWTEvent aEvent,
                                                TLspEditContext aEditContext)

Process the given event. This method is only called when the handle is active and processing is requested.

Parameters:

aEvent - the event that was processed

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

process

protected TLspEditHandleResultFX process(javafx.event.Event aEvent,
                                         TLspEditContext aEditContext)

JavaFX equivalent of process(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that was processed

aEditContext - the edit context

Returns:

an edit handle result containing a collection of operations to perform, and the (partially) consumed event object. The handle result itself should not be null.

Since:

2020.0

canActivate

protected abstract boolean canActivate(AWTEvent aEvent,
                                       TLspEditContext aEditContext)

Checks whether the handle can be activated. If this method returns true, isActive will return true and onActivate is called next.

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should be activated as a result of the given event, false otherwise

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext), onActivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

canActivate

protected boolean canActivate(javafx.event.Event aEvent,
                              TLspEditContext aEditContext)

JavaFX equivalent of canActivate(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should be activated as a result of the given event, false otherwise

Since:

2020.0

canDeactivate

protected abstract boolean canDeactivate(AWTEvent aEvent,
                                         TLspEditContext aEditContext)

Checks whether the handle can be deactivated. If this method returns true, isActive will return false and onDeactivate is called next.

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should be deactivated as a result of the given event, false otherwise

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext), onDeactivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

canDeactivate

protected boolean canDeactivate(javafx.event.Event aEvent,
                                TLspEditContext aEditContext)

JavaFX equivalent of canDeactivate(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should be deactivated as a result of the given event, false otherwise

Since:

2020.0

canProcess

protected abstract boolean canProcess(AWTEvent aEvent,
                                      TLspEditContext aEditContext)

Checks whether the given event should be processed. If this method returns true, process is called next.

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should process this event, false otherwise.

See Also:

ALspEditHandle.handleAWTEvent(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext), process(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

canProcess

protected boolean canProcess(javafx.event.Event aEvent,
                             TLspEditContext aEditContext)

JavaFX equivalent of canProcess(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event that should be handled

aEditContext - the edit context

Returns:

true if the handle should process this event, false otherwise.

Since:

2020.0