Package com.luciad.view.lightspeed.editor.handle

Class ALspDynamicCreateHandle

java.lang.Object

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

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

com.luciad.view.lightspeed.editor.handle.ALspCreateHandle

com.luciad.view.lightspeed.editor.handle.ALspDynamicCreateHandle

public abstract class ALspDynamicCreateHandle
extends ALspCreateHandle

A create handle that dynamically adds handles. This is useful when the list of handles is not known a-priori. An example of an editor that uses a dynamic create handle is the TLsp2DPointListEditor, where a new handle is constructed whenever a new point is added to the point list under creation. Since the number of points in the list is unknown beforehand, a static create handle cannot be used.

This class can be extended by implementing createNewEditHandle. Since hasNext always returns true by default, requestsDeactivation can be used to end the creation.

Implementations of this class typically respond to TLspNextCreateStepEvent that is used to programmatically end a dynamic creation step (see also TLspCreateController.finish().

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	Description
protected	ALspDynamicCreateHandle(Object aDomainObject)	Creates a new dynamic create handle for the given object.

Method Summary

Modifier and Type	Method	Description
protected abstract ALspEditHandle	createNewEditHandle(AWTEvent aEvent, TLspEditContext aEditContext)	This method creates the next handle that should be used by this create handle.
protected ALspEditHandle	createNewEditHandle(Event aEvent, TLspEditContext aEditContext)	JavaFX equivalent of createNewEditHandle(AWTEvent, TLspEditContext).
protected boolean	hasNext(AWTEvent aEvent, TLspEditContext aEditContext)	Checks whether there is a next handle to be used in the creation process.
protected boolean	hasNext(Event aEvent, TLspEditContext aEditContext)	JavaFX equivalent of ALspCreateHandle.hasNext(AWTEvent, TLspEditContext).
ALspEditHandle	next(AWTEvent aEvent, TLspEditContext aEditContext)	Creates a new handle by calling createNewEditHandle, and sets the appropriate properties.
ALspEditHandle	next(Event aEvent, TLspEditContext aEditContext)	JavaFX equivalent of ALspCreateHandle.next(AWTEvent, TLspEditContext).

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

deactivate, deactivate, getActiveHandle, getCursor, getPreviousHandles, getStyleTargetProviders, handleAWTEvent, handleFXEvent, hasPrevious, hasPrevious, isActive, previous, previous, removePreviousHandle, requestsDeactivation, requestsDeactivation, requestsFocus, requestsFocus

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

getGeometry

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

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 Details

ALspDynamicCreateHandle

protected ALspDynamicCreateHandle(Object aDomainObject)

Creates a new dynamic create handle for the given object.

Parameters:

aDomainObject - the object to create.

Method Details

createNewEditHandle

protected abstract ALspEditHandle createNewEditHandle(AWTEvent aEvent,
 TLspEditContext aEditContext)

This method creates the next handle that should be used by this create handle. This method is called from next.

Parameters:

aEvent - the event

aEditContext - the edit context.

Returns:

a new handle, should never be null.

createNewEditHandle

protected ALspEditHandle createNewEditHandle(Event aEvent,
 TLspEditContext aEditContext)

JavaFX equivalent of createNewEditHandle(AWTEvent, TLspEditContext).

Parameters:

aEvent - the event

aEditContext - the edit context.

Since:

2020.0

hasNext

protected boolean hasNext(AWTEvent aEvent,
 TLspEditContext aEditContext)

Checks whether there is a next handle to be used in the creation process.

By default this method always returns true. In order to stop the creation process, this method can be overridden, or more conveniently, requestsDeactivation can be implemented to end the creation process when needed.

Specified by:

hasNext in class ALspCreateHandle

Parameters:

aEvent - the event

aEditContext - the edit context

Returns:

true if another handle is available, false otherwise.

hasNext

protected boolean hasNext(Event aEvent,
 TLspEditContext aEditContext)

Description copied from class: ALspCreateHandle

JavaFX equivalent of ALspCreateHandle.hasNext(AWTEvent, TLspEditContext).

Overrides:

hasNext in class ALspCreateHandle

Parameters:

aEvent - the event

aEditContext - the edit context

Returns:

true if another handle is available, false otherwise.

next

public ALspEditHandle next(AWTEvent aEvent,
 TLspEditContext aEditContext)

Creates a new handle by calling createNewEditHandle, and sets the appropriate properties.

Specified by:

next in class ALspCreateHandle

Parameters:

aEvent - event that initiated a transition to the next handle

aEditContext - the edit context

Returns:

the next handle.

See Also:

• createNewEditHandle(java.awt.AWTEvent, com.luciad.view.lightspeed.editor.TLspEditContext)

next

public ALspEditHandle next(Event aEvent,
 TLspEditContext aEditContext)

Description copied from class: ALspCreateHandle

JavaFX equivalent of ALspCreateHandle.next(AWTEvent, TLspEditContext).

Overrides:

next in class ALspCreateHandle

Parameters:

aEvent - the event

aEditContext - the edit context

Returns:

the next handle.