Package de.gmxhome.conrad.jpos.jpos_base.linedisplay

Interface LineDisplayInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

LineDisplay, LineDisplayProperties

public interface LineDisplayInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the LineDisplay device category. For details about properties, methods and method parameters, see UPOS specification, chapter Line Display. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	blinkRate(int rate)	Final part of setting BlinkRate.
void	characterSet(int charset)	Final part of setting CharacterSet.
void	clearDescriptors()	Final part of ClearDescriptors method.
void	clearText()	Final part of ClearText method.
void	createWindow(int viewportRow, int viewportColumn, int viewportHeight, int viewportWidth, int windowHeight, int windowWidth)	Final part of CreateWindow method.
void	currentWindow(int windowNo)	Final part of setting CurrentWindow.
void	cursorColumn(int column)	Final part of setting CursorColumn.
void	cursorRow(int row)	Final part of setting CursorRow.
void	cursorType(int type)	Final part of setting CursorType.
void	cursorUpdate(boolean flag)	Final part of setting CursorUpdate.
void	defineGlyph(int glyphCode, byte[] glyph)	Final part of DefineGlyph method.
void	destroyWindow()	Final part of DestroyWindow method.
void	deviceBrightness(int brightness)	Final part of setting DeviceBrightness.
void	displayBitmap(String fileName, int width, int alignmentX, int alignmentY)	Final part of DisplayBitmap method.
void	displayText(DisplayText request)	Final part of displayText method.
DisplayText	displayText(String data, int attribute)	Validation part of DisplayText method.
void	interCharacterWait(int millisec)	Final part of setting InterCharacterWait.
void	mapCharacterSet(boolean b)	Final part of setting MapCharacterSet.
void	marqueeFormat(int format)	Final part of setting MarqueeFormat.
void	marqueeRepeatWait(int millisec)	Final part of setting MarqueeRepeatWait.
void	marqueeType(int type)	Final part of setting MarqueeType.
void	marqueeUnitWait(int millisec)	Final part of setting MarqueeUnitWait.
void	readCharacterAtCursor(int[] cursorData)	Final part of ReadCharacterAtCursor method.
void	refreshWindow(int window)	Final part of RefreshWindow method.
void	screenMode(int b)	Final part of setting ScreenMode.
void	scrollText(int direction, int units)	Final part of ScrollText method.
void	setBitmap(int bitmapNumber, String fileName, int width, int alignmentX, int alignmentY)	Final part of SetBitmap method.
void	setDescriptor(int descriptor, int attribute)	Final part of SetDescriptor method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

mapCharacterSet

void mapCharacterSet(boolean b)
              throws jpos.JposException

Final part of setting MapCharacterSet. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• if CapMapCharacterSet is false: New value is false as well.

Parameters:

b - New MapCharacterSet value

Throws:

jpos.JposException - If an error occurs during enable or disable

screenMode

void screenMode(int b)
         throws jpos.JposException

Final part of setting ScreenMode. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is claimed,
• Device is not enabled,
• If CapScreenMode is false: New mode is 0 as well,
• If CapScreenMode is true: New mode is one of the values specified in ScreenModeList.

Parameters:

b - New ScreenMode value

Throws:

jpos.JposException - If an error occurs during enable or disable

blinkRate

void blinkRate(int rate)
        throws jpos.JposException

Final part of setting BlinkRate. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CapBlinkRate is true.
• New blink rate is > 0,
• internal property AllowAlwaysSetProperties is true or rate equals the previous value of BlinkRate.

Parameters:

rate - New BlinkRate value

Throws:

jpos.JposException - If an error occurs during enable or disable

cursorType

void cursorType(int type)
         throws jpos.JposException

Final part of setting CursorType. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CapCursorType is neither DISP_CCT_NONE nor DISP_CCT_FIXED,
• Either CapCursorType bit DISP_CCT_BLINK is set or bit DISP_CT_BLINK is not set in new value,
• The new value is valid due to a match with the corresponding value in CapCursorType,
• internal property AllowAlwaysSetProperties is true or type equals the previous value of CursorType.

Parameters:

type - New CursorType value

Throws:

jpos.JposException - If an error occurs during enable or disable

characterSet

void characterSet(int charset)
           throws jpos.JposException

Final part of setting CharacterSet. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is one of the values specified in CharacterSetList,
• internal property AllowAlwaysSetProperties is true or charset equals the previous value of CharacterSet.

Parameters:

charset - New CharacterSet value

Throws:

jpos.JposException - If an error occurs during enable or disable

currentWindow

void currentWindow(int windowNo)
            throws jpos.JposException

Final part of setting CurrentWindow. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is ≥ 0 and ≤ DeviceWindows,
• internal property AllowAlwaysSetProperties is true or windowNo equals the previous value of CurrentWindow.

Parameters:

windowNo - New CurrentWindow value

Throws:

jpos.JposException - If an error occurs during enable or disable

cursorColumn

void cursorColumn(int column)
           throws jpos.JposException

Final part of setting CursorColumn. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is ≥ 0 and ≤ Columns,
• internal property AllowAlwaysSetProperties is true or column equals the previous value of CursorColumn.

