org.jsfml.window.event

Class Event

java.lang.Object

org.jsfml.window.event.Event

Direct Known Subclasses:

JoystickEvent, KeyEvent, MouseEvent, SizeEvent, TextEvent

public class Event
extends Object

Base class for window events.

Window events must be polled from a window on a regular basis to keep the window responsive.

Events are of a certain type, some of which provide additional data. For various special types, subclasses of this class exist. This class provides convenience methods to cast Event objects to one of these special subclasses (e.g. asKeyEvent(), which will cast the event to a KeyEvent, if possible).

See Also:

Window.pollEvents(), Event.Type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Type Enumeration of available window event types.

Field Summary

Fields

Modifier and Type	Field and Description
Event.Type	type The type of the window event.

Constructor Summary

Constructors

Constructor and Description
Event(int type) Constructs a new event.

Method Summary

Methods

Modifier and Type	Method and Description
JoystickButtonEvent	asJoystickButtonEvent() Attempts to cast this event to a JoystickButtonEvent.
JoystickEvent	asJoystickEvent() Attempts to cast this event to a JoystickEvent.
JoystickMoveEvent	asJoystickMoveEvent() Attempts to cast this event to a JoystickMoveEvent.
KeyEvent	asKeyEvent() Attempts to cast this event to a KeyEvent.
MouseButtonEvent	asMouseButtonEvent() Attempts to cast this event to a MouseButtonEvent.
MouseEvent	asMouseEvent() Attempts to cast this event to a MouseEvent.
MouseWheelEvent	asMouseWheelEvent() Attempts to cast this event to a MouseWheelEvent.
SizeEvent	asSizeEvent() Attempts to cast this event to a SizeEvent.
TextEvent	asTextEvent() Attempts to cast this event to a TextEvent.

Methods inherited from class java.lang.Object

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

Field Detail

type

public final Event.Type type

The type of the window event.

See Also:

Event.Type

Constructor Detail

Event

public Event(int type)

Constructs a new event.

Parameters:

type - the type of the event. This must be a valid ordinal in the Event.Type enumeration.

Method Detail

asJoystickButtonEvent

public JoystickButtonEvent asJoystickButtonEvent()

Attempts to cast this event to a JoystickButtonEvent.

Returns:

the event cast to a JoystickButtonEvent if its type is either Event.Type.JOYSTICK_BUTTON_PRESSED or Event.Type.JOYSTICK_BUTTON_RELEASED, null otherwise.

asJoystickEvent

public JoystickEvent asJoystickEvent()

Attempts to cast this event to a JoystickEvent.

Returns:

the event cast to a JoystickEvent if its type is one of Event.Type.JOYSTICK_CONNECETED, Event.Type.JOYSTICK_DISCONNECTED, Event.Type.JOYSTICK_BUTTON_PRESSED, Event.Type.JOYSTICK_BUTTON_RELEASED or Event.Type.JOYSTICK_MOVED, null otherwise.

asJoystickMoveEvent

public JoystickMoveEvent asJoystickMoveEvent()

Attempts to cast this event to a JoystickMoveEvent.

Returns:

the event cast to a JoystickButtonEvent if its type is Event.Type.JOYSTICK_MOVED, null otherwise.

asKeyEvent

public KeyEvent asKeyEvent()

Attempts to cast this event to a KeyEvent.

Returns:

the event cast to a KeyEvent if its type is either Event.Type.KEY_PRESSED or Event.Type.KEY_RELEASED, null otherwise.

asMouseButtonEvent

public MouseButtonEvent asMouseButtonEvent()

Attempts to cast this event to a MouseButtonEvent.

Returns:

the event cast to a MouseButtonEvent if its type is either Event.Type.MOUSE_BUTTON_PRESSED or Event.Type.MOUSE_BUTTON_RELEASED, null otherwise.

asMouseEvent

public MouseEvent asMouseEvent()

Attempts to cast this event to a MouseEvent.

Returns:

the event cast to a MouseEvent if its type is one of Event.Type.MOUSE_ENTERED, Event.Type.MOUSE_MOVED, Event.Type.MOUSE_LEFT, Event.Type.MOUSE_BUTTON_PRESSED, Event.Type.MOUSE_BUTTON_RELEASED or Event.Type.MOUSE_WHEEL_MOVED, null otherwise.

asMouseWheelEvent

public MouseWheelEvent asMouseWheelEvent()

Attempts to cast this event to a MouseWheelEvent.

Returns:

the event cast to a MouseWheelEvent if its type is Event.Type.MOUSE_WHEEL_MOVED, null otherwise.

asSizeEvent

public SizeEvent asSizeEvent()

Attempts to cast this event to a SizeEvent.

Returns:

the event cast to a SizeEvent if its type is Event.Type.RESIZED, null otherwise.

asTextEvent

public TextEvent asTextEvent()

Attempts to cast this event to a TextEvent.

Returns:

the event cast to a TextEvent if its type is Event.Type.TEXT_ENTERED, null otherwise.