com.sun.dtv.ui
Class Mouse

java.lang.Object
  com.sun.dtv.ui.UserInputDevice
      com.sun.dtv.ui.Mouse

public class Mouse
extends UserInputDevice

This class represents a mouse which can be used to control a particular Screen as an UserInputDevice.

Constructor Summary

protected

Mouse() It should not be possible to create a Mouse for everybody.

Method Summary

UserInputEvent	getInitiatedEvent(int code) Implements abstract method UserInputDevice.getInitiatedEvent(int) defined in UserInputDevice.
boolean	isSupported(int mouseCode) Indicates whether the specified mouse code is supported by this particular input device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mouse

protected Mouse()

It should not be possible to create a Mouse for everybody. As any UserInputDevice, it is bound to a Screen.

Method Detail

getInitiatedEvent

public UserInputEvent getInitiatedEvent(int code)
                                 throws IllegalArgumentException

Implements abstract method UserInputDevice.getInitiatedEvent(int) defined in UserInputDevice.

Specified by:

getInitiatedEvent in class UserInputDevice

Parameters:

code - the code the input event is initiated for if put in This has to be one of the following: MouseEvent.MOUSE_LEFT_CLICK, MouseEvent.MOUSE_RIGHT_CLICK, MouseEvent.MOUSE_LEFT_PRESS, MouseEvent.MOUSE_RIGHT_PRESS, MouseEvent.MOUSE_LEFT_RELEASE, MouseEvent.MOUSE_RIGHT_RELEASE, MouseEvent.MOUSE_MOVE, MouseEvent.MOUSE_DRAG, MouseEvent.MOUSE_ENTER or MouseEvent.MOUSE_EXIT.

Returns:

the initiated input event

Throws:

IllegalArgumentException - if the specified code is not supported by this InputDevice; always thrown if the code is not one of the codes mentioned in the description of the code parameter

isSupported

public boolean isSupported(int mouseCode)

Indicates whether the specified mouse code is supported by this particular input device.

Parameters:

mouseCode - the mouse code to be checked Any of the following codes may be supported or not: MouseEvent.MOUSE_LEFT_CLICK, MouseEvent.MOUSE_RIGHT_CLICK, MouseEvent.MOUSE_LEFT_PRESS, MouseEvent.MOUSE_RIGHT_PRESS, MouseEvent.MOUSE_LEFT_RELEASE, MouseEvent.MOUSE_RIGHT_RELEASE, MouseEvent.MOUSE_MOVE, MouseEvent.MOUSE_DRAG, MouseEvent.MOUSE_ENTER or MouseEvent.MOUSE_EXIT. Any other code won't be supported and will always produce false.

Returns:

true if the mouse code is supported by this particular input device, false otherwise