Parameters:

column - New CursorColumn value

Throws:

jpos.JposException - If an error occurs during enable or disable

cursorRow

void cursorRow(int row)
        throws jpos.JposException

Final part of setting CursorRow. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is ≥ 0 and < Rows,
• internal property AllowAlwaysSetProperties is true or row equals the previous value of CursorRow.

Parameters:

row - New CursorRow value

Throws:

jpos.JposException - If an error occurs during enable or disable

cursorUpdate

void cursorUpdate(boolean flag)
           throws jpos.JposException

Final part of setting CursorUpdate. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• internal property AllowAlwaysSetProperties is true or flag equals the previous value of CursorUpdate.

Parameters:

flag - New CursorUpdate value

Throws:

jpos.JposException - If an error occurs during enable or disable

deviceBrightness

void deviceBrightness(int brightness)
               throws jpos.JposException

Final part of setting DeviceBrightness. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is ≥ 0 and ≤ 100,
• internal property AllowAlwaysSetProperties is true or brightness equals the previous value of DeviceBrightness.

Parameters:

brightness - New DeviceBrightness value

Throws:

jpos.JposException - If an error occurs during enable or disable

interCharacterWait

void interCharacterWait(int millisec)
                 throws jpos.JposException

Final part of setting InterCharacterWait. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CapICharWait is false: The new value is 0,
• CapICharWait is true: The new value is ≥ 0,
• internal property AllowAlwaysSetProperties is true or millisec equals the previous value of InterCharacterWait.

Parameters:

millisec - New InterCharacterWait value

Throws:

jpos.JposException - If an error occurs during enable or disable

marqueeFormat

void marqueeFormat(int format)
            throws jpos.JposException

Final part of setting MarqueeFormat. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CurrentWindow is not the device window,
• The new value is DISP_MF_WALK or DISP_MF_PLACE,
• internal property AllowAlwaysSetProperties is true or format equals the previous value of MarqueeFormat.

Parameters:

format - New MarqueeFormat value

Throws:

jpos.JposException - If an error occurs during enable or disable

marqueeRepeatWait

void marqueeRepeatWait(int millisec)
                throws jpos.JposException

Final part of setting MarqueeRepeatWait. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• The new value is ≥ 0,
• internal property AllowAlwaysSetProperties is true or millisec equals the previous value of MarqueeRepeatWait.

Parameters:

millisec - New MarqueeRepeatWait value

Throws:

jpos.JposException - If an error occurs during enable or disable

marqueeType

void marqueeType(int type)
          throws jpos.JposException

Final part of setting MarqueeType. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CurrentWindow is not the device window,
• CapVMarquee and CapHMarquee are false: New value is DISP_MT_NONE.
• Only CapVMarquee is false: New value is neither DISP_MT_UP nor DISP_MT_DOWN,
• Only CapHMarquee is false: New value is neither DISP_MT_LEFT nor DISP_MT_RIGHT,
• New value is DISP_MT_NONE, DISP_MT_INIT, DISP_MT_UP, DISP_MT_DOWN, DISP_MT_LEFT or DISP_MT_RIGHT,
• internal property AllowAlwaysSetProperties is true or type equals the previous value of MarqueeType.

Parameters:

type - New MarqueeType value

Throws:

jpos.JposException - If an error occurs during enable or disable

marqueeUnitWait

void marqueeUnitWait(int millisec)
              throws jpos.JposException

Final part of setting MarqueeUnitWait. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has not been closed,
• CurrentWindow is not the device window,
• The new value is ≥ 0,
• internal property AllowAlwaysSetProperties is true or millisec equals the previous value of MarqueeUnitWait.

Parameters:

millisec - New MarqueeUnitWait value

Throws:

jpos.JposException - If an error occurs during enable or disable

displayBitmap

void displayBitmap(String fileName,
 int width,
 int alignmentX,
 int alignmentY)
            throws jpos.JposException

Final part of DisplayBitmap method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapBitmap is true,
• fileName is neither null nor an empty string,
• width is > 0 or DISP_BM_ASIS,
• alignmentX is DISP_BM_LEFT, DISP_BM_CENTER or DISP_BM_RIGHT,
• alignmentY is DISP_BM_TOP, DISP_BM_CENTER or DISP_BM_BOTTOM.

Parameters:

fileName - File name or URL of bitmap file.

width - Width of the bitmap to be displayed.

alignmentX - Horizontal placement of the bitmap.

alignmentY - Vertical placement of the bitmap.

Throws:

jpos.JposException - If an error occurs.

setBitmap

void setBitmap(int bitmapNumber,
 String fileName,
 int width,
 int alignmentX,
 int alignmentY)
        throws jpos.JposException

Final part of SetBitmap method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapBitmap is true,
• bitmapNumber is between 1 and 100,
• fileName is neither null nor an empty string,
• width is > 0 or DISP_BM_ASIS,
• alignmentX is DISP_BM_LEFT, DISP_BM_CENTER or DISP_BM_RIGHT,
• alignmentY is DISP_BM_TOP, DISP_BM_CENTER or DISP_BM_BOTTOM.

