Package com.prineside.tdi2.scene2d

Class Event

java.lang.Object
com.prineside.tdi2.scene2d.Event
All Implemented Interfaces:
Pool.Poolable
Direct Known Subclasses:
ChangeListener.ChangeEvent, FocusListener.FocusEvent, InputEvent, MoveToFrontListener.MoveToFrontEvent
public class Event extends Object implements Pool.Poolable
The base class for all events.

By default an event will "bubble" up through an actor's parent's handlers (see setBubbles(boolean)).

An actor's capture listeners can stop() an event to prevent child actors from seeing it.

An Event may be marked as "handled" which will end its propagation outside of the Stage (see handle()). The default Actor.fire(Event) will mark events handled if an EventListener returns true.

A cancelled event will be stopped and handled. Additionally, many actors will undo the side-effects of a canceled event. (See cancel().)

See Also:

  • Constructor Details

    • Event

      public Event()

  • Method Details

    • handle

      public void handle()
      Marks this event as handled. This does not affect event propagation inside scene2d, but causes the Stage InputProcessor methods to return true, which will eat the event so it is not passed on to the application under the stage.

    • cancel

      public void cancel()
      Marks this event cancelled. This handles the event and stops the event propagation. It also cancels any default action that would have been taken by the code that fired the event. Eg, if the event is for a checkbox being checked, cancelling the event could uncheck the checkbox.

    • stop

      public void stop()
      Marks this event has being stopped. This halts event propagation. Any other listeners on the listener actor are notified, but after that no other listeners are notified.

    • halt

      public void halt()
      Just like stop() but also prevents event propagation to the other listeners on the same actor.

    • reset

      public void reset()
      Description copied from interface: com.badlogic.gdx.utils.Pool.Poolable
      Resets the object for reuse. Object references should be nulled and fields may be set to default values.
      Specified by:
      reset in interface Pool.Poolable

    • getTarget

      public Actor getTarget()
      Returns the actor that the event originated from.

    • setTarget

      public void setTarget(Actor targetActor)

    • getListenerActor

      public Actor getListenerActor()
      Returns the actor that this listener is attached to.

    • setListenerActor

      public void setListenerActor(Actor listenerActor)

    • getBubbles

      public boolean getBubbles()

    • setBubbles

      public void setBubbles(boolean bubbles)
      If true, after the event is fired on the target actor, it will also be fired on each of the parent actors, all the way to the root.

    • isHandled

      public boolean isHandled()
      handle()

    • isStopped

      public boolean isStopped()
      See Also:

    • isHalted

      public boolean isHalted()

    • isCancelled

      public boolean isCancelled()
      See Also:

    • setCapture

      public void setCapture(boolean capture)

    • isCapture

      public boolean isCapture()
      If true, the event was fired during the capture phase.
      See Also:

    • setStage

      public void setStage(Stage stage)

    • getStage

      public Stage getStage()
      The stage for the actor the event was fired on.