com.luciad.view.lightspeed.editor.handle

LuciadLightspeedClass TLspObjectTranslationHandle

java.lang.Object

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

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

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

com.luciad.view.lightspeed.editor.handle.ALspObjectTranslationHandle

com.luciad.view.lightspeed.editor.handle.TLspObjectTranslationHandle

Direct Known Subclasses:

TLspProjectedObjectTranslationHandle

public class TLspObjectTranslationHandle
extends ALspObjectTranslationHandle

A handle that allows translation of a whole object by touching and dragging.

Since:

2012.0

See Also:

ILspEditor.edit(com.luciad.view.lightspeed.editor.operation.TLspEditOperation, com.luciad.view.lightspeed.editor.operation.ELspInteractionStatus, com.luciad.view.lightspeed.editor.TLspEditContext)

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

Constructor and Description
TLspObjectTranslationHandle(Object aGeometry) Creates a translation handle to move the given editor.

Method Summary

Modifier and Type	Method and Description
List<ALspStyleTargetProvider>	getStyleTargetProviders(TLspHandleGeometryType aType) Returns a style target provider that can generate geometry for the given visual editing component type, or an empty list if no geometry can be generated for the given type.
protected 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 ALspObjectTranslationHandle.onActivate(AWTEvent, TLspEditContext).
protected 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 ALspObjectTranslationHandle.onDeactivate(AWTEvent, TLspEditContext).
protected TLspEditHandleResult	process(AWTEvent aEvent, TLspEditContext aEditContext) Process the given event.
protected TLspEditHandleResultFX	process(javafx.event.Event aEvent, TLspEditContext aEditContext) JavaFX equivalent of ALsp3StepEditHandle.process(AWTEvent, TLspEditContext).

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

canActivate, canActivate, canDeactivate, canDeactivate, canProcess, canProcess, isObjectTouched, isTranslateOnDrag, requestsFocus, requestsFocus, setTranslateOnDrag

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

handleAWTEvent, handleFXEvent, isActive

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

getGeometry

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspObjectTranslationHandle

public TLspObjectTranslationHandle(Object aGeometry)

Creates a translation handle to move the given editor. Translating the object is performed by pressing/clicking the left mouse button and dragging/moving.

Parameters:

aGeometry - the geometry to translate. This can either be the domain object in case the domain object is the geometry itself, or it could also be the output of the styler for a specific domain object.

Method Detail

onActivate

protected TLspEditHandleResult onActivate(AWTEvent aEvent,
                                          TLspEditContext aEditContext)

Description copied from class: ALspObjectTranslationHandle

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

By default, this method returns a edit handle result without operations and interaction status IN_PROGRESS.

Override this method to provide custom behavior. In that case, also make sure to call the super method.

Overrides:

onActivate in class ALspObjectTranslationHandle

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), ALsp3StepEditHandle.canActivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

onActivate

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

Description copied from class: ALspObjectTranslationHandle

JavaFX equivalent of ALspObjectTranslationHandle.onActivate(AWTEvent, TLspEditContext).

Overrides:

onActivate in class ALspObjectTranslationHandle

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.

onDeactivate

protected TLspEditHandleResult onDeactivate(AWTEvent aEvent,
                                            TLspEditContext aEditContext)

Description copied from class: ALspObjectTranslationHandle

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

By default, this method returns a edit handle result without operations and interaction status FINISHED.

Override this method to provide custom behavior. In that case, also make sure to call the super method.

Overrides:

onDeactivate in class ALspObjectTranslationHandle

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), ALsp3StepEditHandle.canDeactivate(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

onDeactivate

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

Description copied from class: ALspObjectTranslationHandle

JavaFX equivalent of ALspObjectTranslationHandle.onDeactivate(AWTEvent, TLspEditContext).

Overrides:

onDeactivate in class ALspObjectTranslationHandle

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.

process

protected TLspEditHandleResult process(AWTEvent aEvent,
                                       TLspEditContext aEditContext)

Description copied from class: ALsp3StepEditHandle

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

Specified by:

process in class ALsp3StepEditHandle

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)

Description copied from class: ALsp3StepEditHandle

JavaFX equivalent of ALsp3StepEditHandle.process(AWTEvent, TLspEditContext).

Overrides:

process in class ALsp3StepEditHandle

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.

getStyleTargetProviders

public List<ALspStyleTargetProvider> getStyleTargetProviders(TLspHandleGeometryType aType)

Description copied from class: ALspHandle

Returns a style target provider that can generate geometry for the given visual editing component type, or an empty list if no geometry can be generated for the given type. TLspEditHandleStyler allows you to register different styles for each visual component type.

Specified by:

getStyleTargetProviders in class ALspHandle

Parameters:

aType - a visual editing component type

Returns:

a list of style target providers, or an empty list if no style targets can be created for the given visual editing component type