net.java.games.input.Mouse Class Reference

Inheritance diagram for net.java.games.input.Mouse:

Public Member Functions
Type	getType ()
Component	getX ()
Component	getY ()
Component	getWheel ()
Component	getLeft ()
Component	getRight ()
Component	getMiddle ()
Component	getSide ()
Component	getExtra ()
Component	getForward ()
Component	getBack ()
Public Member Functions inherited from net.java.games.input.AbstractController
final Controller[]	getControllers ()
final Component[]	getComponents ()
final Component	getComponent (Component.Identifier id)
final Rumbler[]	getRumblers ()
PortType	getPortType ()
int	getPortNumber ()
final String	getName ()
String	toString ()
final void	setEventQueueSize (int size)
final EventQueue	getEventQueue ()
synchronized boolean	poll ()

Protected Member Functions
	Mouse (String name, Component[] components, Controller[] children, Rumbler[] rumblers)
Protected Member Functions inherited from net.java.games.input.AbstractController
	AbstractController (String name, Component[] components, Controller[] children, Rumbler[] rumblers)
void	setDeviceEventQueueSize (int size) throws IOException
abstract boolean	getNextDeviceEvent (Event event) throws IOException
void	pollDevice () throws IOException

Additional Inherited Members
Static Package Attributes inherited from net.java.games.input.AbstractController
static final int	EVENT_QUEUE_DEPTH = 32

Detailed Description

A Mouse is a type of controller consisting of two child controllers, a ball and a button pad. This includes devices such as touch pads, trackballs, and fingersticks.

Member Function Documentation

Component net.java.games.input.Mouse.getBack

(

)

Returns the back mouse button, null if the mouse hasn't got one.

Component net.java.games.input.Mouse.getExtra

(

)

Returns the extra or 5th mouse button, null if the mouse has fewer than 5 buttons.

Component net.java.games.input.Mouse.getForward

(

)

Returns the forward mouse button, null if the mouse hasn't got one.

Component net.java.games.input.Mouse.getLeft

(

)

Returns the left or primary mouse button, never null.

Component net.java.games.input.Mouse.getMiddle

(

)

Returns the middle or tertiary mouse button, null if the mouse has fewer than three buttons.

Component net.java.games.input.Mouse.getRight

(

)

Returns the right or secondary mouse button, null if the mouse is a single-button mouse.

Component net.java.games.input.Mouse.getSide

(

)

Returns the side or 4th mouse button, null if the mouse has fewer than 4 buttons.

Type net.java.games.input.Mouse.getType ( )

virtual

Returns the type of the Controller.

Reimplemented from net.java.games.input.AbstractController.

Component net.java.games.input.Mouse.getWheel

(

)

Returns the mouse wheel, or null if no mouse wheel is present.

Component net.java.games.input.Mouse.getX

(

)

Returns the x-axis for the mouse ball, never null.

Component net.java.games.input.Mouse.getY

(

)

Returns the y-axis for the mouse ball, never null.