Parameters:

bitmapNumber - The number to be assigned to this bitmap.

fileName - File name or URL of bitmap file.

width - Width of the bitmap to be displayed.

alignmentX - Horizontal placement of the bitmap.

alignmentY - Vertical placement of the bitmap.

Throws:

jpos.JposException - If an error occurs.

defineGlyph

void defineGlyph(int glyphCode,
 byte[] glyph)
          throws jpos.JposException

Final part of DefineGlyph method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapCustomGlyph is true,
• glyphCode is one of the values specified in CustomGlyphList,
• glyph in a byte array with a length of at least GlyphHeight * (GlyphWidth + 7) / 8.

Parameters:

glyphCode - The character code to be defined.

glyph - Data bytes that define the glyph.

Throws:

jpos.JposException - If an error occurs.

readCharacterAtCursor

void readCharacterAtCursor(int[] cursorData)
                    throws jpos.JposException

Final part of ReadCharacterAtCursor method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapReadBack is true,
• cursorData is of type int[1].

Parameters:

cursorData - The character read from the display.

Throws:

jpos.JposException - If an error occurs.

clearDescriptors

void clearDescriptors()
               throws jpos.JposException

Final part of ClearDescriptors method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapDescriptors is true.

Throws:

jpos.JposException - If an error occurs.

clearText

void clearText()
        throws jpos.JposException

Final part of ClearText method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• MarqueeType is DISP_MT_NONE or DISP_MT_INIT.

Throws:

jpos.JposException - If an error occurs.

createWindow

void createWindow(int viewportRow,
 int viewportColumn,
 int viewportHeight,
 int viewportWidth,
 int windowHeight,
 int windowWidth)
           throws jpos.JposException

Final part of CreateWindow method. Can be overwritten in derived class, if necessary. Initializes the following properties: Rows, Columns, CursorRow, CursorType, CursorUpdate, MarqueeType, MarqueeFormat, MarqueeUnitWait. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• DeviceWindows is not 0,
• viewportRow is between 0 and DeviceRows - 1,
• viewportColumn is between 0 and DeviceColumns - 1,
• viewportHeight is between 0 and DeviceRows - viewportRow,
• viewportWidth is between 0 and DeviceColumns - viewportColumn,
• windowHeight is ≥ viewportHeight,
• windowWidth is ≥ viewportWidth,
• Either windowHeight = viewportHeight or windowWidth = viewportWidth.

Parameters:

viewportRow - The viewport’s start device row.

viewportColumn - The viewport’s start device column.

viewportHeight - The number of device rows in the viewport.

viewportWidth - The number of device columns in the viewport.

windowHeight - The number of rows in the window.

windowWidth - The number of columns in the window.

Throws:

jpos.JposException - If an error occurs.

destroyWindow

void destroyWindow()
            throws jpos.JposException

Final part of DestroyWindow method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CurrentWindow is not the device window.

Throws:

jpos.JposException - If an error occurs.

displayText

DisplayText displayText(String data,
 int attribute)
                 throws jpos.JposException

Validation part of DisplayText method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• data is not null,
• MarqueeType equals DISP_MT_NONE or DISP_MT_INIT.

In addition to validation, this method must update CursorRow and CursorColumn on success if InterCharacterWait is not zero and MarqueeType is MT_NONE (teletype mode).

Parameters:

data - Display data.

attribute - Display attributes.

Returns:

DisplayText object for use in final part.

Throws:

jpos.JposException - If an error occurs.

displayText

void displayText(DisplayText request)
          throws jpos.JposException

Final part of displayText method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DisplayText object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously (if InterCharacterWait is > 0). All plausibility checks have been made before, only runtime errors can occur.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by DisplayText.

Throws:

jpos.JposException - If an error occurs.

refreshWindow

void refreshWindow(int window)
            throws jpos.JposException

Final part of RefreshWindow method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• MarqueeType equals DISP_MT_NONE or DISP_MT_INIT,
• window is between 0 and DeviceWindows.

Parameters:

window - The window to be refreshed.

Throws:

jpos.JposException - If an error occurs.

scrollText

void scrollText(int direction,
 int units)
         throws jpos.JposException

Final part of ScrollText method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• MarqueeType equals DISP_MT_NONE,
• InterCharacterWait equals 0,
• direction is DISP_ST_UP, DISP_ST_DOWN, DISP_ST_LEFT or DISP_ST_RIGHT.
• units ≥ 0,

Parameters:

direction - Scrolling direction.

units - Number of columns or rows to scroll.

Throws:

jpos.JposException - If an error occurs.

setDescriptor

void setDescriptor(int descriptor,
 int attribute)
            throws jpos.JposException

Final part of SetDescriptor method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapDescriptors is true,
• descriptor is between 0 and DeviceDescriptors,
• attribute is DISP_SD_ON, DISP_SD_OFF or DISP_SD_BLINK.

Parameters:

descriptor - Descriptor to be changed.

attribute - Attribute for the descriptor.

Throws:

jpos.JposException - If an error occurs.