ej.microui.display

Interface LLUIPainter.MicroUIGraphicsContext

All Superinterfaces:

LLUIPainter.MicroUIImage

Enclosing class:

LLUIPainter

public static interface LLUIPainter.MicroUIGraphicsContext
extends LLUIPainter.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	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.
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	requestDrawing() Requests a drawing on the graphics context.
boolean	setDrawingLimits(int xmin, int ymin, int xmax, int ymax) Updates the flush dirty area.

Methods inherited from interface ej.microui.display.LLUIPainter.MicroUIImage

getFormat, getHeight, getImage, getWidth, isClosed, isLCD

Method Detail

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.

getClipX1

int getClipX1()

Returns:

top-left X coordinate of current clip.

getClipX2

int getClipX2()

Returns:

bottom-right X coordinate of current clip.

getClipY1

int getClipY1()

Returns:

top-left Y coordinate of current clip.

getClipY2

int getClipY2()

Returns:

bottom-right Y coordinate of current clip.

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.

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).

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)

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).

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).

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.

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).

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).

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.

setDrawingLimits

boolean setDrawingLimits(int xmin,
                         int ymin,
                         int xmax,
                         int ymax)

Updates the flush dirty area. This dirty area will be merged with the current dirty area and given as parameter in LLUIDisplayImpl#flush(MicroUIGraphicsContext, Image, int, int, int, int) method.

This method is useless when the given graphics context is not the display (in this case this call has no effect). Caller should check that calling LLUIPainter.MicroUIImage.isLCD() before.

Parameters:

xmin - the dirty area top-left X coordinate.

ymin - the dirty area top-left Y coordinate.

xmax - the dirty area bottom-right X coordinate.

ymax - the dirty area bottom-right Y coordinate.

Returns:

true when dirty area has been updated or false when the specified dirty area is out of current clip or when the given graphics context does not target the display.