ej.fp.widget

Class Display

java.lang.Object

ej.fp.Widget

ej.fp.Composite

ej.fp.widget.Display

All Implemented Interfaces:

ej.fp.MouseListener, ej.microui.display.LLUIDisplayImpl, java.lang.Iterable<ej.fp.Widget>

public class Display
extends ej.fp.Composite
implements ej.microui.display.LLUIDisplayImpl, ej.fp.MouseListener

This widget is an implementation of MicroUI LLUIDisplayImpl interface. An implementation of this interface is required to be able to use a MicroUI Display in a MicroEJ application.

This widget has been implemented to target a standard display: a display whose pixel format is MicroUIImageFormat.MICROUI_IMAGE_FORMAT_ARGB8888 , MicroUIImageFormat.MICROUI_IMAGE_FORMAT_RGB888, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_RGB565, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_ARGB1555, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_ARGB4444, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_C4, MicroUIImageFormat.MICROUI_IMAGE_FORMAT_C2 or MicroUIImageFormat.MICROUI_IMAGE_FORMAT_C1. To avoid to create a subclass of this class when the pixel format is custom, an extension of this widget can be set in front panel description file (fp file) using the widget attribute extensionClass.

This widget manages the double buffering mode (see LLUIDisplayImpl.isDoubleBuffered(). However all involved methods by this notion are implemented according the value returned by isDoubleBuffered(). The optional widget attribute doubleBufferFeature can be configured to override default behavior (enabled by default).

When double buffering mode is enabled, this widget uses a third-party thread to simulate the asynchronous flush action. This allows to have the same behavior than embedded side: the next drawing after a flush has to wait a while before be performed. The flush action takes two parameters in consideration: the time to perform the flush itself (== the time to transmit data to the embedded display) and the embedded display's refresh rate. These times are useless when the double buffering mode is disabled.

This widget manages a backlight with dimming (0 to 100%) (see LLUIDisplayImpl.hasBacklight(). However all involved methods by this notion are implemented according the value returned by hasBacklight(). The optional widget attribute backlightFeature can be configured to override default behavior (enabled by default).

The filter image is used to define the display rendering area. Outside this area, the display buffer data is not drawn. This image must have the same size (@see Widget.setWidth(int) and Widget.setHeight(int)) than the widget itself. If not, an error is thrown in finalizeConfiguration().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Display.DisplayExtension This interface is a subset of LLUIDisplayImpl interface (provided by MicroUI graphical engine and required to use a MicroUI Display in a MicroEJ application).

Nested classes/interfaces inherited from class ej.fp.Widget

ej.fp.Widget.WidgetAttribute, ej.fp.Widget.WidgetDescription

Nested classes/interfaces inherited from interface ej.fp.MouseListener

ej.fp.MouseListener.MouseButton

Field Summary

Fields inherited from class ej.fp.Widget

DEFAULT_LABEL

Fields inherited from interface ej.microui.display.LLUIDisplayImpl

BACKLIGHT_MAX, BACKLIGHT_MIN, CONTRAST_MAX, CONTRAST_MIN

Constructor Summary

Constructors

Constructor and Description
Display() Creates the widget display

Method Summary

Modifier and Type	Method and Description
int	convertARGBColorToDisplayColor(int argbColor)
int	convertDisplayColorToARGBColor(int displayColor)
void	dispose()
protected void	drawBacklight(ej.fp.Image imageSkin) Transforms the skin data applying an algorithm to simulate the display backlight.
protected void	drawContrast(ej.fp.Image imageSkin) Transforms the skin data applying an algorithm to simulate the display contrast.
void	finalizeConfiguration()
void	flush()
int	getBacklight() Returns the backlight of the display.
ej.fp.Image	getCurrentBackBuffer()
ej.fp.Image	getCurrentDrawingBuffer()
ej.fp.Image	getCurrentSkin() Gets the current displayed skin.
ej.fp.Image	getDisplayedImage()
int	getDisplayHeight() Gets the display height.
int	getDisplayWidth() Gets the display width.
int	getInitialColor() Gets the initial color of the display.
int	getNumberOfColors()
boolean	hasBacklight()
ej.fp.Image	initialize() Called by MicroUI graphical engine when MicroUI.start() is called by the MicroEJ application.
boolean	isColor()
boolean	isDoubleBuffered()
void	mouseDragged(int x, int y)
void	mouseExited(int x, int y)
void	mouseMoved(int x, int y)
protected ej.fp.Image	newDisplayImage() Creates a new image with the same size than display (not widget size).
void	newDrawingRegion(int x1, int y1, int x2, int y2, boolean drawingNow)
protected ej.fp.Image	newWidgetImage() Creates a new image with the same size than widget (not display size).
boolean	prepareBlendingOfIndexedColors(java.util.concurrent.atomic.AtomicInteger foreground, java.util.concurrent.atomic.AtomicInteger background)
void	repaint()
void	setAlpha(int alpha) Sets the opacity level (alpha) of the display in order to obtain a translucent display.
void	setBacklight(int backlight) Sets the backlight of the display.
void	setBacklightFeature(boolean enable) Enables or disables the backlight feature.
void	setBufferPolicyClass(java.lang.String bufferPolicyClassName) Sets the buffer policy.
void	setDisplayHeight(int height) Sets the height of the display in pixels (see class comment).
void	setDisplayWidth(int width) Sets the width of the display in pixels (see class comment).
void	setExtensionClass(java.lang.String extensionClassName) Defines the optional class name of the display extension.
void	setFlushTime(int ms) Simulates the embedded display's flush time when double buffering mode is enabled.
void	setInitialColor(int initialColor) Sets the initial color of the display (color used on startup, just before first drawing).
void	setRefreshRate(int hertz) Simulates the embedded display's refresh rate when double buffering mode is enabled.
void	setRefreshStrategyClass(java.lang.String refreshStrategyClassName) Sets the refresh strategy.
void	showYourself(boolean appearSwitchedOn)
void	start() Called by the parser after filling all the fields defined in the xml.
void	waitFlush()

Methods inherited from class ej.fp.Composite

add, iterator

Methods inherited from class ej.fp.Widget

getAbsoluteX, getAbsoluteY, getFilter, getHeight, getLabel, getParent, getSkin, getWidth, getX, getY, isOver, repaint, setCurrentSkin, setFilter, setHeight, setLabel, setOverlay, setSkin, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Methods inherited from interface ej.microui.display.LLUIDisplayImpl

decode, getContrast, setContrast

Methods inherited from interface ej.fp.MouseListener

mouseEntered, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Display

public Display()

Creates the widget display

Method Detail

setDisplayWidth

public void setDisplayWidth(int width)

Sets the width of the display in pixels (see class comment).

This method should only be called by front panel parser.

Parameters:

width - the width to set.

setDisplayHeight

public void setDisplayHeight(int height)

Sets the height of the display in pixels (see class comment).

This method should only be called by front panel parser.

Parameters:

height - the height to set.

getDisplayWidth

public int getDisplayWidth()

Gets the display width.

Returns:

the display width.

getDisplayHeight

public int getDisplayHeight()

Gets the display height.

Returns:

the display height.

setInitialColor

public void setInitialColor(int initialColor)

Sets the initial color of the display (color used on startup, just before first drawing). By default the initial color is 0x0 (black).

This is a RGB color (24 bits: 8-8-8). Alpha level is ignored.

This method should only be called by front panel parser.

Parameters:

initialColor - the initial color to set.

setAlpha

public void setAlpha(int alpha)

Sets the opacity level (alpha) of the display in order to obtain a translucent display. By default the display is fully opaque.

This method should only be called by front panel parser.

Parameters:

alpha - the opacity level to set, 0x00 is fully transparent and 0xff fully opaque.

Throws:

java.lang.IllegalArgumentException - if the given argument is not between 0x0 and 0xff.

setFlushTime

public void setFlushTime(int ms)

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

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

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

Parameters:

ms - the flush time in milliseconds.

setRefreshRate

public void setRefreshRate(int hertz)

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

The signal is expressed in hertz. A negative or zero value (default value) indicates the display does not manage the display's refresh rate and the flush action can start at once. Typical value is 60Hz.

Parameters:

hertz - the refresh rate in hertz.

setBacklightFeature

public void setBacklightFeature(boolean enable)

Enables or disables the backlight feature.

By default the backlight feature is enabled.

See LLUIDisplayImpl.hasBacklight() to have more information.

Parameters:

enable - true to enable backlight feature (default value).

setExtensionClass

public void setExtensionClass(java.lang.String extensionClassName)

Defines the optional class name of the display extension. This allows to customize this display widget without creating a sub-class of Display.

When set, a check is performed in finalizeConfiguration() to verify whether this class is valid.

This method should only be called by front panel parser.

Parameters:

extensionClassName - the user display extension class name.

setBufferPolicyClass

public void setBufferPolicyClass(java.lang.String bufferPolicyClassName)

Sets the buffer policy.

Parameters:

bufferPolicyClassName - the buffer policy class name to set.

setRefreshStrategyClass

public void setRefreshStrategyClass(java.lang.String refreshStrategyClassName)

Sets the refresh strategy.

Parameters:

refreshStrategyClassName - the refresh strategy class name to set.

finalizeConfiguration

public void finalizeConfiguration()

Overrides:

finalizeConfiguration in class ej.fp.Widget

showYourself

public void showYourself(boolean appearSwitchedOn)

Overrides:

showYourself in class ej.fp.Widget

start

public void start()

Called by the parser after filling all the fields defined in the xml. Used to complete the display initialization.

Overrides:

start in class ej.fp.Widget

dispose

public void dispose()

Overrides:

dispose in class ej.fp.Composite

getDisplayedImage

public ej.fp.Image getDisplayedImage()

Specified by:

getDisplayedImage in interface ej.microui.display.LLUIDisplayImpl

getCurrentSkin

public ej.fp.Image getCurrentSkin()

Gets the current displayed skin.

Overrides:

getCurrentSkin in class ej.fp.Widget

Returns:

the current displayed skin.

getInitialColor

public int getInitialColor()

Gets the initial color of the display.

Returns:

the initial color.

initialize

public ej.fp.Image initialize()

Called by MicroUI graphical engine when MicroUI.start() is called by the MicroEJ application.

Specified by:

initialize in interface ej.microui.display.LLUIDisplayImpl

hasBacklight

public boolean hasBacklight()

Specified by:

hasBacklight in interface ej.microui.display.LLUIDisplayImpl

getBacklight

public int getBacklight()

Returns the backlight of the display. backlight value range is LLUIDisplayImpl.BACKLIGHT_MIN-LLUIDisplayImpl.BACKLIGHT_MAX. If the display do not manage backlight ( hasBacklight() == false), returns LLUIDisplayImpl.BACKLIGHT_MIN.

Specified by:

getBacklight in interface ej.microui.display.LLUIDisplayImpl

Returns:

the backlight of the display.

setBacklight

public void setBacklight(int backlight)

Sets the backlight of the display.

Specified by:

setBacklight in interface ej.microui.display.LLUIDisplayImpl

Parameters:

backlight - the new value of the backlight.

isColor

public boolean isColor()

Specified by:

isColor in interface ej.microui.display.LLUIDisplayImpl

getNumberOfColors

public int getNumberOfColors()

Specified by:

getNumberOfColors in interface ej.microui.display.LLUIDisplayImpl

convertARGBColorToDisplayColor

public int convertARGBColorToDisplayColor(int argbColor)

Specified by:

convertARGBColorToDisplayColor in interface ej.microui.display.LLUIDisplayImpl

convertDisplayColorToARGBColor

public int convertDisplayColorToARGBColor(int displayColor)

Specified by:

convertDisplayColorToARGBColor in interface ej.microui.display.LLUIDisplayImpl

prepareBlendingOfIndexedColors

public boolean prepareBlendingOfIndexedColors(java.util.concurrent.atomic.AtomicInteger foreground,
                                              java.util.concurrent.atomic.AtomicInteger background)

Specified by:

prepareBlendingOfIndexedColors in interface ej.microui.display.LLUIDisplayImpl

getCurrentBackBuffer

public ej.fp.Image getCurrentBackBuffer()

Specified by:

getCurrentBackBuffer in interface ej.microui.display.LLUIDisplayImpl

getCurrentDrawingBuffer

public ej.fp.Image getCurrentDrawingBuffer()

Specified by:

getCurrentDrawingBuffer in interface ej.microui.display.LLUIDisplayImpl

isDoubleBuffered

public boolean isDoubleBuffered()

Specified by:

isDoubleBuffered in interface ej.microui.display.LLUIDisplayImpl

flush

public void flush()

Specified by:

flush in interface ej.microui.display.LLUIDisplayImpl

waitFlush

public void waitFlush()

Specified by:

waitFlush in interface ej.microui.display.LLUIDisplayImpl

newDrawingRegion

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

Specified by:

newDrawingRegion in interface ej.microui.display.LLUIDisplayImpl

repaint

public void repaint()

Overrides:

repaint in class ej.fp.Widget

newDisplayImage

protected ej.fp.Image newDisplayImage()

Creates a new image with the same size than display (not widget size).

Returns:

an image as big as display.

newWidgetImage

protected ej.fp.Image newWidgetImage()

Creates a new image with the same size than widget (not display size).

Returns:

an image as big as widget.

drawContrast

protected void drawContrast(ej.fp.Image imageSkin)

Transforms the skin data applying an algorithm to simulate the display contrast.

The default implementation performs nothing.

Parameters:

imageSkin - the image where applying the algorithm.

drawBacklight

protected void drawBacklight(ej.fp.Image imageSkin)

Transforms the skin data applying an algorithm to simulate the display backlight.

Parameters:

imageSkin - the image where applying the algorithm.

mouseDragged

public void mouseDragged(int x,
                         int y)

Specified by:

mouseDragged in interface ej.fp.MouseListener

mouseMoved

public void mouseMoved(int x,
                       int y)

Specified by:

mouseMoved in interface ej.fp.MouseListener

mouseExited

public void mouseExited(int x,
                        int y)

Specified by:

mouseExited in interface ej.fp.MouseListener