Search this API

y.view
Interface MouseInputEditor

All Known Subinterfaces:
MultiplexingNodeEditor.NodeEditor
All Known Implementing Classes:
AbstractMouseInputEditor, GroupNodePainter.GroupStateEditor, MultiplexingNodeEditor, MultiplexingNodeEditor.EventReporter, TableLabelEditor, TableOrderEditor, TableSelectionEditor, TableSizeEditor

public interface MouseInputEditor

This interface is used by MouseInputMode. It can be implemented by clients that wish to process Mouse2DEvents.

See Also:
EditMode.setMouseInputMode(MouseInputMode), MouseInputMode.startEditor(MouseInputEditor)
 

Method Summary
 void addChangeListener(javax.swing.event.ChangeListener listener)
          Adds a ChangeListener instance that will be notified if the isEditing() state of this instance changes.
 boolean isEditing()
          Determines whether this instance is currently "editing".
 boolean isInterestedInEvents()
          This method is used by clients to determine whether this instance is interested in Mouse2DEvent
 void mouse2DEventHappened(Mouse2DEvent event)
          Listener-like interface that will be notified of Mouse2DEvents.
 void removeChangeListener(javax.swing.event.ChangeListener listener)
          Removes a ChangeListener instance that was notified if the isEditing() state of this instance changes.
 void startEditing()
          Used by clients to programmatically start the editing process.
 boolean startsEditing(Mouse2DEvent event)
          This method is used by clients to query whether the given event is deemed as a starting gesture.
 void stopEditing()
          Called by clients to stop the editing process cleanly.
 

Method Detail

isInterestedInEvents

boolean isInterestedInEvents()
This method is used by clients to determine whether this instance is interested in Mouse2DEvent

Returns:
whether to deliver Mouse2DEvents to this instance
See Also:
startsEditing(Mouse2DEvent), mouse2DEventHappened(Mouse2DEvent)

startsEditing

boolean startsEditing(Mouse2DEvent event)
This method is used by clients to query whether the given event is deemed as a starting gesture.

Parameters:
event - the event that happened
Returns:
whether the given gesture can be used to start the editing
See Also:
isInterestedInEvents()

isEditing

boolean isEditing()
Determines whether this instance is currently "editing".

Returns:
whether this instance is currently editing.

startEditing

void startEditing()
Used by clients to programmatically start the editing process.


mouse2DEventHappened

void mouse2DEventHappened(Mouse2DEvent event)
Listener-like interface that will be notified of Mouse2DEvents.

Parameters:
event - the event that happened
See Also:
isInterestedInEvents()

stopEditing

void stopEditing()
Called by clients to stop the editing process cleanly.


addChangeListener

void addChangeListener(javax.swing.event.ChangeListener listener)
Adds a ChangeListener instance that will be notified if the isEditing() state of this instance changes.

Parameters:
listener - the listener to notify of state changes

removeChangeListener

void removeChangeListener(javax.swing.event.ChangeListener listener)
Removes a ChangeListener instance that was notified if the isEditing() state of this instance changes.

Parameters:
listener - the listener to notify of state changes

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.