1 package org.newdawn.slick;
2
3 /**
4 * Description of any class capable of receiving and controlling it's own
5 * reception of input.
6 *
7 * You'll shouldn't really need to implement this one for your self, use one of the sub-interfaces:
8 *
9 * {@link org.newdawn.slick.InputListener}
10 * {@link org.newdawn.slick.MouseListener}
11 * {@link org.newdawn.slick.KeyListener}
12 * {@link org.newdawn.slick.ControllerListener}
13 *
14 * @author kevin
15 */
16 public interface ControlledInputReceiver {
17
18 /**
19 * Set the input that events are being sent from.
20 *
21 * @param input The input instance sending events
22 */
23 public abstract void setInput(Input input);
24
25 /**
26 * Check if this input listener is accepting input.
27 *
28 * @return True if the input listener should receive events
29 */
30 public abstract boolean isAcceptingInput();
31
32 /**
33 * Notification that all input events have been sent for this frame.
34 */
35 public abstract void inputEnded();
36
37 /**
38 * Notification that input is about to be processed.
39 */
40 public abstract void inputStarted();
41
42 }