com.luciad.edit.handles

Class EditActionBinder

java.lang.Object

com.luciad.edit.handles.EditActionBinder

All Implemented Interfaces:

AutoCloseable

public final class EditActionBinder
extends Object
implements AutoCloseable

This class allows you to specify more options or requirements for actions that can be executed by handles, such as the mouse buttons that users need to click for the action to be executed, or the mouse cursor that is displayed when interacting with the handle.

It is used by the following handle implementations, for example:

• PointEditHandle
• TranslateEditHandle

Method Summary

Modifier and Type	Method and Description
void	close()
EditActionBinder	cursor(MouseCursor cursor) Sets the mouse cursor to display when this handle is highlighted and this action's requirements, such as modifier keys or mouse button clicks, are met.
protected void	finalize()
EditActionBinder	modifierKeys(ModifierKeys modifierKeys) Sets the modifier keys that must be pressed while the click occurs for the action to be performed.
EditActionBinder	mouseButton(MouseButton mouseButton) Sets the mouse button that must be clicked for the action to be performed.
EditActionBinder	performOnIntermediateEvents(boolean enable) Sets whether the action is also performed for intermediate events, such as drag updates or mouse moves, and not only at the end of a gesture event sequence.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

mouseButton

@NotNull
public EditActionBinder mouseButton(@NotNull
                                             MouseButton mouseButton)

Sets the mouse button that must be clicked for the action to be performed.

By default, this is the left mouse button.

Parameters:

mouseButton - the mouse button that must be clicked.

Returns:

this

modifierKeys

@NotNull
public EditActionBinder modifierKeys(@NotNull
                                              ModifierKeys modifierKeys)

Sets the modifier keys that must be pressed while the click occurs for the action to be performed.

By default this is set to ModifierKeys#none.

Parameters:

modifierKeys - the modifier keys that must be pressed.

Returns:

this

performOnIntermediateEvents

@NotNull
public EditActionBinder performOnIntermediateEvents(boolean enable)

Sets whether the action is also performed for intermediate events, such as drag updates or mouse moves, and not only at the end of a gesture event sequence.

The default is true.

Parameters:

enable - whether IPointEditAction#execute is also called for intermediate events

Returns:

this

cursor

@NotNull
public EditActionBinder cursor(@NotNull
                                        MouseCursor cursor)

Sets the mouse cursor to display when this handle is highlighted and this action's requirements, such as modifier keys or mouse button clicks, are met.

By default, no custom cursor is defined.

Parameters:

cursor - the mouse cursor to display

Returns:

this