net.rim.device.api.lcdui
Class BlackBerryCanvas

java.lang.Object
  |
  +--javax.microedition.lcdui.Displayable
        |
        +--javax.microedition.lcdui.Canvas
              |
              +--net.rim.device.api.lcdui.BlackBerryCanvas
All Implemented Interfaces:
Controllable, Touchable

public abstract class BlackBerryCanvas
extends Canvas
implements Touchable, Controllable

This class extends the functionality of the Canvas class to include full touch support.

Classes inheriting from this class can override the touchEvent(net.rim.device.api.ui.TouchEvent) method to receive TouchEvent messages.

The BlackBerryCanvas class implements Controllable and can be queried to retrieve BlackBerry-specific Controls. For instance, on devices which support a virtual keyboard, getControl(String) may return a VirtualKeyboardControl object.

Since:
JDE 4.7.0
See Also:
TouchEvent, Field.touchEvent

Field Summary
 
Fields inherited from class javax.microedition.lcdui.Canvas
DOWN, FIRE, GAME_A, GAME_B, GAME_C, GAME_D, KEY_NUM0, KEY_NUM1, KEY_NUM2, KEY_NUM3, KEY_NUM4, KEY_NUM5, KEY_NUM6, KEY_NUM7, KEY_NUM8, KEY_NUM9, KEY_POUND, KEY_STAR, LEFT, RIGHT, UP
 
Constructor Summary
protected BlackBerryCanvas()
          Creates a new instance of a BlackBerryCanvas.
 
Method Summary
 Control getControl(String controlType)
          Obtain the object that implements the specified Control interface.
 Control[] getControls()
          Obtain the collection of Controls from the object that implements this interface.
 void touchEvent(TouchEvent message)
          Indicates a touch event.
 
Methods inherited from class javax.microedition.lcdui.Canvas
getGameAction, getKeyCode, getKeyName, hasPointerEvents, hasPointerMotionEvents, hasRepeatEvents, hideNotify, isDoubleBuffered, keyPressed, keyReleased, keyRepeated, paint, pointerDragged, pointerPressed, pointerReleased, repaint, repaint, serviceRepaints, setFullScreenMode, showNotify, sizeChanged
 
Methods inherited from class javax.microedition.lcdui.Displayable
addCommand, getHeight, getTicker, getTitle, getWidth, isShown, removeCommand, setCommandListener, setTicker, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BlackBerryCanvas

protected BlackBerryCanvas()
Creates a new instance of a BlackBerryCanvas.
Since:
JDE 4.7.0
See Also:
Canvas.Canvas()
Method Detail

getControl

public Control getControl(String controlType)
Description copied from interface: Controllable
Obtain the object that implements the specified Control interface.

If the specified Control interface is not supported then null is returned.

If the Controllable supports multiple objects that implement the same specified Control interface, only one of them will be returned. To obtain all the Control's of that type, use the getControls method and check the list for the requested type.

Throws:
IllegalArgumentException - Thrown if controlType is null.
Since:
JDE 4.7.0
See Also:
javax.microedition.media.Controllable.getControl(String)

getControls

public Control[] getControls()
Description copied from interface: Controllable
Obtain the collection of Controls from the object that implements this interface.

Since a single object can implement multiple Control interfaces, it's necessary to check each object against different Control types. For example:

Controllable controllable;
    :
Control cs[];
cs = controllable.getControls();
for (int i = 0; i < cs.length; i++) {
    if (cs[i] instanceof ControlTypeA)
        doSomethingA();
    if (cs[i] instanceof ControlTypeB)
        doSomethingB();
    // etc.
}

The list of Control objects returned will not contain any duplicates. And the list will not change over time.

If no Control is supported, a zero length array is returned.

Since:
JDE 4.7.0
See Also:
javax.microedition.media.Controllable.getControls()

touchEvent

public void touchEvent(TouchEvent message)
Indicates a touch event.
Parameters:
message - TouchEvent object containing various input parameters including the event type and touch coordinates.
Since:
JDE 4.7.0



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.