org.esa.beam.framework.ui.tool
Class ToolInputEvent

java.lang.Object
  java.util.EventObject
      org.esa.beam.framework.ui.tool.ToolInputEvent

All Implemented Interfaces:

Serializable

Deprecated. since BEAM 4.7, no replacement

@Deprecated
public class ToolInputEvent
extends EventObject

A special event type which is fired by tool-aware components to inform a tool about user inputs via the mouse or the keyboard.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ToolInputEvent(Component source, KeyEvent keyEvent, int pixelX, int pixelY, boolean pixelPosValid)
Deprecated. Constructs a new tool input event generated by a key event.

ToolInputEvent(Component source, MouseEvent mouseEvent, int pixelX, int pixelY, boolean pixelPosValid)
Deprecated. Constructs a new tool input event generated by a mouse event.

Method Summary

Component	getComponent() Deprecated. Returns the source component.
KeyEvent	getKeyEvent() Deprecated. Returns the key event or null if this event was generated by a mouse event.
MouseEvent	getMouseEvent() Deprecated. Returns the mouse event or null if this event was generated by a key event.
Point	getPixelPos() Deprecated. Gets the current pixel co-ordinate of the image as point.
int	getPixelX() Deprecated. Gets the current pixel x co-ordinate of the image.
int	getPixelY() Deprecated. Gets the current pixel y co-ordinate of the image.
boolean	isPixelPosValid() Deprecated. Returns whether or not the pixel position is valid.
String	toString() Deprecated. Returns a String representation of this EventObject.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolInputEvent

public ToolInputEvent(Component source,
                      MouseEvent mouseEvent,
                      int pixelX,
                      int pixelY,
                      boolean pixelPosValid)

Deprecated.

Constructs a new tool input event generated by a mouse event.

ToolInputEvent

public ToolInputEvent(Component source,
                      KeyEvent keyEvent,
                      int pixelX,
                      int pixelY,
                      boolean pixelPosValid)

Deprecated.

Constructs a new tool input event generated by a key event.

Method Detail

getComponent

public Component getComponent()

Deprecated.

Returns the source component.

getKeyEvent

public KeyEvent getKeyEvent()

Deprecated.

Returns the key event or null if this event was generated by a mouse event.

See Also:

getMouseEvent()

getMouseEvent

public MouseEvent getMouseEvent()

Deprecated.

Returns the mouse event or null if this event was generated by a key event.

See Also:

getKeyEvent()

getPixelX

public int getPixelX()

Deprecated.

Gets the current pixel x co-ordinate of the image.

getPixelY

public int getPixelY()

Deprecated.

Gets the current pixel y co-ordinate of the image.

getPixelPos

public Point getPixelPos()

Deprecated.

Gets the current pixel co-ordinate of the image as point.

isPixelPosValid

public boolean isPixelPosValid()

Deprecated.

Returns whether or not the pixel position is valid.

toString

public String toString()

Deprecated.

Returns a String representation of this EventObject.

Overrides:

toString in class EventObject

Returns:

A a String representation of this EventObject.