Class TLcdActionAtLocationEvent

All Implemented Interfaces:
Serializable

public class TLcdActionAtLocationEvent extends ActionEvent
Extension of ActionEvent which specifies a location where the action occurred. Can be used to trigger an ILcdAction over a specific point on the map.
Since:
10.0
See Also:
  • Constructor Details Link icon

    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, Component aComponent, int aID, String aCommand, long aWhen, int aModifiers, Point aLocation)
      Deprecated.
      the aComponent parameter is redundant due to overlap with the event. Use a constructor which doesn't take this parameter instead.
      Create a new TLcdActionAtLocationEvent
      Parameters:
      aSource - the object that originated the event
      aComponent - the Component on which the event occurred
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aWhen - the time the event occurred
      aModifiers - the modifier keys held down during this action
      aLocation - the location of the event relative to aComponent
      Throws:
      IllegalArgumentException - if aSource or aComponent is null
    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, Component aComponent, int aID, String aCommand, int aModifiers, Point aLocation)
      Deprecated.
      the aComponent parameter is redundant due to overlap with the event. Use a constructor which doesn't take this parameter instead.
      Create a new TLcdActionAtLocationEvent which occurred at time 0
      Parameters:
      aSource - the object that originated the event
      aComponent - the component on which the event occurred
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aModifiers - the modifier keys held down during this action
      aLocation - the location of the event relative to aComponent
      Throws:
      IllegalArgumentException - if aSource or aComponent is null
      See Also:
    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, Component aComponent, int aID, String aCommand, Point aLocation)
      Deprecated.
      the aComponent parameter is redundant due to overlap with the event. Use a constructor which doesn't take this parameter instead.
      Create a new TLcdActionAtLocationEvent which occurred at time 0 and with modifiers 0
      Parameters:
      aSource - the object that originated the event
      aComponent - the Component on which the event occurred
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aLocation - the location of the event relative to aComponent
      Throws:
      IllegalArgumentException - if aSource or aComponent is null
      See Also:
    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, int aID, String aCommand, long aWhen, int aModifiers, Point aLocation)
      Create a new TLcdActionAtLocationEvent.
      Parameters:
      aSource - the object that originated the event, typically an AWT component or JavaFX node
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aWhen - the time the event occurred
      aModifiers - the modifier keys held down during this action
      aLocation - the location of the event relative to aSource
      Throws:
      IllegalArgumentException - if aSource is null
      Since:
      2020.0
    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, int aID, String aCommand, int aModifiers, Point aLocation)
      Create a new TLcdActionAtLocationEvent which occurred at time 0.
      Parameters:
      aSource - the object that originated the event, typically an AWT component or JavaFX node
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aModifiers - the modifier keys held down during this action
      aLocation - the location of the event relative to aSource
      Throws:
      IllegalArgumentException - if aSource is null
      Since:
      2020.0
      See Also:
    • TLcdActionAtLocationEvent Link icon

      public TLcdActionAtLocationEvent(Object aSource, int aID, String aCommand, Point aLocation)
      Create a new TLcdActionAtLocationEvent which occurred at time 0 and with modifiers 0.
      Parameters:
      aSource - the object that originated the event, typically an AWT component or JavaFX node
      aID - an integer that identifies the event
      aCommand - a string that may specify a command (possibly one of several) associated with the event
      aLocation - the location of the event relative to aSource
      Throws:
      IllegalArgumentException - if aSource is null
      Since:
      2020.0
      See Also:
  • Method Details Link icon

    • getLocation Link icon

      public Point getLocation()
      Returns the location of the event relative to the event's source.
      Returns:
      the location of the event relative to the event's source
      See Also:
    • getComponent Link icon

      public Component getComponent()
      Deprecated.
      this property is not being used in practice due to its overlap with the event's source.
      Returns the component on which the event occurred.
      Returns:
      the component on which the event occurred