ej.fp.widget.display

Class DisplayBufferManager

java.lang.Object

ej.fp.widget.display.DisplayBufferManager

All Implemented Interfaces:

ej.fp.Image

public class DisplayBufferManager
extends java.lang.Object
implements ej.fp.Image

The display buffer manager is responsible of the drawings and flushing on the right buffer(s).

Constructor Summary

Constructors

Constructor and Description
DisplayBufferManager(DisplayBufferPolicy bufferPolicy, BufferRefreshStrategy refreshStrategy, ej.fp.Widget displayWidget, int displayWidth, int displayHeight, int initialColor) Creates a buffer manager.

Method Summary

Modifier and Type	Method and Description
void	crop(ej.fp.Image mask)
void	dispose()
void	drawImage(ej.fp.Image image, int sx, int sy, int sWidth, int sHeight, int dx, int dy, int dWidth, int dHeight)
void	drawLine(int x1, int y1, int x2, int y2, int color)
void	drawPixel(int x, int y, int color)
void	drawRectangle(int x, int y, int width, int height, int color)
void	drawString(java.lang.String s, int x, int y, int textColor, int backColor)
void	drawTransparentImage(ej.fp.Image image, byte alpha, int sx, int sy, int sWidth, int sHeight, int dx, int dy, int dWidth, int dHeight)
void	fillOval(int x, int y, int width, int height, int color)
void	fillRectangle(int x, int y, int width, int height, int color)
void	fillTransparentRectangle(int x, int y, int width, int height, int argbColor)
void	flush() Flushes a part of the display limited by the specified bounds when the display is double buffered.
void	flush(ej.microui.display.Rectangle[] rectangles) Flushes the display with the help of the given rectangles.
ej.fp.Image	getCurrentBackBuffer() Gets the current drawing buffer.
ej.fp.Image	getDisplayImage() Gets the display image.
int	getHeight()
java.lang.Object	getMonitor() Gets the monitor.
void	getPixels(int[] pixels)
java.lang.Object	getRAWImage()
ej.fp.Image	getTransparentImage(byte alpha)
int	getWidth()
boolean	isCleanBuffer() Tells whether the buffer is clean (if nothing is drawn since flush) or not.
boolean	isDoubleBuffered() Gets whether or not there are several buffers for the display.
void	newDrawingRegion(int x1, int y1, int x2, int y2, boolean drawingNow) Called before a drawing is done.
int	readPixel(int x, int y)
void	restore(ej.microui.display.Rectangle rectangle) Restores (copies) the given rectangular region from old back buffer to the graphics context's current buffer.
void	setFlushTime(int ms) Simulates the embedded display's flush time when double buffering mode is enabled.
void	setPixels(int[] pixels)
void	setRefreshTime(int ms) Simulates the embedded display's refresh rate when double buffering mode is enabled.
void	setTransparentMode(boolean transparent)
void	simulateFlushTime() Simulates the flush time.
void	waitFlush() Simulates the waiting of end of an asynchronous flush when the display is double buffered.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ej.fp.Image

drawImage, drawImage

Constructor Detail

DisplayBufferManager

public DisplayBufferManager(DisplayBufferPolicy bufferPolicy,
                            BufferRefreshStrategy refreshStrategy,
                            ej.fp.Widget displayWidget,
                            int displayWidth,
                            int displayHeight,
                            int initialColor)

Creates a buffer manager.

Method Detail

isDoubleBuffered

public boolean isDoubleBuffered()

Gets whether or not there are several buffers for the display.

In other words, if the drawings are done in a buffer different than the one used by the display or not.

Returns:

true if there is more than one buffer, false otherwise.

getMonitor

public java.lang.Object getMonitor()

Gets the monitor.

Returns:

the monitor.

getDisplayImage

public ej.fp.Image getDisplayImage()

Gets the display image.

Returns:

the display image.

getCurrentBackBuffer

public ej.fp.Image getCurrentBackBuffer()

Gets the current drawing buffer.

Returns:

the current drawing buffer.

flush

public void flush()

Flushes a part of the display limited by the specified bounds when the display is double buffered.

waitFlush

public void waitFlush()

Simulates the waiting of end of an asynchronous flush when the display is double buffered. When the call to flush() performs a synchronous flush, this method should stay empty because there is nothing to wait (implementation). When the call to flush() performs an asynchronous flush (to simulate the same behavior than embedded side): this method is useful to wait the end of this asynchronous flush. If the display does not have a backBuffer (not double buffered), nothing is done. This method should stay empty.

flush

public void flush(ej.microui.display.Rectangle[] rectangles)

Flushes the display with the help of the given rectangles.

Parameters:

rectangles - the modified rectangles.

restore

public void restore(ej.microui.display.Rectangle rectangle)

Restores (copies) the given rectangular region from old back buffer to the graphics context's current buffer.

Parameters:

rectangle - the rectangle to restore.

isCleanBuffer

public boolean isCleanBuffer()

Tells whether the buffer is clean (if nothing is drawn since flush) or not.

Returns:

true if nothing has been drawn since flush, false otherwise.

setFlushTime

public void setFlushTime(int ms)

Simulates the embedded display's flush time when double buffering mode is enabled.

The buffer manager will wait this time before unlocking the caller to waitFlush().

The time is expressed in milliseconds. A negative or zero value (value) indicates the flush time is instantaneous. Typical values are between 5 and 10ms.

Parameters:

ms - the flush time in milliseconds.

setRefreshTime

public void setRefreshTime(int ms)

Simulates the embedded display's refresh rate when double buffering mode is enabled.

When set, the widget is only allowed to initiate a flush action at every refresh tick. It is synchronized on the hardware display's periodic signal (tearing).

Parameters:

ms - the refresh time in ms.

simulateFlushTime

public void simulateFlushTime()

Simulates the flush time.

newDrawingRegion

public void newDrawingRegion(int x1,
                             int y1,
                             int x2,
                             int y2,
                             boolean drawingNow)

Called before a drawing is done.

Parameters:

x1 - the dirty region left x coordinate

y1 - the dirty region top y coordinate

x2 - the dirty region right y coordinate

y2 - the dirty region bottom y coordinate

drawingNow - true if a drawing is following this call, false otherwise.

getWidth

public int getWidth()

Specified by:

getWidth in interface ej.fp.Image

getHeight

public int getHeight()

Specified by:

getHeight in interface ej.fp.Image

setPixels

public void setPixels(int[] pixels)

Specified by:

setPixels in interface ej.fp.Image

readPixel

public int readPixel(int x,
                     int y)

Specified by:

readPixel in interface ej.fp.Image

drawPixel

public void drawPixel(int x,
                      int y,
                      int color)

Specified by:

drawPixel in interface ej.fp.Image

fillRectangle

public void fillRectangle(int x,
                          int y,
                          int width,
                          int height,
                          int color)

Specified by:

fillRectangle in interface ej.fp.Image

getTransparentImage

public ej.fp.Image getTransparentImage(byte alpha)

Specified by:

getTransparentImage in interface ej.fp.Image

getRAWImage

public java.lang.Object getRAWImage()

Specified by:

getRAWImage in interface ej.fp.Image

getPixels

public void getPixels(int[] pixels)

Specified by:

getPixels in interface ej.fp.Image

fillTransparentRectangle

public void fillTransparentRectangle(int x,
                                     int y,
                                     int width,
                                     int height,
                                     int argbColor)

Specified by:

fillTransparentRectangle in interface ej.fp.Image

fillOval

public void fillOval(int x,
                     int y,
                     int width,
                     int height,
                     int color)

Specified by:

fillOval in interface ej.fp.Image

drawTransparentImage

public void drawTransparentImage(ej.fp.Image image,
                                 byte alpha,
                                 int sx,
                                 int sy,
                                 int sWidth,
                                 int sHeight,
                                 int dx,
                                 int dy,
                                 int dWidth,
                                 int dHeight)

Specified by:

drawTransparentImage in interface ej.fp.Image

drawString

public void drawString(java.lang.String s,
                       int x,
                       int y,
                       int textColor,
                       int backColor)

Specified by:

drawString in interface ej.fp.Image

drawRectangle

public void drawRectangle(int x,
                          int y,
                          int width,
                          int height,
                          int color)

Specified by:

drawRectangle in interface ej.fp.Image

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2,
                     int color)

Specified by:

drawLine in interface ej.fp.Image

drawImage

public void drawImage(ej.fp.Image image,
                      int sx,
                      int sy,
                      int sWidth,
                      int sHeight,
                      int dx,
                      int dy,
                      int dWidth,
                      int dHeight)

Specified by:

drawImage in interface ej.fp.Image

setTransparentMode

public void setTransparentMode(boolean transparent)

Specified by:

setTransparentMode in interface ej.fp.Image

crop

public void crop(ej.fp.Image mask)
          throws java.lang.IllegalArgumentException

Specified by:

crop in interface ej.fp.Image

Throws:

java.lang.IllegalArgumentException

dispose

public void dispose()

Specified by:

dispose in interface ej.fp.Image