Package de.gmxhome.conrad.jpos.jpos_base.posprinter

Class POSPrinterProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.posprinter.POSPrinterProperties
All Implemented Interfaces:
JposBaseInterface, POSPrinterInterface
Direct Known Subclasses:
POSPrinter
public class POSPrinterProperties extends JposCommonProperties implements POSPrinterInterface
Class containing the POSPrinter specific properties, their default values and default implementations of POSPrinterInterface. For details about properties, methods and method parameters, see UPOS specification, chapter POS Printer.

  • Field Details

    • InsertionMode

      public boolean InsertionMode
      This property will be used internally to verify whether BeginInsertion and EndInsertion are valid operations. It will be initialized to false during device enable.

    • RemovalMode

      public boolean RemovalMode
      This property will be used internally to verify whether BeginRemoval and EndRemoval are valid operations. It will be initialized to false during device enable.

    • CapCharacterSet

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

    • CapConcurrentJrnRec

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

    • CapConcurrentJrnSlp

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

    • CapConcurrentPageMode

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

    • CapConcurrentRecSlp

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

    • CapCoverSensor

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

    • CapJrn2Color

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

    • CapJrnBold

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

    • CapJrnCartridgeSensor

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

    • CapJrnColor

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

    • CapJrnDhigh

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

    • CapJrnDwide

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

    • CapJrnDwideDhigh

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

    • CapJrnEmptySensor

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

    • CapJrnItalic

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

    • CapJrnNearEndSensor

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

    • CapJrnPresent

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

    • CapJrnUnderline

      public boolean CapJrnUnderline
      UPOS property CapJrnUnderline. 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.

    • CapRec2Color

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

    • CapRecBarCode

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

    • CapRecBitmap

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

    • CapRecBold

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

    • CapRecCartridgeSensor

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

    • CapRecColor

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

    • CapRecDhigh

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

    • CapRecDwide

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

    • CapRecDwideDhigh

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

    • CapRecEmptySensor

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

    • CapRecItalic

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

    • CapRecLeft90

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

    • CapRecMarkFeed

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

    • CapRecNearEndSensor

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

    • CapRecPageMode

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

    • CapRecPapercut

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

    • CapRecPresent

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

    • CapRecRight90

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

    • CapRecRotate180

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

    • CapRecRuledLine

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

    • CapRecStamp

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

    • CapRecUnderline

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

    • CapSlp2Color

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

    • CapSlpBarCode

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

    • CapSlpBitmap

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

    • CapSlpBold

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

    • CapSlpBothSidesPrint

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

    • CapSlpCartridgeSensor

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

    • CapSlpColor

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

    • CapSlpDhigh

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

    • CapSlpDwide

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

    • CapSlpDwideDhigh

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

    • CapSlpEmptySensor

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

    • CapSlpFullslip

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

    • CapSlpItalic

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

    • CapSlpLeft90

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

    • CapSlpNearEndSensor

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

    • CapSlpPageMode

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

    • CapSlpPresent

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

    • CapSlpRight90

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

    • CapSlpRotate180

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

    • CapSlpRuledLine

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

    • CapSlpUnderline

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

    • CapTransaction

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

    • CartridgeNotify

      public int CartridgeNotify
      UPOS property CartridgeNotify.

    • CharacterSetDef

      public int CharacterSetDef
      Default value of CharacterSet property. Default: PTR_CS_ASCII. Should 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" (PTR_CS_ASCII). Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CoverOpen

      public boolean CoverOpen
      UPOS property CoverOpen.

    • ErrorLevel

      public int ErrorLevel
      UPOS property ErrorLevel.

    • ErrorStation

      public int ErrorStation
      UPOS property ErrorStation.

    • ErrorString

      public String ErrorString
      UPOS property ErrorString.

    • FontTypefaceList

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

    • JrnCartridgeState

      public int JrnCartridgeState
      UPOS property JrnCartridgeState.

    • JrnCurrentCartridgeDef

      public int JrnCurrentCartridgeDef
      Default value of JrnCurrentCartridge property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • JrnCurrentCartridge

      public int JrnCurrentCartridge
      UPOS property JrnCurrentCartridge. For more details, see UPOS specification.

    • JrnEmpty

      public boolean JrnEmpty
      UPOS property JrnEmpty.

    • JrnLetterQuality

      public boolean JrnLetterQuality
      UPOS property JrnLetterQuality.

    • JrnLineChars

      public int JrnLineChars
      UPOS property JrnLineChars.

    • JrnLineCharsList

      public String JrnLineCharsList
      UPOS property JrnLineCharsList property. Default: "". Should be overwritten by objects derived from JposDevice within the changeDefaults method. If not empty, the first specified value is the default for JrnLineChars, too.

    • JrnLineHeightDef

      public int JrnLineHeightDef
      Default value of JrnLineHeight property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • JrnLineHeight

      public int JrnLineHeight
      UPOS property JrnLineHeight.

    • JrnLineSpacingDef

      public int JrnLineSpacingDef
      Default value of JrnLineSpacing property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • JrnLineSpacing

      public int JrnLineSpacing
      UPOS property JrnLineSpacing.

    • JrnLineWidthDef

      public int JrnLineWidthDef
      Default value of JrnLineWidth property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • JrnLineWidth

      public int JrnLineWidth
      UPOS property JrnLineWidth.

    • JrnNearEnd

      public boolean JrnNearEnd
      UPOS property JrnNearEnd.

    • MapCharacterSet

      public Boolean MapCharacterSet
      UPOS property MapCharacterSet. Default will be true if CapMapCharacterSet is true for jpos versions 1.7 and above, false otherwise.

    • MapMode

      public int MapMode
      UPOS property MapMode.

    • PageModeArea

      public String PageModeArea
      UPOS property PageModeArea.

    • PageModeDescriptor

      public int PageModeDescriptor
      UPOS property PageModeArea.

    • PageModeHorizontalPosition

      public int PageModeHorizontalPosition
      UPOS property PageModeHorizontalPosition.

    • PageModePrintArea

      public String PageModePrintArea
      UPOS property PageModeArea.

    • PageModePrintDirection

      public int PageModePrintDirection
      UPOS property PageModePrintDirection.

    • PageModeStation

      public int PageModeStation
      UPOS property PageModeStation.

    • PageModeVerticalPosition

      public int PageModeVerticalPosition
      UPOS property PageModeStation.

    • RecBarCodeRotationList

      public String RecBarCodeRotationList
      UPOS property RecBarCodeRotationList. Default: "0". Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecBitmapRotationList

      public String RecBitmapRotationList
      UPOS property RecBitmapRotationList. Default: "0". Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecCartridgeState

      public int RecCartridgeState
      UPOS property RecCartridgeState.

    • RecCurrentCartridgeDef

      public int RecCurrentCartridgeDef
      Default value of RecCurrentCartridge property. Default: PTR_COLOR_PRIMARY. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecCurrentCartridge

      public int RecCurrentCartridge
      UPOS property RecCurrentCartridge.

    • RecEmpty

      public boolean RecEmpty
      UPOS property RecEmpty.

    • RecLetterQuality

      public boolean RecLetterQuality
      UPOS property RecLetterQuality.

    • RecLineChars

      public int RecLineChars
      UPOS property RecLineChars.

    • RecLineCharsList

      public String RecLineCharsList
      UPOS property RecLineCharsList property. Default: "". Should be overwritten by objects derived from JposDevice within the changeDefaults method. If not empty, the first value is the default for RecLineChars, too.

    • RecLineHeightDef

      public int RecLineHeightDef
      Default value of RecLineHeight property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecLineHeight

      public int RecLineHeight
      UPOS property RecLineHeight.

    • RecLineSpacingDef

      public int RecLineSpacingDef
      Default value of RecLineSpacing property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecLineSpacing

      public int RecLineSpacing
      UPOS property RecLineSpacing.

    • RecLinesToPaperCutDef

      public int RecLinesToPaperCutDef
      Default value of RecLinesToPaperCut property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecLinesToPaperCut

      public int RecLinesToPaperCut
      UPOS property RecLinesToPaperCut.

    • RecLineWidthDef

      public int RecLineWidthDef
      Default value of RecLineWidth property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecLineWidth

      public int RecLineWidth
      UPOS property RecLineWidth.

    • RecNearEnd

      public boolean RecNearEnd
      UPOS property RecNearEnd.

    • RecSidewaysMaxCharsDef

      public int RecSidewaysMaxCharsDef
      Default value of RecSidewaysMaxChars property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecSidewaysMaxChars

      public int RecSidewaysMaxChars
      UPOS property RecSidewaysMaxChars.

    • RecSidewaysMaxLinesDef

      public int RecSidewaysMaxLinesDef
      Default value of RecSidewaysMaxLines property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • RecSidewaysMaxLines

      public int RecSidewaysMaxLines
      UPOS property RecSidewaysMaxLines.

    • RotateSpecial

      public int RotateSpecial
      UPOS property RotateSpecial.

    • SlpBarCodeRotationList

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

    • SlpBitmapRotationList

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

    • SlpCartridgeState

      public int SlpCartridgeState
      UPOS property SlpCartridgeState.

    • SlpCurrentCartridgeDef

      public int SlpCurrentCartridgeDef
      Default value of SlpCurrentCartridge property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpCurrentCartridge

      public int SlpCurrentCartridge
      UPOS property SlpCurrentCartridge.

    • SlpEmpty

      public boolean SlpEmpty
      UPOS property SlpEmpty.

    • SlpLetterQuality

      public boolean SlpLetterQuality
      UPOS property SlpLetterQuality.

    • SlpLineChars

      public int SlpLineChars
      UPOS property SlpLineChars.

    • SlpLineCharsList

      public String SlpLineCharsList
      UPOS property SlpLineCharsList property. Default: "". Should be overwritten by objects derived from JposDevice within the changeDefaults method. If no empty, the first value is the default for RecLineChars, too.

    • SlpLineHeightDef

      public int SlpLineHeightDef
      Default value of SlpLineHeight property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpLineHeight

      public int SlpLineHeight
      UPOS property SlpLineHeight.

    • SlpLinesNearEndToEndDef

      public int SlpLinesNearEndToEndDef
      Default value of SlpLinesNearEndToEnd property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpLinesNearEndToEnd

      public int SlpLinesNearEndToEnd
      UPOS property SlpLinesNearEndToEnd.

    • SlpLineSpacingDef

      public int SlpLineSpacingDef
      Default value of SlpLineSpacing property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpLineSpacing

      public int SlpLineSpacing
      UPOS property SlpLineSpacing.

    • SlpLineWidthDef

      public int SlpLineWidthDef
      Default value of SlpLineWidth property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpLineWidth

      public int SlpLineWidth
      UPOS property SlpLineWidth.

    • SlpMaxLinesDef

      public int SlpMaxLinesDef
      Default value of SlpMaxLines property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method if CapSlpFullslip is false.

    • SlpMaxLines

      public int SlpMaxLines
      UPOS property SlpMaxLines.

    • SlpNearEnd

      public boolean SlpNearEnd
      UPOS property SlpNearEnd.

    • SlpPrintSideDef

      public int SlpPrintSideDef
      Default value of SlpPrintSide property. Default: PTR_PS_UNKNOWN. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpPrintSide

      public int SlpPrintSide
      UPOS property SlpPrintSide.

    • SlpSidewaysMaxCharsDef

      public int SlpSidewaysMaxCharsDef
      Default value of SlpSidewaysMaxChars property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpSidewaysMaxChars

      public int SlpSidewaysMaxChars
      UPOS property SlpSidewaysMaxChars.

    • SlpSidewaysMaxLinesDef

      public int SlpSidewaysMaxLinesDef
      Default value of SlpSidewaysMaxLines property. Default: 0. Should be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SlpSidewaysMaxLines

      public int SlpSidewaysMaxLines
      UPOS property SlpSidewaysMaxLines.

  • Constructor Details

    • POSPrinterProperties

      public POSPrinterProperties​(int dev)
      Constructor.
      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.

    • initOnEnable

      public void initOnEnable​(boolean enable)
      Description copied from class: JposCommonProperties
      Initialization of properties that must be initialized during deviceEnable.
      Overrides:
      initOnEnable in class JposCommonProperties
      Parameters:
      enable - True: initialize properties, false: do nothing

    • clearErrorProperties

      public void clearErrorProperties()
      Description copied from class: JposCommonProperties
      Clear error properties. Performed at the end of any error handling.
      Overrides:
      clearErrorProperties in class JposCommonProperties

    • newJposOutputRequest

      public JposOutputRequest newJposOutputRequest()
      Description copied from interface: JposBaseInterface
      Class factory for JposOutputRequests.
      Specified by:
      newJposOutputRequest in interface JposBaseInterface
      Overrides:
      newJposOutputRequest in class JposCommonProperties
      Returns:
      A new instance of JposOutputRequest or a derived class.

    • cartridgeNotify

      public void cartridgeNotify​(int notify) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting CartridgeNotify. 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 disabled,
      • CapJrnCartridgeSensor, CapRecCartridgeSensor or CapSlpCartridgeSensor is not 0,
      • The new value is one of the predefined values,
      • internal property AllowAlwaysSetProperties is true or notify equals the previous value of CartridgeNotify.
      Specified by:
      cartridgeNotify in interface POSPrinterInterface
      Parameters:
      notify - New CartridgeNotify value
      Throws:
      jpos.JposException - If an error occurs

    • characterSet

      public void characterSet​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      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 is enabled,
      • CapJrnCartridgeSensor, CapRecCartridgeSensor or CapSlpCartridgeSensor is not 0,
      • The new value is one of the values specified in CharacterSetList.
      Specified by:
      characterSet in interface POSPrinterInterface
      Parameters:
      i - New character set value
      Throws:
      jpos.JposException - If an error occurs

    • jrnCurrentCartridge

      public void jrnCurrentCartridge​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting JrnCurrentCartridge. 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 enabled,
      • CapJrnPresent is true: New value is 0,
      • CapJrnPresent is false: New value is one of the cartridge values specified in CapJrnColor.
      Specified by:
      jrnCurrentCartridge in interface POSPrinterInterface
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLetterQuality

      public void jrnLetterQuality​(boolean i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting JrnLetterQuality. 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 enabled,
      • CapJrnPresent is true.
      Specified by:
      jrnLetterQuality in interface POSPrinterInterface
      Parameters:
      i - New JrnLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineChars

      public void jrnLineChars​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting JrnLineChars. 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 enabled,
      • CapJrnPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in JrnLineCharsList.
      Specified by:
      jrnLineChars in interface POSPrinterInterface
      Parameters:
      i - New JrnLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineHeight

      public void jrnLineHeight​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting JrnLineHeight. 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 enabled,
      • CapJrnPresent is true.
      Specified by:
      jrnLineHeight in interface POSPrinterInterface
      Parameters:
      i - New JrnLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineSpacing

      public void jrnLineSpacing​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting JrnLineSpacing. 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 enabled,
      • CapJrnPresent is true.
      Specified by:
      jrnLineSpacing in interface POSPrinterInterface
      Parameters:
      i - New JrnLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • mapCharacterSet

      public void mapCharacterSet​(boolean i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      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 is enabled,
      • CapMapCharacterSet is true or the new value is false.
      Specified by:
      mapCharacterSet in interface POSPrinterInterface
      Parameters:
      i - New MapCharacterSet value
      Throws:
      jpos.JposException - If an error occurs

    • mapMode

      public void mapMode​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting MapMode. 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 enabled,
      • The new value is one of MM_DOTS, MM_TWIPS, MM_ENGLISH or MM_METRIC.
      Specified by:
      mapMode in interface POSPrinterInterface
      Parameters:
      i - New MapMode value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeHorizontalPosition

      public void pageModeHorizontalPosition​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting PageModeHorizontalPosition. 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 enabled,
      • PageModeStation is not 0.
      Specified by:
      pageModeHorizontalPosition in interface POSPrinterInterface
      Parameters:
      i - New PageModeHorizontalPosition value
      Throws:
      jpos.JposException - If an error occurs

    • pageModePrintArea

      public void pageModePrintArea​(String i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting PageModePrintArea. 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 enabled,
      • PageModeStation is not 0,
      • The new value consists of 4 non-negative values,
      • The area does not exceed the paper width specified by RecLineWidth or SlpLineWidth,
      • If PageModeStation = S_SLIP and SlpMaxLines > 0, the area does not exceed the paper height specified by SlpLineHeight and SlpMaxLines.
      Specified by:
      pageModePrintArea in interface POSPrinterInterface
      Parameters:
      i - New PageModePrintArea value
      Throws:
      jpos.JposException - If an error occurs

    • pageModePrintDirection

      public void pageModePrintDirection​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting PageModePrintDirection. 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 enabled,
      • PageModeStation is not 0,
      • The new value is one of PD_TOP_TO_BOTTOM, PD_BOTTOM_TO_TOP, PD_RIGHT_TO_LEFT or PD_LEFT_TO_RIGHT.
      Specified by:
      pageModePrintDirection in interface POSPrinterInterface
      Parameters:
      i - New PageModePrintDirection value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeStation

      public void pageModeStation​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting PageModeStation. 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 enabled,
      • New PageModeStation value is S_RECEIPT or S_SLIP,
      • The selected station supports page mode (CapRecPageMode or CapSlpPageMode is true).
      Specified by:
      pageModeStation in interface POSPrinterInterface
      Parameters:
      i - New PageModeStation value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeVerticalPosition

      public void pageModeVerticalPosition​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting PageModeVerticalPosition. 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 enabled,
      • PageModeStation is not 0.
      Specified by:
      pageModeVerticalPosition in interface POSPrinterInterface
      Parameters:
      i - New PageModeVerticalPosition value
      Throws:
      jpos.JposException - If an error occurs

    • recCurrentCartridge

      public void recCurrentCartridge​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RecCurrentCartridge. 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 enabled,
      • CapRecPresent is true: New value is 0,
      • CapRecPresent is false: New value is one of the cartridge values specified in CapRecColor.
      Specified by:
      recCurrentCartridge in interface POSPrinterInterface
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • recLetterQuality

      public void recLetterQuality​(boolean i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RecLetterQuality. 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 enabled,
      • CapRecPresent is true.
      Specified by:
      recLetterQuality in interface POSPrinterInterface
      Parameters:
      i - New RecLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • recLineChars

      public void recLineChars​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RecLineChars. 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 enabled,
      • CapRecPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in RecLineCharsList.
      Specified by:
      recLineChars in interface POSPrinterInterface
      Parameters:
      i - New RecLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • recLineHeight

      public void recLineHeight​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RecLineHeight. 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 enabled,
      • CapRecPresent is true.
      Specified by:
      recLineHeight in interface POSPrinterInterface
      Parameters:
      i - New RecLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • recLineSpacing

      public void recLineSpacing​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RecLineSpacing. 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 enabled,
      • CapRecPresent is true.
      Specified by:
      recLineSpacing in interface POSPrinterInterface
      Parameters:
      i - New RecLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • rotateSpecial

      public void rotateSpecial​(int special) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting RotateSpecial. 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 not closed,
      • CapRecBarCode or CapSlpBarCode is true,
      • internal property AllowAlwaysSetProperties is true or special equals the previous value of RotateSpecial.
      Specified by:
      rotateSpecial in interface POSPrinterInterface
      Parameters:
      special - New RotateSpecial value
      Throws:
      jpos.JposException - If an error occurs

    • slpCurrentCartridge

      public void slpCurrentCartridge​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting SlpCurrentCartridge. 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 enabled,
      • CapSlpPresent is true: New value is 0,
      • CapSlpPresent is false: New value is one of the cartridge values specified in CapSlpColor.
      Specified by:
      slpCurrentCartridge in interface POSPrinterInterface
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • slpLetterQuality

      public void slpLetterQuality​(boolean i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting SlpLetterQuality. 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 enabled,
      • CapSlpPresent is true.
      Specified by:
      slpLetterQuality in interface POSPrinterInterface
      Parameters:
      i - New SlpLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineChars

      public void slpLineChars​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting SlpLineChars. 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 enabled,
      • CapSlpPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in SlpLineCharsList.
      Specified by:
      slpLineChars in interface POSPrinterInterface
      Parameters:
      i - New SlpLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineHeight

      public void slpLineHeight​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting SlpLineHeight. 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 enabled,
      • CapSlpPresent is true.
      Specified by:
      slpLineHeight in interface POSPrinterInterface
      Parameters:
      i - New SlpLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineSpacing

      public void slpLineSpacing​(int i) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of setting SlpLineSpacing. 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 enabled,
      • CapSlpPresent is true.
      Specified by:
      slpLineSpacing in interface POSPrinterInterface
      Parameters:
      i - New SlpLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • beginInsertion

      public void beginInsertion​(int timeout) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of BeginInsertion method. 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 enabled,
      • CapSlpPresent is true,
      • Asynchronous output or error handling is in progress,
      • The timeout is ≥ 0 or JPOS_FOREVER.
      If the service enters insertion mode successfully after BeginInsertion failed, e.g. due to a timeout condition during delayed asynchronous insertion handling, property InsertionMode must be set to true by the specific service implementation to avoid EndInsertion to fail.
      Specified by:
      beginInsertion in interface POSPrinterInterface
      Parameters:
      timeout - See UPOS specification, method BeginInsertion.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • beginRemoval

      public void beginRemoval​(int timeout) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of BeginRemoval method. 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 enabled,
      • CapSlpPresent is true,
      • Asynchronous output or error handling is not in progress,
      • The timeout is ≥ 0 or JPOS_FOREVER.
      If the service enters removal mode successfully after BeginRemoval failed, e.g. due to a timeout condition during delayed asynchronous removal handling, property RemovalMode must be set to true by the specific service implementation to avoid EndRemoval to fail.
      Specified by:
      beginRemoval in interface POSPrinterInterface
      Parameters:
      timeout - See UPOS specification, method BeginRemoval.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • changePrintSide

      public void changePrintSide​(int side) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of ChangePrintSide method. 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 enabled,
      • CapSlpPresent and CapSlpBothSidesPrint are true,
      • Asynchronous output or error handling is not in progress,
      • The new side value is PS_OPPOSITE, PS_SIDE1 or PS_SIDE2.
      Specified by:
      changePrintSide in interface POSPrinterInterface
      Parameters:
      side - See UPOS specification, method ChangePrintSide.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • clearPrintArea

      public void clearPrintArea() throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of ClearPrintArea method. 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 enabled,
      • PageModeStation in not 0.
      Specified by:
      clearPrintArea in interface POSPrinterInterface
      Throws:
      jpos.JposException - See UPOS specification, method ClearPrintArea.

    • endInsertion

      public void endInsertion() throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of EndInsertion method. 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 enabled,
      • CapSlpPresent is true,
      • Device is not in insertion mode,
      • Asynchronous output or error handling is not in progress.
      Specified by:
      endInsertion in interface POSPrinterInterface
      Throws:
      jpos.JposException - See UPOS specification, method EndInsertion.

    • endRemoval

      public void endRemoval() throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of EndRemoval method. 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 enabled,
      • CapSlpPresent is true,
      • Device is not in removal mode,
      • Asynchronous output or error handling is not in progress.
      Specified by:
      endRemoval in interface POSPrinterInterface
      Throws:
      jpos.JposException - See UPOS specification, method EndRemoval.

    • printImmediate

      public PrintImmediate printImmediate​(int station, String data) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintImmediate method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous (high-priority) execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • Selected station is S_JOURNAL, S_RECEIPT or S_SLIP,
      • The cover is closed, paper present, head ready and cartridge neither empty nor removed.
      If the service supports page mode but does not support immediate printing in page mode, this method must be overwritten. In this case, it must throw E_ILLEGAL if called in page mode. Keep in mind: Since PrintImmediate prints always synchronously, but page mode printing will start after leaving page mode, PrintImmediate prints outside page mode before page mode printing starts. This is also the case in sideways print mode.
      Specified by:
      printImmediate in interface POSPrinterInterface
      Parameters:
      station - See UPOS specification, method PrintImmediate.
      data - Print data. See UPOS specification, method PrintImmediate.
      Returns:
      PrintImmediate object for use in final part.
      Throws:
      jpos.JposException - See UPOS specification, method PrintImmediate.

    • setBitmap

      public void setBitmap​(int bitmapNumber, int station, String fileName, int width, int alignment) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of SetBitmap method. 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 enabled,
      • bitmapNumber is between 1 and 20,
      • station is S_RECEIPT or S_SLIP,
      • selected station and bitmap printing on selected station supported,
      • fileName is not null,
      • width is BM_ASIS or > 0,
      • alignment is BM_LEFT, BM_CENTER, BM_RIGHT or ≥ 0.
      Specified by:
      setBitmap in interface POSPrinterInterface
      Parameters:
      bitmapNumber - See UPOS specification, method SetBitmap.
      station - See UPOS specification, method SetBitmap.
      fileName - See UPOS specification, method SetBitmap.
      width - See UPOS specification, method SetBitmap.
      alignment - See UPOS specification, method SetBitmap.
      Throws:
      jpos.JposException - See UPOS specification, method SetBitmap.

    • setLogo

      public void setLogo​(int location, String data) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of SetLogo method. 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 enabled,
      • Selected location is L_TOP or L_BOTTOM,
      • data is not null.
      Specified by:
      setLogo in interface POSPrinterInterface
      Parameters:
      location - See UPOS specification, method SetLogo.
      data - See UPOS specification, method SetLogo.
      Throws:
      jpos.JposException - See UPOS specification, method SetLogo.

    • validateData

      public void validateData​(int station, String data) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of ValidateData method. 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 enabled,
      • station is S_JOURNAL, S_RECEIPT or S_SLIP.
      This method will be called before data will be checked using the methods validateData with POSPrinterService.PrintDataPart, objects as second parameter. Since these methods should check everything that must be checked, it should not be necessary to overwrite this method. However, if a service overwrites this method, it may throw a JposException with error code 0 to signal that successful validation has been completed and calling validateData with POSPrinterService.PrintDataPart objects representing data shall be suppressed. Otherwise, this method can be used to initialize the implementation object to handle dependencies between all following data parts.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - See UPOS specification, method ValidateData.
      data - Print data. See UPOS specification, method ValidateData.
      Throws:
      jpos.JposException - See UPOS specification, method ValidateData.

    • validateData

      @Deprecated public void validateData​(int station, POSPrinterService.PrintDataPart data) throws jpos.JposException
      Deprecated.
      Description copied from interface: POSPrinterInterface
      Validate character or escape sequence. Usually, this method simply calls the validation method of the given PrintDataPart object.
      This method is deprecaded now. It is recommended to use the validateData method of data instead.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      data - Any object derived from PrintDataPart.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.PrintData data) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate printable character sequence. ESC sequences, CR and LF have been filtered out. Default behavior is that all other characters with character code ≤ 0x20 are invalid. If a service should support more characters, this method must be overwritten.
      Keep in mind that data may contain an empty string. In that case, it marks the end of printable data in cases where the last character was a CR to support post-validation of CR.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      data - Data to be printed.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.ControlChar ctrl) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate control character. One of CR or LF. Default behavior is that both characters are valid. CR will be passed to ValidateData only once for any sequence of multiple CR in the original data stream and only if LF is neither the previous nor the following character. However, even if the printer supports CR, CR might be valid behind or in case of a following escape sequence.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      ctrl - ControlChar object, representing CR or LF.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscCut esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate cut sequence. For details, see UPOS specification of ESC|[#][x]P. Default behavior is that a service supports only full cut and no cut (CP_FULLCUT and 0 percent). If a service supports more values, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • Capability CapXxxPapercut is true,
      • EscCut attribute Stamp is false or CapXxxStamp is true.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - S_RECEIPT.
      esc - EscCut object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscRuledLine esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate ruled line escape sequence. For details, see UPOS specification of ESC|*#dL. All parameters have been checked for plausibility before entering this method as described for each parameter. Can be overwritten by service implementations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • The LineDirection attribute is valid in combination with the corresponding capability CapXxxRuledLine,
      • The LineWidth attribute is > 0,
      • The LineStyle attribute is one of LS_SINGLE_SOLID_LINE, LS_DOUBLE_SOLID_LINE, LS_BROKEN_LINE or LS_CHAIN_LINE,
      • The LineColor attribute is one of the colors represented by the bits set in the corresponding CapXxxColor capability,
      • The PositionList attribute conforms to the UPOS specification, method DrawRuledLine. Values have been checked against 0 and XxxLineWidth.
      The default implementation is that ruled lines are not supported. If a service supports more values, this method must be overwritten.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscRuledLine object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscNormalize esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate normalize escape sequence. For details, see UPOS specification of ESC|N. Should always be valid. Can be overwritten by service implementations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscNormalize object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscLogo esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate logo sequence. For details, see UPOS specification of ESC|xL. The default behavior is to assume that requests to print a logo are always valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscLogo object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • getLogoData

      public POSPrinterService.PrintDataPart[] getLogoData​(boolean top)
      Description copied from interface: POSPrinterInterface
      This method will be called whenever print data contain a logo print sequence ESC|tL or ESC|bL. Since it is possible that logos can be changed between the print call and execution of methods for asynchronous print, e.g. when transaction printing will be used, data describing the logo must be retrieved by POSPrinterService whenever an EscLogo object is generated. Every POSPrinter service implementation must overwrite this method because only the specific service stores information about the logo data. However, logo data are of type POSPrinterService.PrintDataPart[], where POSPrinterService.PrintDataPart is one of the objects supported by validateData(int, POSPrinterService.PrintDataPart). As default, this method returns an empty list of objects.
      Specified by:
      getLogoData in interface POSPrinterInterface
      Parameters:
      top - Specifies which logo data shall be filled, true for top logo, false for bottom logo.
      Returns:
      POSPrinterService.PrintDataPart array containing logo data. Array is empty if the requested logo has not been set.

    • validateData

      public void validateData​(int station, POSPrinterService.EscStamp esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate stamp sequence. For details, see UPOS specification of ESC|sL. The corresponding capability (CapRecStamp) has been checked and station is S_RECEIPT. The default behavior is to assume that requests to stamp are always valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxStanp is true.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscStamp object containing the sequemnce attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscBitmap esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate bitmap sequence. For details, see UPOS specification of ESC|#B. Default behavior is that all bitmap numbers are valid if the corresponding capability for the specified printer station is true. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxBitmap is true,
      • EscBitmap attribute Number is > 0 and ≤ 20.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT or S_SLIP.
      esc - EscBitmap object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscFeed esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate feed sequence. For details, see UPOS specification of ESC|[#]xF. Default behavior is that all count values are valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscFeed object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscEmbedded esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate embedded data sequence. For details, see UPOS specification of ESC|[*]#E. Default behavior is that the given sequence is valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscEmbedded object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscBarcode esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate barcode sequence. For details, see UPOS specification of ESC|[*]#R. A service implementation should check the validity of symbology, height and text position and whether all character in code can be printed using the selected symbology. For example, if symbology is BCS_UPCA, the code must consist only of numeric characters, the length must be 6, 7, 11 or 12 and in case of 7 or 12, the last digit must be a valid check digit. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxBarCode is true,
      • EscBarcode attribute Symbology is ≥ BCS_UPCA (which is the smallest valid symbology value),
      • EscBarcode attribute Height is > 0,
      • EscBarcode attribute Width is > 0 and ≤ XxxLineWidth,
      • EscCarcode attribute TextPosition is one of BC_TEXT_ABOVE, BC_TEXT_BELOW or BC_TEXT_NONE.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT or S_SLIP.
      esc - EscBarcode object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscFontTypeface esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate font typeface selection sequence. For details, see UPOS specification of ESC|#fT. Default behavior is to support all type fonts specified in FontTypefaceList for all printer stations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • EscFontTypeface attribute is between 0 and the number of type face names specified in FontTypefaceList.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscFontTypeface object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscAlignment esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate alignment sequence. For details, see UPOS specification of ESC|xA. Default behavior is that the service supports left, centered and right aligned text. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscAlignment object that contains the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscScale esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate print size sequence. For details, see UPOS specification for ESC|xC, ESC|#hC or ESC|#vC. Default behavior is only support for scale = 1 and 2 if the corresponding capabilities for width and height of the specified station are true. If a service supports more scales, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscScale attribute ScaleValue is 2, CapXxxDhigh, CapXxxDwide or CapXxxDwideDhigh is true if the corresponding EscScale attribute(s) ScaleHorizontal and / or ScaleVertical is / are true.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - Valid print station
      esc - EscScale object that holds the sequence specific attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscSimple esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate attribute setting sequences. For details, see UPOS specification for ESC|[!]bC, ESC|[!]iC, ESC|[!]rvC, ESC|[!]tbC and ESC|[!]tpC. The default behavior is that reverse video, superscript and subscript printing is not supported and resetting an attribute is not supported, too. If a printer supports these attributes, this method must be overwritten.
      The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscSimple attributes Bold and Activate are true, CapXxxBold is true,
      • If EscSimple attributes Italic and Activate are true, CapXxxItalic is true.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - Print station, in case of bold ant italic validated.
      esc - Object holding data of simple esc sequence
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscLine esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate combined line printing sequence. For details, see UPOS specification for ESC|[!][#]uC and ESC|[!][#]stC. Default behavior is no support for strike-through and thickness of 1 dot for underline is supported. If a service supports strike-through or another thickness, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscLine attribute Underline and Activate are true, CapXxxUnderline is true.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - Valid print station
      esc - EscLine object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscColor esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate color sequences. For details, see UPOS specification for ESC|[#]rC and ESC|[#]fC. Default behavior is that the service supports all colors specified in the 2Color capability of the specified printer station, but no RGB color settings. If a service supports RGB colors, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscColor attribute Rgb is true, attribute Color has a decimal value of the form rrrgggbbb, where rrr, ggg and bbb are values between 0 and 255 (inclusive),
      • If EscColor attribute Rgbis false, attribute Color is one of the color values that form CapXxx2Color.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - Valid printer station
      esc - EscColor object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscShade esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate shading sequence. For details, see UPOS specification of ESC|[#]sC. Default is no support of shading. Therefore all values other then -1 (default) and 0 are not supported. If a service supports shading, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station.
      esc - EscShade object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      public void validateData​(int station, POSPrinterService.EscUnknown esc) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validate unknown sequence. Default is no support. If a device supports further sequences, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Specified by:
      validateData in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station.
      esc - EscUnknown object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • cutPaper

      public CutPaper cutPaper​(int percentage) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of CutPaper method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • CapRecPresent and CapRecPapercut are true,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      Specified by:
      cutPaper in interface POSPrinterInterface
      Parameters:
      percentage - See UPOS specification, method CutPaper.
      Returns:
      CutPaper object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method CutPaper.

    • cutPaper

      public void cutPaper​(CutPaper request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of CutPaper method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CutPaper object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • Receipt paper is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      cutPaper in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by CutPaper.
      Throws:
      jpos.JposException - For details, see UPOS method CutPaper.

    • drawRuledLine

      public DrawRuledLine drawRuledLine​(int station, String positionList, int lineDirection, int lineWidth, int lineStyle, int lineColor) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of DrawRuledLine method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      • neither transaction mode nor vertical print mode or page mode is active for the specified station,
      • station, lineDirection, lineWidth, lineStyle, lineColor and positionList have been validated with validateRuledLine.
      Specified by:
      drawRuledLine in interface POSPrinterInterface
      Parameters:
      station - POSPrinter station.
      positionList - Position list.
      lineDirection - Line direction.
      lineWidth - Line width in dots.
      lineStyle - Line stype.
      lineColor - Line color.
      Returns:
      DrawRuledLine object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method DrawRuledLine.

    • drawRuledLine

      public void drawRuledLine​(DrawRuledLine request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of DrawRuledLine method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DrawRuledLine object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      drawRuledLine in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by DrawRuledLine.
      Throws:
      jpos.JposException - For details, see UPOS method DrawRuledLine.

    • markFeed

      public MarkFeed markFeed​(int type) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of MarkFeed method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • neither transaction mode nor vertical print mode or page mode is active,
      • CapRecPresent is true and CapRecMarkFeed is not 0,
      • type is MF_TO_TAKEUP, MF_TO_CUTTER, MF_TO_CURRENT_TOF or MF_TO_NEXT_TOF,
      • CapRecMarkFeed ANDed with type is non-zero,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      Specified by:
      markFeed in interface POSPrinterInterface
      Parameters:
      type - type of mark sensed paper handling. See UPOS specification for method MarkFeed
      Returns:
      MarkFeed object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method MarkFeed.

    • markFeed

      public void markFeed​(MarkFeed request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of MarkFeed method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a MarkFeed object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • Receipt paper is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      markFeed in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by MarkFeed.
      Throws:
      jpos.JposException - For details, see UPOS method MarkFeed.

    • printBarCode

      public PrintBarCode printBarCode​(int station, String data, int symbology, int height, int width, int alignment, int textPosition) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintBarCode method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station, data, symbology, height, width, alignment and textPosition have been validated with validateBarcode.
      If a service supports upside down printing, this method must be overwritten. It must at least be check whether the service is inside upside down printing mode without activated rotated barcode printing.
      Specified by:
      printBarCode in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method PrintBarCode.
      data - String to be bar coded, see UPOS method PrintBarCode.
      symbology - Symbol type to be used, see UPOS method PrintBarCode.
      height - Bar code height, see UPOS method PrintBarCode.
      width - Bar code width, see UPOS method PrintBarCode.
      alignment - Bar code alignment, see UPOS method PrintBarCode.
      textPosition - HRI text position, see UPOS method PrintBarCode.
      Returns:
      PrintBarCode object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBarCode.

    • printBarCode

      public void printBarCode​(PrintBarCode request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PrintBarCode method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintBarCode object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      printBarCode in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintBarCode.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBarCode.

    • printBitmap

      public PrintBitmap printBitmap​(int station, String fileName, int width, int alignment) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintBitmap method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_RECEIPT or S_SLIP and CapXxxBitmap and CapXxxPresent are true),
      • fileName is not null,
      • width is BM_ASIS or a value > 0,
      • alignment is one of BM_LEFT, BM_CENTER, BM_RIGHT or a positive value.
      If a service supports bitmap printing, this method must be overwritten. It must at least be check whether the fileName points to a valid bitmap file. In addition, if the service supports upside down printing, it must check whether the service is inside upside down printing mode without activated rotated bitmap printing.
      Specified by:
      printBitmap in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method PrintBitmap.
      fileName - Bitmap file name, see UPOS method PrintBitmap.
      width - Width, see UPOS method PrintBitmap.
      alignment - Alignment, see UPOS method PrintBitmap.
      Returns:
      PrintBitmap object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBitmap.

    • printBitmap

      public void printBitmap​(PrintBitmap request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PrintBitmap method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintBitmap object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      printBitmap in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintBitmap.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBitmap.

    • printMemoryBitmap

      public PrintMemoryBitmap printMemoryBitmap​(int station, byte[] data, int type, int width, int alignment) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintMemoryBitmap method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_RECEIPT or S_SLIP and CapXxxBitmap and CapXxxPresent are true),
      • data is not null,
      • type is one of BMT_BMP, BMT_JPEG or BMT_GIF,
      • width is BM_ASIS or a value > 0,
      • alignment is one of BM_LEFT, BM_CENTER, BM_RIGHT or a positive value.
      If a service supports bitmap printing, this method must be overwritten. It must at least be check whether data is a byte array that matches the given bitmap format. In addition, if the service supports upside down printing, it must check whether the service is inside upside down printing mode without activated rotated bitmap printing.
      Specified by:
      printMemoryBitmap in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method PrintMemoryBitmap.
      data - Bitmap data, see UPOS method PrintBitmap.
      type - Bitmap format, see UPOS method PrintBitmap.
      width - Width, see UPOS method PrintMemoryBitmap.
      alignment - Alignment, see UPOS method PrintMemoryBitmap.
      Returns:
      PrintMemoryBitmap object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintMemoryBitmap.

    • printMemoryBitmap

      public void printMemoryBitmap​(PrintMemoryBitmap request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PrintMemoryBitmap method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintMemoryBitmap object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      printMemoryBitmap in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintMemoryBitmap.
      Throws:
      jpos.JposException - For details, see UPOS method PrintMemoryBitmap.

    • printNormal

      public PrintNormal printNormal​(int station, String data) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintNormal method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_JOURNAL, S_RECEIPT or S_SLIP and the corresponding CapXxxPresent is true),
      • data is not null.
      Specified by:
      printNormal in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method PrintNormal.
      data - Print data. See UPOS method PrintNormal.
      Returns:
      PrintNormal object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintNormal.

    • printNormal

      public void printNormal​(PrintNormal request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PrintNormal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintNormal object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      printNormal in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintNormal.
      Throws:
      jpos.JposException - For details, see UPOS method PrintNormal.

    • printTwoNormal

      public PrintTwoNormal printTwoNormal​(int stations, String data1, String data2) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PrintTwoNormal method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • stations is valid (S_JOURNAL_RECEIPT, S_JOURNAL_SLIP, S_RECEIPT_SLIP, TWO_RECEIPT_JOURNAL, TWO_SLIP_JOURNAL or TWO_SLIP_RECEIPT and the corresponding CapConcurrentXxxYyy property is true),
      • data1 and data2 are not null,
      • Non of the two print stations is in page mode, sideways print mode or transaction mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Specified by:
      printTwoNormal in interface POSPrinterInterface
      Parameters:
      stations - Print stations, see UPOS method PrintTwoNormal.
      data1 - Print data for first or both stations, see UPOS method PrintTwoNormal.
      data2 - Print data for second station or empty string, see UPOS method PrintTwoNormal.
      Returns:
      PrintTwoNormal object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintTwoNormal.

    • printTwoNormal

      public void printTwoNormal​(PrintTwoNormal request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PrintTwoNormal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintTwoNormal object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The stations specified by request.getStation() are present.
      • Covers are closed.
      • If present, cartridges are operational.
      Specified by:
      printTwoNormal in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintTwoNormal.
      Throws:
      jpos.JposException - For details, see UPOS method PrintTwoNormal.

    • transactionPrint

      public TransactionPrint transactionPrint​(int station, int control) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of TransactionPrint method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • station is valid (S_JOURNAL, S_RECEIPT or S_SLIP),
      • control is one of TP_NORMAL or TP_TRANSACTION,
      • control is TP_NORMAL if and only if the service is in transaction mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Specified by:
      transactionPrint in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method TransactionPrint.
      control - Control, see UPOS method TransactionPrint.
      Returns:
      TransactionPrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method TransactionPrint.

    • transactionPrint

      public void transactionPrint​(TransactionPrint request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of TransactionPrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a TransactionPrint object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      transactionPrint in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by TransactionPrint.
      Throws:
      jpos.JposException - For details, see UPOS method TransactionPrint.

    • rotatePrint

      public RotatePrint rotatePrint​(int station, int rotation) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of RotatePrint method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • station is valid (S_RECEIPT or S_SLIP),
      • rotation contains one of the rotation values (RP_RIGHT90, RP_LEFT90 or RP_ROTATE180) or is RP_NORMAL,
      • If not RP_NORMAL: The capability corresponding to station (CapXxxRight90, CapXxxLeft90, CapRotate180) is true and the station is not in sideways printing mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Specified by:
      rotatePrint in interface POSPrinterInterface
      Parameters:
      station - Print station, see UPOS method RotatePrint.
      rotation - Rotation, see UPOS method RotatePrint.
      Returns:
      RotatePrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method RotatePrint.

    • rotatePrint

      public void rotatePrint​(RotatePrint request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of RotatePrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a RotatePrint object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      rotatePrint in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by RotatePrint.
      Throws:
      jpos.JposException - For details, see UPOS method RotatePrint.

    • pageModePrint

      public PageModePrint pageModePrint​(int control) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Validation part of PageModePrint method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • PageModeStation is valid (S_RECEIPT or S_SLIP and the correcponding capability CapXxxPageMode is true),
      • control is one of PM_PAGE_MODE, PM_PRINT_SAVE, PM_NORMAL or PM_CANCEL,
      • If PM_PAGE_MODE: The station is not in page mode,
      • If not PM_PAGE_MODE: The station is in page mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Specified by:
      pageModePrint in interface POSPrinterInterface
      Parameters:
      control - Control, see UPOS method PageModePrint.
      Returns:
      PageModePrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PageModePrint.

    • pageModePrint

      public void pageModePrint​(PageModePrint request) throws jpos.JposException
      Description copied from interface: POSPrinterInterface
      Final part of PageModePrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PageModePrint object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      In case of asynchronous processing, the following additional checks have been made before invocation:
      • The station specified by PageModeStation is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Specified by:
      pageModePrint in interface POSPrinterInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PageModePrint.
      Throws:
      jpos.JposException - For details, see UPOS method PageModePrint.