libGDX 1.14.2 · com.badlogic.gdx.scenes.scene2d.Event

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().)

Modifier and Type	Field and Description
private boolean	bubbles
private boolean	cancelled
private boolean	capture
private boolean	handled
private Actor	listenerActor
private Stage	stage
private boolean	stopped
private Actor	targetActor

Constructor Summary

Access	Constructor and Description
public	Event()

Method Summary

Modifier and Type	Method and Description
public void	cancel() Marks this event cancelled.
public boolean	getBubbles()
public Actor	getListenerActor() Returns the actor that this listener is attached to.
public Stage	getStage() The stage for the actor the event was fired on.
public Actor	getTarget() Returns the actor that the event originated from.
public void	handle() Marks this event as handled.
public boolean	isCancelled()
public boolean	isCapture() If true, the event was fired during the capture phase.
public boolean	isHandled() `handle()`
public boolean	isStopped()
public void	reset() Implements com.badlogic.gdx.utils.Pool.Poolable.reset. Resets the object for reuse.
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.
public void	setCapture(boolean capture)
public void	setListenerActor(Actor listenerActor)
public void	setStage(Stage stage)
public void	setTarget(Actor targetActor)
public void	stop() Marks this event has being stopped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bubbles	back to summary
private boolean bubbles

cancelled	back to summary
private boolean cancelled

capture	back to summary
private boolean capture

handled	back to summary
private boolean handled

listenerActor	back to summary
private Actor listenerActor

stage	back to summary
private Stage stage

stopped	back to summary
private boolean stopped

targetActor	back to summary
private Actor targetActor

Constructor Detail

Event	back to summary
public Event()

Method Detail

cancel	back to summary
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.

getBubbles	back to summary
public boolean getBubbles()

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

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

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

handle	back to summary
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.

isCancelled	back to summary
public boolean isCancelled() See Also `cancel()`

isCapture back to summary

isCapture	back to summary
public boolean isCapture() If true, the event was fired during the capture phase. See Also `Actor#fire(Event)`

public boolean isCapture()

If true, the event was fired during the capture phase.

See Also: Actor#fire(Event)

isHandled	back to summary
public boolean isHandled() `handle()`

isStopped	back to summary
public boolean isStopped() See Also `stop()`

reset	back to summary
public void reset() Implements com.badlogic.gdx.utils.Pool.Poolable.reset. Doc from com.badlogic.gdx.utils.Pool.Poolable.reset. Resets the object for reuse. Object references should be nulled and fields may be set to default values.

reset

back to summary

public void reset()

Implements com.badlogic.gdx.utils.Pool.Poolable.reset.

Doc from com.badlogic.gdx.utils.Pool.Poolable.reset.

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

setBubbles	back to summary
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.

setCapture	back to summary
public void setCapture(boolean capture)

setListenerActor	back to summary
public void setListenerActor(Actor listenerActor)

setStage	back to summary
public void setStage(Stage stage)

setTarget	back to summary
public void setTarget(Actor targetActor)

stop	back to summary
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.

public Class Event

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail