ej.microui.display

Interface MicroUIGraphicsContext

All Superinterfaces:

MicroUIImage

public interface MicroUIGraphicsContext
extends MicroUIImage

Represents a MicroUI GraphicsContext.

This interface is used by all drawing functions to target the destination. It can be mapped on byte array given as parameter in MicroUI natives. This byte array is retrieved in MicroEJ application using the method GraphicsContext.getSNIContext().

See Also:

LLUIDisplay.mapMicroUIGraphicsContext(byte[]), LLUIDisplay.newMicroUIGraphicsContext(byte[])

Method Summary

Modifier and Type	Method and Description
void	configureClip(boolean enable) Enables or disables the graphics context clip.
int	getAndClearDrawingLogFlags() Gets and clears the drawing log flags from a graphics context.
int	getClipX1()
int	getClipX2()
int	getClipY1()
int	getClipY2()
int	getEllipsisWidth() Tells if the ellipsis is enabled or not.
int	getMicroUIColor() Returns the current MicroUI drawing color to use to perform drawings.
int	getRenderingColor() Returns the color to use to render the drawings.
void	intersectClip(int x, int y, int width, int height) Combines the given clipping rectangle with the clipping area of this graphics context.
boolean	isClipEnabled() Tells if the clip is enabled or not.
boolean	isHorizontalLineInClip(int x1, int x2, int y) Tells if given horizontal line fully fits the clip or not.
boolean	isPointInClip(int x, int y) Tells if given point fits the clip or not.
boolean	isRectangleInClip(int x1, int y1, int x2, int y2) Tells if given rectangle fully fits the clip or not.
boolean	isRegionInClip(int x, int y, int width, int height) Tells if given region (from x,y to x+width-1,y+height-1) fully fits the clip or not.
boolean	isVerticalLineInClip(int y1, int y2, int x) Tells if given vertical line fully fits the clip or not.
boolean	regionsOverlap(MicroUIImage img, int regionX, int regionY, int width, int height, int destX, int destY) Tells if source and destination share a region.
void	reportError(int flags) Reports errors occurring during a drawing operation.
void	reportWarning(int flags) Reports non-critical incidents occurring during a drawing operation.
boolean	requestDrawing() Requests a drawing on the graphics context.
void	setClip(int x, int y, int width, int height) Sets the clip.
void	setMicroUIColor(int color) Sets the current MicroUI drawing color to use to perform drawings.

Methods inherited from interface ej.microui.display.MicroUIImage

getFormat, getHeight, getIdentifier, getImage, getImage, getWidth, isClosed, isLCD, isMutable, readPixel, requestReading

Method Detail

getMicroUIColor

int getMicroUIColor()

Returns the current MicroUI drawing color to use to perform drawings.

Returns:

a color in 0xAARRGGBB format (where alpha level is always 0xff == fully opaque).

setMicroUIColor

void setMicroUIColor(int color)

Sets the current MicroUI drawing color to use to perform drawings.

Beware that calling this method alters the color in the GraphicsContext instance manipulated by the Java user. The caller must save the color before modifying it and restore it afterwards.

Parameters:

color - in 0xAARRGGBB format (where alpha level is always 0xff == fully opaque).

getRenderingColor

int getRenderingColor()

Returns the color to use to render the drawings. This color takes in consideration the embedded display pixel representation constraints.

Equivalent of LLUIDisplay.Instance.convertARGBColorToColorToDraw(getMicroUIColor());

Returns:

the color to use to render the drawings in 0xAARRGGBB format (where alpha level is always 0xff == fully opaque).

See Also:

LLUIDisplay.convertARGBColorToColorToDraw(int)

getClipX1

int getClipX1()

Returns:

top-left X coordinate of current clip.

getClipY1

int getClipY1()

Returns:

top-left Y coordinate of current clip.

getClipX2

int getClipX2()

Returns:

bottom-right X coordinate of current clip.

getClipY2

int getClipY2()

Returns:

bottom-right Y coordinate of current clip.

setClip

void setClip(int x,
             int y,
             int width,
             int height)

Sets the clip.

Make sure that the clip is enabled for this call to be efficient.

Beware that calling this method alters the clip in the GraphicsContext instance manipulated by the Java user. The caller must save the clip before modifying it and restore it afterwards.

Parameters:

x - top-left X coordinate of the clip.

y - top-left Y coordinate of the clip.

width - width of the clip.

height - height of the clip.

See Also:

configureClip(boolean), isClipEnabled()

intersectClip

void intersectClip(int x,
                   int y,
                   int width,
                   int height)

Combines the given clipping rectangle with the clipping area of this graphics context.

This method sets the clipping area to be the intersection of the given rectangle with the current clipping area.

Make sure that the clip is enabled for this call to be efficient.

Beware that calling this method alters the clip in the GraphicsContext instance manipulated by the Java user. The caller must save the clip before modifying it and restore it afterwards.

