Modifier and Type	Class and Description
public static class	Controller.PortType Common controller port types.
public static class	Controller.Type Types of controller objects.

Method Summary

Modifier and Type	Method and Description
public Component	getComponent(Component.Identifier id) Returns a single axis based on its type, or null if no axis with the specified type could be found.
public Component[]	getComponents() Returns the components on this controller, in order of assignment priority.
public Controller[]	getControllers() Returns the controllers connected to make up this controller, or an empty array if this controller contains no child controllers.
public EventQueue	getEventQueue() Get the device event queue
public String	getName() Returns a human-readable name for this Controller.
public int	getPortNumber() Returns the zero-based port number for this Controller.
public Controller.PortType	getPortType() Returns the port type for this Controller.
public Rumbler[]	getRumblers() Returns the rumblers for sending feedback to this controller, or an empty array if there are no rumblers on this controller.
public Controller.Type	getType() Returns the type of the Controller.
public boolean	poll() Polls axes for data.
public void	setEventQueueSize(int size) Initialized the controller event queue to a new size.

Method Detail

getComponent	back to summary
public Component getComponent(Component.Identifier id) Returns a single axis based on its type, or null if no axis with the specified type could be found.

getComponents	back to summary
public Component[] getComponents() Returns the components on this controller, in order of assignment priority. For example, the button controller on a mouse returns an array containing the primary or leftmost mouse button, followed by the secondary or rightmost mouse button (if present), followed by the middle mouse button (if present). The array returned is an empty array if this controller contains no components (such as a logical grouping of child controllers).

getComponents

back to summary

public Component[] getComponents()

Returns the components on this controller, in order of assignment priority. For example, the button controller on a mouse returns an array containing the primary or leftmost mouse button, followed by the secondary or rightmost mouse button (if present), followed by the middle mouse button (if present). The array returned is an empty array if this controller contains no components (such as a logical grouping of child controllers).

getControllers	back to summary
public Controller[] getControllers() Returns the controllers connected to make up this controller, or an empty array if this controller contains no child controllers. The objects in the array are returned in order of assignment priority (primary stick, secondary buttons, etc.).

getEventQueue	back to summary
public EventQueue getEventQueue() Get the device event queue

getName	back to summary
public String getName() Returns a human-readable name for this Controller.

getPortNumber	back to summary
public int getPortNumber() Returns the zero-based port number for this Controller.

getPortType	back to summary
public Controller.PortType getPortType() Returns the port type for this Controller.

getRumblers	back to summary
public Rumbler[] getRumblers() Returns the rumblers for sending feedback to this controller, or an empty array if there are no rumblers on this controller.

getType	back to summary
public Controller.Type getType() Returns the type of the Controller.

poll	back to summary
public boolean poll() Polls axes for data. Returns false if the controller is no longer valid. Polling reflects the current state of the device when polled.

setEventQueueSize	back to summary
public void setEventQueueSize(int size) Initialized the controller event queue to a new size. Existing events in the queue are lost.

net.java.games.input back to summary

public final Class Controller.PortType

Class Inheritance

extends Object

java.lang.Object
net.java.games.input.Controller.PortType

Common controller port types.

Field Summary

Modifier and Type	Field and Description
public static final Controller.PortType	GAME Standard game port
public static final Controller.PortType	I8042 i8042
private final String	name Name of port type
public static final Controller.PortType	NETWORK Network port
public static final Controller.PortType	PARALLEL Parallel port
public static final Controller.PortType	SERIAL Serial port
public static final Controller.PortType	UNKNOWN Unknown port type
public static final Controller.PortType	USB USB port

Constructor Summary

Access	Constructor and Description
protected	PortType(String name) Protected constructor

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this port type.

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

Field Detail

GAME	back to summary
public static final Controller.PortType GAME Standard game port

I8042	back to summary
public static final Controller.PortType I8042 i8042

name	back to summary
private final String name Name of port type

NETWORK	back to summary
public static final Controller.PortType NETWORK Network port

PARALLEL	back to summary
public static final Controller.PortType PARALLEL Parallel port

SERIAL	back to summary
public static final Controller.PortType SERIAL Serial port

UNKNOWN	back to summary
public static final Controller.PortType UNKNOWN Unknown port type

USB	back to summary
public static final Controller.PortType USB USB port

Constructor Detail

PortType	back to summary
protected PortType(String name) Protected constructor

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this port type. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a non-localized string description of this port type.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

net.java.games.input back to summary

public Class Controller.Type

Class Inheritance

extends Object

java.lang.Object
net.java.games.input.Controller.Type

Types of controller objects.

Field Summary

Modifier and Type	Field and Description
public static final Controller.Type	FINGERSTICK Fingerstick controller; note that this may be sometimes treated as a type of mouse or stick.
public static final Controller.Type	GAMEPAD Gamepad controller.
public static final Controller.Type	HEADTRACKER Headtracker controller.
public static final Controller.Type	KEYBOARD A keyboard controller
public static final Controller.Type	MOUSE Mouse controller.
private final String	name Name of controller type
public static final Controller.Type	RUDDER Rudder controller.
public static final Controller.Type	STICK Stick controller, such as a joystick or flightstick.
public static final Controller.Type	TRACKBALL A trackball controller; note that this may sometimes be treated as a type of mouse.
public static final Controller.Type	TRACKPAD A trackpad, such as a tablet, touchpad, or glidepad; note that this may sometimes be treated as a type of mouse.
public static final Controller.Type	UNKNOWN Unkown controller type.
public static final Controller.Type	WHEEL A wheel controller, such as a steering wheel (note that a mouse wheel is considered part of a mouse, not a wheel controller).

Constructor Summary

Access	Constructor and Description
protected	Type(String name) Protected constructor

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this controller type.

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

Field Detail

FINGERSTICK	back to summary
public static final Controller.Type FINGERSTICK Fingerstick controller; note that this may be sometimes treated as a type of mouse or stick.

GAMEPAD	back to summary
public static final Controller.Type GAMEPAD Gamepad controller.

HEADTRACKER	back to summary
public static final Controller.Type HEADTRACKER Headtracker controller.

KEYBOARD	back to summary
public static final Controller.Type KEYBOARD A keyboard controller

MOUSE	back to summary
public static final Controller.Type MOUSE Mouse controller.

name	back to summary
private final String name Name of controller type

RUDDER	back to summary
public static final Controller.Type RUDDER Rudder controller.

STICK	back to summary
public static final Controller.Type STICK Stick controller, such as a joystick or flightstick.

TRACKBALL	back to summary
public static final Controller.Type TRACKBALL A trackball controller; note that this may sometimes be treated as a type of mouse.

TRACKPAD	back to summary
public static final Controller.Type TRACKPAD A trackpad, such as a tablet, touchpad, or glidepad; note that this may sometimes be treated as a type of mouse.

UNKNOWN	back to summary
public static final Controller.Type UNKNOWN Unkown controller type.

WHEEL	back to summary
public static final Controller.Type WHEEL A wheel controller, such as a steering wheel (note that a mouse wheel is considered part of a mouse, not a wheel controller).

Constructor Detail

Type	back to summary
protected Type(String name) Protected constructor

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a non-localized string description of this controller type. Returns:String Doc from java.lang.Object.toString. a string representation of the object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a non-localized string description of this controller type.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

public Interface Controller

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class Controller.PortType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Controller.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail