javax.microedition.lcdui.game
Class LayerManager

java.lang.Object
  extended by javax.microedition.lcdui.game.LayerManager

public class LayerManager
extends Object

The LayerManager manages a series of Layers. The LayerManager simplifies the process of rendering the Layers that have been added to it by automatically rendering the correct regions of each Layer in the appropriate order.

The LayerManager maintains an ordered list to which Layers can be appended, inserted and removed. A Layer's index correlates to its z-order; the layer at index 0 is closest to the user while a the Layer with the highest index is furthest away from the user. The indices are always contiguous; that is, if a Layer is removed, the indices of subsequent Layers will be adjusted to maintain continuity.

The LayerManager class provides several features that control how the game's Layers are rendered on the screen.

The view window controls the size of the visible region and its position relative to the LayerManager's coordinate system. Changing the position of the view window enables effects such as scrolling or panning the user's view. For example, to scroll to the right, simply move the view window's location to the right. The size of the view window controls how large the user's view will be, and is usually fixed at a size that is appropriate for the device's screen.

In this example, the view window is set to 85 x 85 pixels and is located at (52, 11) in the LayerManager's coordinate system. The Layers appear at their respective positions relative to the LayerManager's origin.

Specifying the View Window

The LayerManager.paint(Graphics, int, int) method includes an (x,y) location that controls where the view window is rendered relative to the screen. Changing these parameters does not change the contents of the view window, it simply changes the location where the view window is drawn. Note that this location is relative to the origin of the Graphics object, and thus it is subject to the translation attributes of the Graphics object.

For example, if a game uses the top of the screen to display the current score, the view window may be rendered at (17, 17) to provide enough space for the score.

Drawing the View Window

Since:
BlackBerry API 4.0.0, MIDP 2.0

Constructor Summary
LayerManager()
          Creates a new LayerManager.
 
Method Summary
 void append(Layer l)
          Appends a Layer to this LayerManager.
 Layer getLayerAt(int index)
          Gets the Layer with the specified index.
 int getSize()
          Gets the number of Layers in this LayerManager.
 void insert(Layer l, int index)
          Inserts a new Layer in this LayerManager at the specified index.
 void paint(Graphics g, int x, int y)
          Renders the LayerManager's current view window at the specified location.
 void remove(Layer l)
          Removes the specified Layer from this LayerManager.
 void setViewWindow(int x, int y, int width, int height)
          Sets the view window on the LayerManager.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

LayerManager

public LayerManager()
Creates a new LayerManager.

Since:
BlackBerry API 4.0.0


Method Detail

append

public void append(Layer l)
Appends a Layer to this LayerManager. The Layer is appended to the list of existing Layers such that it has the highest index (i.e. it is furthest away from the user). The Layer is first removed from this LayerManager if it has already been added.

Parameters:
l - the Layer to be added
Throws:
NullPointerException - if the Layer is null
See Also:
LayerManager.insert(Layer, int), LayerManager.remove(Layer)
Since:
BlackBerry API 4.0.0

insert

public void insert(Layer l,
                   int index)
Inserts a new Layer in this LayerManager at the specified index. The Layer is first removed from this LayerManager if it has already been added.

Parameters:
l - the Layer to be inserted
index - the index at which the new Layer is to be inserted
Throws:
NullPointerException - if the Layer is null
IndexOutOfBoundsException - if the index is less than 0 or greater than the number of Layers already added to the this LayerManager
See Also:
LayerManager.append(Layer), LayerManager.remove(Layer)
Since:
BlackBerry API 4.0.0

getLayerAt

public Layer getLayerAt(int index)
Gets the Layer with the specified index.

Parameters:
index - the index of the desired Layer
Returns:
the Layer that has the specified index
Throws:
IndexOutOfBoundsException - if the specified index is less than zero, or if it is equal to or greater than the number of Layers added to the this LayerManager
Since:
BlackBerry API 4.0.0

getSize

public int getSize()
Gets the number of Layers in this LayerManager.

Returns:
the number of Layers
Since:
BlackBerry API 4.0.0

remove

public void remove(Layer l)
Removes the specified Layer from this LayerManager. This method does nothing if the specified Layer is not added to the this LayerManager.

Parameters:
l - the Layer to be removed
Throws:
NullPointerException - if the specified Layer is null
See Also:
LayerManager.append(Layer), LayerManager.insert(Layer, int)
Since:
BlackBerry API 4.0.0

paint

public void paint(Graphics g,
                  int x,
                  int y)
Renders the LayerManager's current view window at the specified location.

The LayerManager renders each of its layers in order of descending index, thereby implementing the correct z-order. Layers that are completely outside of the view window are not rendered.

The coordinates passed to this method determine where the LayerManager's view window will be rendered relative to the origin of the Graphics object. For example, a game may use the top of the screen to display the current score, so to render the game's layers below that area, the view window might be rendered at (0, 20). The location is relative to the Graphics object's origin, so translating the Graphics object will change where the view window is rendered on the screen.

The clip region of the Graphics object is intersected with a region having the same dimensions as the view window and located at (x,y). The LayerManager then translates the graphics object such that the point (x,y) corresponds to the location of the viewWindow in the coordinate system of the LayerManager. The Layers are then rendered in the appropriate order. The translation and clip region of the Graphics object are restored to their prior values before this method returns.

Rendering is subject to the clip region and translation of the Graphics object. Thus, only part of the specified view window may be rendered if the clip region is not large enough.

For performance reasons, this method may ignore Layers that are invisible or that would be rendered entirely outside of the Graphics object's clip region. The attributes of the Graphics object are not restored to a known state between calls to the Layers' paint methods. The clip region may extend beyond the bounds of a Layer; it is the responsibility of the Layer to ensure that rendering operations are performed within its bounds.

Parameters:
g - the graphics instance with which to draw the LayerManager
x - the horizontal location at which to render the view window, relative to the Graphics' translated origin
y - the vertical location at which to render the view window, relative to the Graphics' translated origin
Throws:
NullPointerException - if g is null
See Also:
LayerManager.setViewWindow(int, int, int, int)
Since:
BlackBerry API 4.0.0

setViewWindow

public void setViewWindow(int x,
                          int y,
                          int width,
                          int height)
Sets the view window on the LayerManager.

The view window specifies the region that the LayerManager draws when its LayerManager.paint(javax.microedition.lcdui.Graphics, int, int) method is called. It allows the developer to control the size of the visible region, as well as the location of the view window relative to the LayerManager's coordinate system.

The view window stays in effect until it is modified by another call to this method. By default, the view window is located at (0,0) in the LayerManager's coordinate system and its width and height are both set to Integer.MAX_VALUE.

Parameters:
x - the horizontal location of the view window relative to the LayerManager's origin
y - the vertical location of the view window relative to the LayerManager's origin
width - the width of the view window
height - the height of the view window
Throws:
IllegalArgumentException - if the width or height is less than 0
Since:
BlackBerry API 4.0.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.