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

Class TLspNextCreateStepEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

com.luciad.input.TLcdAWTEvent

com.luciad.view.lightspeed.editor.handle.TLspNextCreateStepEvent

All Implemented Interfaces:

Serializable

public class TLspNextCreateStepEvent
extends TLcdAWTEvent

A custom AWT event that indicates that the current create step can be stopped and the next, if any, can be started.

This event is typically used to replace a right- or double mouse click event. For example,during touch creation this event is useful to end a polyline or polygon creation or to advance to the next polygon when creating a complex polygon.

This event is generated for example when calling TLspCreateController.finish().

Since:

2012.0

See Also:

• ALspDynamicCreateHandle
• Serialized Form

Field Summary

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
TLspNextCreateStepEvent(Object aSource, AWTEvent aLastEvent)	Create a new TLspNextCreateStepEvent for the given component and event.
TLspNextCreateStepEvent(Object aSource, AWTEvent aLastEvent, boolean aFinish)	Creates a new TLspNextCreateStepEvent for the given component and event.

Method Summary

Modifier and Type	Method	Description
AWTEvent	getLastEvent()	Returns the last event this TLspNextCreateStepEvent was associated with.
boolean	isFinish()	Whether or not the next create step event should result in finishing the current creation step process.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Details

TLspNextCreateStepEvent

public TLspNextCreateStepEvent(Object aSource,
 AWTEvent aLastEvent)

Create a new TLspNextCreateStepEvent for the given component and event.

Calling this is equivalent to calling

TLspNextCreateStepEvent nextCreateStepEvent = new TLspNextCreateStepEvent(aSourceComponent, aLastEvent, true);

Parameters:

aSource - the source(an AWT Component or a JavaFX Node) where the event originated.

aLastEvent - the AWTEvent that was las associated with this handle event.

TLspNextCreateStepEvent

public TLspNextCreateStepEvent(Object aSource,
 AWTEvent aLastEvent,
 boolean aFinish)

Creates a new TLspNextCreateStepEvent for the given component and event.

This constructor allows you to specify whether this event should result in the next step resulting in the current creation step being finished, or whether it should simply move to the next step in the same process.

Example: If you are creating a complex polygon consisting of multiple polygons, setting finish to true will result in the current polygon finishing and the next polygon beginning. Setting the finish to false in the same scenario will result in the current polygon moving on to the next point within the same polygon.

Parameters:

aSource - the source(an AWT Component or a JavaFX Node) where the event originated.

aLastEvent - the AWTEvent that was las associated with this handle event.

aFinish - true if the event should finish the current creation process in the hierarchy; false if it should simply proceed to the next step within the same creation process.

Method Details

getLastEvent

public AWTEvent getLastEvent()

Returns the last event this TLspNextCreateStepEvent was associated with.

Returns:

the last event.

isFinish

public boolean isFinish()

Whether or not the next create step event should result in finishing the current creation step process.

Returns:

true if the event should finish the current creation process in the hierarchy; false if it should simply proceed to the next step within the same creation process.