Package com.luciad.edit.handles

Class LineEditHandle

java.lang.Object
com.luciad.edit.handles.LineEditHandle
All Implemented Interfaces:
IEditHandle, AutoCloseable
public final class LineEditHandle extends Object implements AutoCloseable, IEditHandle
This handle represents a line on the Map and can be visualized using a line.

It can be moved around, or react to mouse events.

The handle executes IPointEditAction, based on mouse input events. IEditHandles implementations configure concrete IPointEditAction implementations on this handle to make sure they result in geometry or feature changes. For example, when this handle is dragged around on the Map, an IEditHandles implementation for circles can make sure that the circle can expand/shrink.

This class supports the following gestures:

This handle is painted using the provided geometry.

Since:
2025.0

  • Constructor Details

    • LineEditHandle

      public LineEditHandle(@NotNull Geometry geometry)
      Creates a new LineEditHandle without associated actions.
      Parameters:
      geometry - the initial geometry of the handle, cannot be null

    • LineEditHandle

      public LineEditHandle(@NotNull Observable<@Nullable Geometry> geometryProvider)
      Creates a LineEditHandle without associated actions.
      Parameters:
      geometryProvider - the geometry provider of the handle. The handle assumes the geometry of this point upon construction, while also observing the geometry to adjust its own shape whenever the observable geometry changes; cannot be null.

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • onEvent

      @NotNull public EventResult onEvent(@NotNull IInputEvent inputEvent, @NotNull FeatureEditContext context) throws NullPointerException
      Handles the given event, and returns if the event was consumed or not.

      While handling events, IEditHandles can mark themselves as highlighted or as Active. Related to event handling, the main effect of this is that highlighted or active handles get a higher priority compared to other handles: they get the chance to consume events first. See EditHandleState

      Specified by:
      onEvent in interface IEditHandle
      Parameters:
      inputEvent - the event to handle, cannot be null
      context - the context, cannot be null
      Returns:
      if the event was consumed or not
      Throws:
      NullPointerException - when null is passed.

    • paint

      public void paint(@NotNull FeatureCanvas canvas, @NotNull FeatureEditContext context)
      Paints this handle on the given canvas.

      This method is called when

      This method only gets called on the UI thread, so there is no need for additional synchronization.

      Specified by:
      paint in interface IEditHandle
      Parameters:
      canvas - the canvas on which this handle gets painted.
      context - the context, cannot be null

    • getEditState

      @NotNull public EditHandleState getEditState()
      Returns the current state of this handle.
      Specified by:
      getEditState in interface IEditHandle
      Returns:
      the current state of this handle.

    • getMouseCursor

      @Nullable public MouseCursor getMouseCursor()
      Returns the current mouse cursor that should be displayed for this handle.

      This method typically returns a value when this handle is highlighted or active. If not, null can be returned.

      Specified by:
      getMouseCursor in interface IEditHandle
      Returns:
      the current mouse cursor that should be displayed for this handle.

    • setInvalidationCallback

      public void setInvalidationCallback(@Nullable IInvalidationCallback invalidationCallback)
      Sets the callback for the handle to call when its visual representation or cursor has changed.

      Calling this callback triggers a new call to this handle's paint method.

      Specified by:
      setInvalidationCallback in interface IEditHandle
      Parameters:
      invalidationCallback - the callback for the handle to call when its visual representation has changed

    • addEditStateObserver

      public void addEditStateObserver(@NotNull IInvalidationCallback observer) throws IllegalArgumentException
      Adds an observer that is called when the edit state of this handle has changed.

      Adding the same observer twice is forbidden, and will cause an exception to be thrown.

      Specified by:
      addEditStateObserver in interface IEditHandle
      Parameters:
      observer - an observer
      Throws:
      IllegalArgumentException - when the observer was already added.
      Since:
      2023.1

    • removeEditStateObserver

      public void removeEditStateObserver(@NotNull IInvalidationCallback observer) throws IllegalArgumentException
      Removes the given observer.

      If the given observer was never added, an exception is thrown.

      Specified by:
      removeEditStateObserver in interface IEditHandle
      Parameters:
      observer - an observer
      Throws:
      IllegalArgumentException - when the observer is not known.
      Since:
      2023.1

    • getGeometry

      @Nullable public Geometry getGeometry()
      Returns the current geometry of this handle.

      Note that this geometry is not necessarily equal to the geometry provider at all times. For example, they may differ when the handle is dragged around and no geometry changes are triggered in the geometry provider.

      Returns:
      the current geometry of this handle

    • getGeometryProvider

      @NotNull public Observable<@Nullable Geometry> getGeometryProvider()
      Returns the geometry provider of this handle.

      Note that the handle's current geometry is not necessarily equal to this geometry provider at all times. For example, they may differ when the handle is dragged around and no geometry changes are triggered in this geometry provider.

      Returns:
      the geometry provider of this handle. Never null.

    • getZOrder

      public int getZOrder()
      Returns the Z-order that is used for this handle's paint calls to the FeatureCanvas.
      Returns:
      the Z-order that is used for this handle's paint calls to the FeatureCanvas.
      See Also:

    • setZOrder

      public void setZOrder(int zOrder)
      Sets the Z-order that is used for this handle's paint calls to the FeatureCanvas.

      This Z-order determines which handles are painted on top, when multiple handles overlap. Edit handles with a higher Z-order are painted on top of handles with a lower Z-order. Note: Highlighted edit handles are always painted above regular handles, and active handles are always painted above highlighted handles.

      Must be between [-1000,1000]. The default value is 0.

      Parameters:
      zOrder - the Z-order that is used for this handle's paint calls to the FeatureCanvas.
      See Also:

    • getRegularLineStyle

      @Nullable public LineStyle getRegularLineStyle()
      Returns the visual aid line style to use when this handle is in an inactive state.
      Returns:
      The visual aid line style to use when this handle is in an inactive state.

    • setRegularLineStyle

      public void setRegularLineStyle(@Nullable LineStyle lineStyle)
      Sets the line style to use when this handle is in an inactive state.
      Parameters:
      lineStyle - The line style to use when this handle is in an inactive state.

    • getHighlightedLineStyle

      @Nullable public LineStyle getHighlightedLineStyle()
      Returns the visual aid line style to use when this handle is in a highlighted state.
      Returns:
      The visual aid line style to use when this handle is in a highlighted state.

    • setHighlightedLineStyle

      public void setHighlightedLineStyle(@Nullable LineStyle lineStyle)
      Sets the line style to use when this handle is in a highlighted state.
      Parameters:
      lineStyle - The line style to use when this handle is in a highlighted state.

    • getActiveLineStyle

      @Nullable public LineStyle getActiveLineStyle()
      Returns the visual aid line style to use when this handle is in an active state.
      Returns:
      The visual aid line style to use when this handle is in an active state.

    • setActiveLineStyle

      public void setActiveLineStyle(@Nullable LineStyle lineStyle)
      Sets the line style to use when this handle is in an active state.
      Parameters:
      lineStyle - The line style to use when this handle is in an active state.

    • addOnClickAction

      @NotNull public EditActionBinder addOnClickAction(@NotNull IPointEditAction action, long clickCount)
      Adds an action that will be triggered when the handle is clicked or tapped (touch).
      Parameters:
      action - the action to be performed, cannot be null.
      clickCount - the action will only be performed when an event is received with this click count.
      Returns:
      an object to specify more options or requirements for the given on-click action, such as the mouse buttons that need to be pressed for the action to be executed.

    • addOnTouchLongPressAction

      @NotNull public EditActionBinder addOnTouchLongPressAction(@NotNull IPointEditAction action)
      Adds an action that will be triggered when a long press is performed on a handle.
      Parameters:
      action - the action to be performed, cannot be null.
      Returns:
      an object to specify more options or requirements for the given on-drag action

    • addOnDragAction

      @NotNull public EditActionBinder addOnDragAction(@NotNull IPointEditAction action)
      Adds an action that will be triggered when the handle is dragged.

      The given action is executed at least when the drag gesture starts and ends, and if EditActionBinder#performOnIntermediateEvents is set to true, it also gets executed on every intermediate drag event. The action is always called with an EventStatus parameter corresponding to the drag event.

      Parameters:
      action - the action to be performed on drag, cannot be null.
      Returns:
      an object to specify more options or requirements for the given on-drag action, such as the mouse buttons that need to be pressed for the action to be executed.

    • addOnMouseMoveAction

      @NotNull public EditActionBinder addOnMouseMoveAction(@NotNull IPointEditAction action)
      Adds an action that will be executed on every mouse move.
      Parameters:
      action - the action to be performed during the mouse move, cannot be null.
      Returns:
      an object to specify more options or requirements for the given action, such as the modifier keys that need to be pressed for the action to be executed.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object other)
      Overrides:
      equals in class Object