Top Description Fields Constructors Methods

net.java.games.input

public abstract Class Mouse

Class Inheritance

extends AbstractController

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.

Field Summary

Inherited from net.java.games.input.AbstractController:: EVENT_QUEUE_DEPTH

Constructor Summary

Access	Constructor and Description
protected	Mouse(String name, Component[] components, Controller[] children, Rumbler[] rumblers)

Method Summary

Modifier and Type	Method and Description
public Component	getBack() Returns the back mouse button, null if the mouse hasn't got one.
public Component	getButton3() Returns forth mouse button, null if the mouse hasn't got one.
public Component	getButton4() Returns fifth mouse button, null if the mouse hasn't got one.
public Component	getExtra() Returns the extra or 5th mouse button, null if the mouse has fewer than 5 buttons.
public Component	getForward() Returns the forward mouse button, null if the mouse hasn't got one.
public Component	getLeft() Returns the left mouse button.
public Component	getMiddle() Returns the middle, null if the mouse has fewer than three buttons.
public Component	getPrimaryButton() Returns the left or primary mouse button, never null.
public Component	getRight() Returns the right, null if the mouse is a single-button mouse.
public Component	getSecondaryButton() Returns the right or secondary mouse button, null if the mouse is a single-button mouse.
public Component	getSide() Returns the side or 4th mouse button, null if the mouse has fewer than 4 buttons.
public Component	getTertiaryButton() Returns the middle or tertiary mouse button, null if the mouse has fewer than three buttons.
public Controller.Type	getType() Overrides net.java.games.input.AbstractController.getType. Implements net.java.games.input.Controller.getType. Returns the type of the Controller.
public Component	getWheel() Returns the mouse wheel, or null if no mouse wheel is present.
public Component	getX() Returns the x-axis for the mouse ball, never null.
public Component	getY() Returns the y-axis for the mouse ball, never null.

Inherited from net.java.games.input.AbstractController:: getComponent getComponents getControllers getEventQueue getName getNextDeviceEvent getPortNumber getPortType getRumblers poll pollDevice setDeviceEventQueueSize setEventQueueSize toString

Constructor Detail

Mouse	back to summary
protected Mouse(String name, Component[] components, Controller[] children, Rumbler[] rumblers)

Method Detail

getBack	back to summary
public Component getBack() Returns the back mouse button, null if the mouse hasn't got one.

getButton3	back to summary
public Component getButton3() Returns forth mouse button, null if the mouse hasn't got one.

getButton4	back to summary
public Component getButton4() Returns fifth mouse button, null if the mouse hasn't got one.

getExtra	back to summary
public Component getExtra() Returns the extra or 5th mouse button, null if the mouse has fewer than 5 buttons.

getForward	back to summary
public Component getForward() Returns the forward mouse button, null if the mouse hasn't got one.

getLeft	back to summary
public Component getLeft() Returns the left mouse button.

getMiddle	back to summary
public Component getMiddle() Returns the middle, null if the mouse has fewer than three buttons.

getPrimaryButton	back to summary
public Component getPrimaryButton() Returns the left or primary mouse button, never null.

getRight	back to summary
public Component getRight() Returns the right, null if the mouse is a single-button mouse.

getSecondaryButton	back to summary
public Component getSecondaryButton() Returns the right or secondary mouse button, null if the mouse is a single-button mouse.

getSide	back to summary
public Component getSide() Returns the side or 4th mouse button, null if the mouse has fewer than 4 buttons.

getTertiaryButton	back to summary
public Component getTertiaryButton() Returns the middle or tertiary mouse button, null if the mouse has fewer than three buttons.

getType

back to summary

public Controller.Type getType()

Overrides net.java.games.input.AbstractController.getType.

Implements net.java.games.input.Controller.getType.

Returns the type of the Controller.

getWheel	back to summary
public Component getWheel() Returns the mouse wheel, or null if no mouse wheel is present.

getX	back to summary
public Component getX() Returns the x-axis for the mouse ball, never null.

getY	back to summary
public Component getY() Returns the y-axis for the mouse ball, never null.