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

Class TLspNextCreateStepFXEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.luciad.view.lightspeed.editor.handle.TLspNextCreateStepFXEvent

All Implemented Interfaces:

Serializable, Cloneable

public class TLspNextCreateStepFXEvent
extends Event

A custom JavaFX 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:

2020.0

See Also:

• ALspDynamicCreateHandle
• Serialized Form

Field Summary

Fields inherited from class javafx.event.Event

ANY, consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
TLspNextCreateStepFXEvent(Object aSource, Event aLastEvent)	Create a new TLspNextCreateStepFXEvent for the given source and event.
TLspNextCreateStepFXEvent(Object aSource, Event aLastEvent, boolean aFinish)	Creates a new TLspNextCreateStepFXEvent for the given source and event.

Method Summary

Modifier and Type	Method	Description
Event	getLastEvent()	Returns the last event this TLspNextCreateStepFXEvent 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 javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TLspNextCreateStepFXEvent

public TLspNextCreateStepFXEvent(Object aSource,
 Event aLastEvent)

Create a new TLspNextCreateStepFXEvent for the given source and event.

Calling this is equivalent to calling

TLspNextCreateStepFXEvent nextCreateStepEvent = new TLspNextCreateStepFXEvent(aSource, aLastEvent, true);

Parameters:

aSource - the object where the event originated.

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

TLspNextCreateStepFXEvent

public TLspNextCreateStepFXEvent(Object aSource,
 Event aLastEvent,
 boolean aFinish)

Creates a new TLspNextCreateStepFXEvent for the given source 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 object 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 Event getLastEvent()

Returns the last event this TLspNextCreateStepFXEvent 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.