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

Class LineDisplayProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.linedisplay.LineDisplayProperties
All Implemented Interfaces:
JposBaseInterface, LineDisplayInterface
Direct Known Subclasses:
LineDisplay
public class LineDisplayProperties extends JposCommonProperties implements LineDisplayInterface
Class containing the display specific properties, their default values and default implementations of LineDisplayInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Line Display.

  • Field Details

    • CapBitmap

      public boolean CapBitmap
      UPOS property CapBitmap. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapScreenMode

      public boolean CapScreenMode
      UPOS property CapScreenMode. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapMapCharacterSet

      public boolean CapMapCharacterSet
      UPOS property CapMapCharacterSet. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapBlinkRate

      public boolean CapBlinkRate
      UPOS property CapBlinkRate. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapCursorType

      public int CapCursorType
      UPOS property CapCursorType. Default: DISP_CCT_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapCustomGlyph

      public boolean CapCustomGlyph
      UPOS property CapCustomGlyph. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapReadBack

      public int CapReadBack
      UPOS property CapReadBack. Default: DISP_CRB_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapReverse

      public int CapReverse
      UPOS property CapReverse. Default: DISP_CR_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapBrightness

      public boolean CapBrightness
      UPOS property CapBrightness. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapCharacterSet

      public int CapCharacterSet
      UPOS property CapCharacterSet. Default: DISP_CCS_ASCII. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapDescriptors

      public boolean CapDescriptors
      UPOS property CapDescriptors. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapHMarquee

      public boolean CapHMarquee
      UPOS property CapHMarquee. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapICharWait

      public boolean CapICharWait
      UPOS property CapICharWait. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapVMarquee

      public boolean CapVMarquee
      UPOS property CapVMarquee. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • MapCharacterSet

      public Boolean MapCharacterSet
      UPOS property MapCharacterSet. Default: Default will be true if CapMapCharacterSet is true for jpos versions 1.7 and above, false otherwise. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • MaximumX

      public int MaximumX
      UPOS property MaximumX. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • MaximumY

      public int MaximumY
      UPOS property MaximumY. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • ScreenMode

      public int ScreenMode
      UPOS property ScreenMode. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • ScreenModeList

      public String ScreenModeList
      UPOS property ScreenModeList. Default: "2x20". Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • BlinkRate

      public int BlinkRate
      UPOS property BlinkRate. Default: DISP_CCT_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CursorType

      public int CursorType
      UPOS property CursorType. Default: DISP_CT_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CustomGlyphList

      public String CustomGlyphList
      UPOS property CustomGlyphList. Default: "". Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • GlyphHeight

      public int GlyphHeight
      UPOS property GlyphHeight. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • GlyphWidth

      public int GlyphWidth
      UPOS property GlyphWidth. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CharacterSetDef

      public int CharacterSetDef
      Default value of CharacterSet property. Default: DISP_CS_ASCII. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CharacterSet

      public int CharacterSet
      UPOS property CharacterSet.

    • CharacterSetList

      public String CharacterSetList
      UPOS property CharacterSetList. Default: "998" (DISP_CS_ASCII). Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • Columns

      public int Columns
      UPOS property Columns.

    • CurrentWindow

      public int CurrentWindow
      UPOS property CurrentWindow.

    • CursorColumn

      public int CursorColumn
      UPOS property CursorColumn.

    • CursorRow

      public int CursorRow
      UPOS property CursorRow.

    • CursorUpdate

      public boolean CursorUpdate
      UPOS property CursorUpdate.

    • DeviceBrightness

      public int DeviceBrightness
      UPOS property DeviceBrightness.

    • DeviceColumns

      public int DeviceColumns
      UPOS property DeviceColumns. Default: 20. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DeviceDescriptors

      public int DeviceDescriptors
      UPOS property DeviceDescriptors. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DeviceRows

      public int DeviceRows
      UPOS property BlinkRate. Default: 2. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DeviceWindows

      public int DeviceWindows
      UPOS property DeviceWindows. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • InterCharacterWait

      public int InterCharacterWait
      UPOS property InterCharacterWait.

    • MarqueeFormat

      public int MarqueeFormat
      UPOS property MarqueeFormat. Default: DISP_MF_WALK. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • MarqueeRepeatWait

      public int MarqueeRepeatWait
      UPOS property MarqueeRepeatWait.

    • MarqueeType

      public int MarqueeType
      UPOS property MarqueeType.

    • MarqueeUnitWait

      public int MarqueeUnitWait
      UPOS property MarqueeUnitWait.

    • Rows

      public int Rows
      UPOS property Rows.

  • Constructor Details

    • LineDisplayProperties

      public LineDisplayProperties​(int dev)
      Constructor. Sets ExclusiveUse to ExclusiveYes to match the LineDisplay device model.
      Parameters:
      dev - Device index

  • Method Details

    • initOnOpen

      public void initOnOpen()
      Description copied from class: JposCommonProperties
      Initialization of properties that must be initialized during open.
      Overrides:
      initOnOpen in class JposCommonProperties

    • initOnFirstEnable

      public boolean initOnFirstEnable()
      Description copied from class: JposCommonProperties
      Initialize properties that must be initialized whenever the device will be enabled the first time-
      Overrides:
      initOnFirstEnable in class JposCommonProperties
      Returns:
      Returns true in case of first enable.

    • mapCharacterSet

      public void mapCharacterSet​(boolean b) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      mapCharacterSet in interface LineDisplayInterface
      Parameters:
      b - New MapCharacterSet value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • screenMode

      public void screenMode​(int b) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      screenMode in interface LineDisplayInterface
      Parameters:
      b - New ScreenMode value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • blinkRate

      public void blinkRate​(int rate) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      blinkRate in interface LineDisplayInterface
      Parameters:
      rate - New BlinkRate value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • cursorType

      public void cursorType​(int type) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      cursorType in interface LineDisplayInterface
      Parameters:
      type - New CursorType value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • characterSet

      public void characterSet​(int charset) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      characterSet in interface LineDisplayInterface
      Parameters:
      charset - New CharacterSet value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • currentWindow

      public void currentWindow​(int windowNo) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      currentWindow in interface LineDisplayInterface
      Parameters:
      windowNo - New CurrentWindow value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • cursorColumn

      public void cursorColumn​(int column) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      cursorColumn in interface LineDisplayInterface
      Parameters:
      column - New CursorColumn value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • cursorRow

      public void cursorRow​(int row) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      cursorRow in interface LineDisplayInterface
      Parameters:
      row - New CursorRow value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • cursorUpdate

      public void cursorUpdate​(boolean flag) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      cursorUpdate in interface LineDisplayInterface
      Parameters:
      flag - New CursorUpdate value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • deviceBrightness

      public void deviceBrightness​(int brightness) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      deviceBrightness in interface LineDisplayInterface
      Parameters:
      brightness - New DeviceBrightness value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • interCharacterWait

      public void interCharacterWait​(int millisec) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      interCharacterWait in interface LineDisplayInterface
      Parameters:
      millisec - New InterCharacterWait value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • marqueeFormat

      public void marqueeFormat​(int format) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      marqueeFormat in interface LineDisplayInterface
      Parameters:
      format - New MarqueeFormat value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • marqueeRepeatWait

      public void marqueeRepeatWait​(int millisec) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      marqueeRepeatWait in interface LineDisplayInterface
      Parameters:
      millisec - New MarqueeRepeatWait value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • marqueeType

      public void marqueeType​(int type) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      marqueeType in interface LineDisplayInterface
      Parameters:
      type - New MarqueeType value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • marqueeUnitWait

      public void marqueeUnitWait​(int millisec) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      marqueeUnitWait in interface LineDisplayInterface
      Parameters:
      millisec - New MarqueeUnitWait value
      Throws:
      jpos.JposException - If an error occurs during enable or disable

    • displayBitmap

      public void displayBitmap​(String fileName, int width, int alignmentX, int alignmentY) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      displayBitmap in interface LineDisplayInterface
      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

      public void setBitmap​(int bitmapNumber, String fileName, int width, int alignmentX, int alignmentY) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      setBitmap in interface LineDisplayInterface
      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

      public void defineGlyph​(int glyphCode, byte[] glyph) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      defineGlyph in interface LineDisplayInterface
      Parameters:
      glyphCode - The character code to be defined.
      glyph - Data bytes that define the glyph.
      Throws:
      jpos.JposException - If an error occurs.

    • readCharacterAtCursor

      public void readCharacterAtCursor​(int[] cursorData) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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].
      Specified by:
      readCharacterAtCursor in interface LineDisplayInterface
      Parameters:
      cursorData - The character read from the display.
      Throws:
      jpos.JposException - If an error occurs.

    • clearDescriptors

      public void clearDescriptors() throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      clearDescriptors in interface LineDisplayInterface
      Throws:
      jpos.JposException - If an error occurs.

    • clearText

      public void clearText() throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      clearText in interface LineDisplayInterface
      Throws:
      jpos.JposException - If an error occurs.

    • createWindow

      public void createWindow​(int viewportRow, int viewportColumn, int viewportHeight, int viewportWidth, int windowHeight, int windowWidth) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      createWindow in interface LineDisplayInterface
      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

      public void destroyWindow() throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      destroyWindow in interface LineDisplayInterface
      Throws:
      jpos.JposException - If an error occurs.

    • displayText

      public DisplayText displayText​(String data, int attribute) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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).
      Specified by:
      displayText in interface LineDisplayInterface
      Parameters:
      data - Display data.
      attribute - Display attributes.
      Returns:
      DisplayText object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • displayText

      public void displayText​(DisplayText request) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      displayText in interface LineDisplayInterface
      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

      public void refreshWindow​(int window) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      refreshWindow in interface LineDisplayInterface
      Parameters:
      window - The window to be refreshed.
      Throws:
      jpos.JposException - If an error occurs.

    • scrollText

      public void scrollText​(int direction, int units) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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,
      Specified by:
      scrollText in interface LineDisplayInterface
      Parameters:
      direction - Scrolling direction.
      units - Number of columns or rows to scroll.
      Throws:
      jpos.JposException - If an error occurs.

    • setDescriptor

      public void setDescriptor​(int descriptor, int attribute) throws jpos.JposException
      Description copied from interface: LineDisplayInterface
      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.
      Specified by:
      setDescriptor in interface LineDisplayInterface
      Parameters:
      descriptor - Descriptor to be changed.
      attribute - Attribute for the descriptor.
      Throws:
      jpos.JposException - If an error occurs.