Parameters:

x - top-left X coordinate of the clip.

y - top-left Y coordinate of the clip.

width - width of the clip.

height - height of the clip.

See Also:

configureClip(boolean), isClipEnabled()

configureClip

void configureClip(boolean enable)

Enables or disables the graphics context clip. Useful to ignore clip during a drawing. The clip is automatically re-enabled when calling requestDrawing().

Parameters:

enable - false to disable the clip.

isClipEnabled

boolean isClipEnabled()

Tells if the clip is enabled or not. This call should be performed at the beginning of a drawing function in order to prevent to make some useless operations when the clip is disabled.

When it is disabled, that means the caller considers the drawing is fitting the clip. In this case checking the clip bounds is useless.

Returns:

true when the clip is enabled (the clip must be checked).

isPointInClip

boolean isPointInClip(int x,
                      int y)

Tells if given point fits the clip or not.

Parameters:

x - the pixel X coordinate.

y - the pixel Y coordinate.

Returns:

false when the point is outside the clip.

isHorizontalLineInClip

boolean isHorizontalLineInClip(int x1,
                               int x2,
                               int y)

Tells if given horizontal line fully fits the clip or not.

Parameters:

x1 - the first pixel line X coordinate.

x2 - the last pixel line X coordinate.

y - the both pixels line Y coordinate.

Returns:

false when the line is fully or partially outside the clip, true when line fully fits the clip (clip can be disabled).

isVerticalLineInClip

boolean isVerticalLineInClip(int y1,
                             int y2,
                             int x)

Tells if given vertical line fully fits the clip or not.

Parameters:

x - the both pixels line X coordinate.

y1 - the first pixel line Y coordinate.

y2 - the last pixel line Y coordinate.

Returns:

false when the line is fully or partially outside the clip, true when line fully fits the clip (clip can be disabled).

isRectangleInClip

boolean isRectangleInClip(int x1,
                          int y1,
                          int x2,
                          int y2)

Tells if given rectangle fully fits the clip or not.

Parameters:

x1 - the top-left pixel X coordinate.

y1 - the top-left pixel Y coordinate.

x2 - the bottom-right pixel X coordinate.

y2 - the top-right pixel Y coordinate.

Returns:

false when the rectangle is fully or partially outside the clip, true when rectangle fully fits the clip (clip can be disabled).

isRegionInClip

boolean isRegionInClip(int x,
                       int y,
                       int width,
                       int height)

Tells if given region (from x,y to x+width-1,y+height-1) fully fits the clip or not.

Parameters:

x - the top-left pixel X coordinate.

y - the top-left pixel Y coordinate.

width - the region width.

height - the region height.

Returns:

false when the region is fully or partially outside the clip, true when region fully fits the clip (clip can be disabled).

regionsOverlap

boolean regionsOverlap(MicroUIImage img,
                       int regionX,
                       int regionY,
                       int width,
                       int height,
                       int destX,
                       int destY)

Tells if source and destination share a region. Source and destination can share a region if and only if source and destination target the same MicroUI Image. In that case, this function checks if there is an intersection of source and destination regions. This function is useful when drawing an image on same image.

Parameters:

gc - the MicroUI GraphicsContext target of destination.

img - the MicroUI Image to draw.

regionX - the x coordinate of the upper-left corner of the region to check.

regionY - the y coordinate of the upper-left corner of the region to check.

width - the width of the region to check.

height - the height of the region to check.

destX - the x coordinate of the top-left point in the destination.

destY - the y coordinate of the top-left point in the destination.

Returns:

true when source and destination are same image and when destination region intersects source region.

getEllipsisWidth

int getEllipsisWidth()

Tells if the ellipsis is enabled or not. Returns 0 when ellipsis is disabled, a positive value otherwise. This value is the maximum string width in pixels. If string width is higher than this value, an ellipsis will be drawn to crop the string.

Returns:

the ellipsis width or 0.

getAndClearDrawingLogFlags

int getAndClearDrawingLogFlags()

Gets and clears the drawing log flags from a graphics context. The flags are reset to their success value after retrieving their value.

Parameters:

sd - the graphics context

Returns:

the drawing log flags

reportWarning

void reportWarning(int flags)

Reports non-critical incidents occurring during a drawing operation. This will set flags into the drawing log flags.

Parameters:

context - the graphics context in which the incidents occurred

flags - the flags to set

reportError

void reportError(int flags)

Reports errors occurring during a drawing operation. This will set flags into the drawing log flags. This will additionally set the DRAWING_LOG_ERROR flag, causing an exception to be thrown in the application when checking the flags.

Parameters:

context - the graphics context in which the errors occurred

flags - the flags to set

requestDrawing

boolean requestDrawing()

Requests a drawing on the graphics context.

Returns:

true if drawing can be performed, false when the drawing does not need to be done for any reason.