com.so.net

Class DeviceApi.SDialog

java.lang.Object

com.so.net.DeviceApi.SDialog

Enclosing class:

DeviceApi

public static final class DeviceApi.SDialog
extends Object

Controls the simple dialog mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceApi.SDialog.Buffer The display buffers of the simple dialog mode.
static class	DeviceApi.SDialog.ClearBehaviour Which display buffers to clear.
static class	DeviceApi.SDialog.LoadOption Whether to load an existing font from the device file system.
static interface	DeviceApi.SDialog.PenCallback The callback to call when the pen is used in the simple dialog mode.
static class	DeviceApi.SDialog.PenEvent The parameter of the DeviceApi.SDialog.PenCallback.
static class	DeviceApi.SDialog.Text A text in the simple dialog mode.
static class	DeviceApi.SDialog.UpdateBehaviour How to update the display in the simple dialog mode.

Method Summary

Modifier and Type	Method and Description
static boolean	clearDisplay(DeviceApi.SDialog.ClearBehaviour behaviour) Clears the dispay.
static boolean	setFont(Path fontPath) Sets the font to use for subsequent text writes.
static boolean	setFont(Path fontPath, DeviceApi.SDialog.LoadOption loadOption) Sets the font to use for subsequent text writes.
static boolean	setImage(BufferedImage image, int column, int row, DeviceApi.SDialog.Buffer whichBuffer) Writes an image.
static boolean	setMode() Sets the device to the simple dialog mode.
static boolean	setPenCallback(DeviceApi.SDialog.PenCallback callback) Sets the callback to call when the pen is used in the simple dialog mode.
static boolean	setText(DeviceApi.SDialog.Text text) Writes text.
static boolean	updateDisplay() Switches the display buffers.
static boolean	updateDisplay(DeviceApi.SDialog.UpdateBehaviour behaviour) Updates the display.

Methods inherited from class java.lang.Object

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

Method Detail

setPenCallback

public static boolean setPenCallback(DeviceApi.SDialog.PenCallback callback)

Sets the callback to call when the pen is used in the simple dialog mode.

Parameters:

callback - The callback.

Returns:

True in case of success.

setMode

public static boolean setMode()

Sets the device to the simple dialog mode.

Returns:

True in case of success.

setImage

public static boolean setImage(BufferedImage image,
                               int column,
                               int row,
                               DeviceApi.SDialog.Buffer whichBuffer)

Writes an image.

Parameters:

image - The image to write.

column - The column of the upper left corner to display the image at.

row - The row of the upper left corner to display the image at.

whichBuffer - The dispay buffer to write to

Returns:

True in case of success. Write to the DeviceApi.SDialog.Buffer.Current to change the visible buffer. Write to the DeviceApi.SDialog.Buffer.Shadow to prepare several changes to take effect in one updateDisplay() step.

updateDisplay

public static boolean updateDisplay()

Switches the display buffers.

Returns:

True in case of success.

updateDisplay

public static boolean updateDisplay(DeviceApi.SDialog.UpdateBehaviour behaviour)

Updates the display.

Parameters:

behaviour - How to update.

Returns:

True in case of success.

clearDisplay

public static boolean clearDisplay(DeviceApi.SDialog.ClearBehaviour behaviour)

Clears the dispay.

Parameters:

behaviour - What to clear.

Returns:

True in case of success.

setFont

public static boolean setFont(Path fontPath)

Sets the font to use for subsequent text writes.

Parameters:

fontPath - The path to the font to use.

Returns:

True in case of success. This loads a new file to the device. Use setText(com.so.net.DeviceApi.SDialog.Text) to write text.

setFont

public static boolean setFont(Path fontPath,
                              DeviceApi.SDialog.LoadOption loadOption)

Sets the font to use for subsequent text writes.

Parameters:

fontPath - The path to the font to use.

loadOption - Where to load the font from.

Returns:

True in case of success. This loads a new file to the device. Use setText(com.so.net.DeviceApi.SDialog.Text) to write text.

setText

public static boolean setText(DeviceApi.SDialog.Text text)

Writes text.

Parameters:

text - The text to write.

Returns:

True in case of success.