ScannerProperties (sdk 1.27 API)

java.lang.Object
- com.datalogic.device.configuration.PropertyGroup
- - com.datalogic.decode.configuration.ScannerProperties

```
public class ScannerProperties
extends PropertyGroup
```
ScannerProperties is the scanner property container class.

Field Summary

Fields
Modifier and Type	Field and Description
`Aztec`	`aztec` Controls the Aztec barcode reading capabilities.
`Codabar`	`codabar` Controls the Codabar barcode reading capabilities.
`Code128`	`code128` Controls the Code 128, GS1-128 and ISBT 128 barcode reading capabilities.
`Code39`	`code39` Controls the Code 39, Code 32 and Tri-Optic barcode reading capabilities.
`Code93`	`code93` Controls the Code 93 barcode reading capabilities.
`Composite`	`composite` Controls the GS1 Composite barcode reading capabilities.
`Datamatrix`	`datamatrix` Controls the Data Matrix barcode reading capabilities.
`Digimarc`	`digimarc` Controls the Digimarc barcode ™ reading capabilities.
`Discrete25`	`discrete25` Controls the Discrete 2 of 5 barcode reading capabilities.
`DisplayNotification`	`displayNotification` Provides configuration for the display notification.
`DecodingNotification`	`dnotification` Provides configuration for decoding notifications.
`DotCode`	`dotcode` Controls the DotCode barcode reading capabilities.
`Ean13`	`ean13` Controls the EAN-13 barcode reading capabilities.
`Ean8`	`ean8` Controls the EAN-8 barcode reading capabilities.
`Formatting`	`format` Provides configuration for formatting functionalities.
`FrameCaptureConfiguration`	`frameCaptureConfiguration` Controls the frame capture feature.
`GoodRead`	`goodread` Provides configuration for good read notifications.
`Gs1DataBar_14`	`gs1DataBar_14` Controls the GS1 DataBar 14 barcode reading capabilities.
`Gs1DataBar_Expanded`	`gs1DataBar_Expanded` Controls the GS1 DataBar Expanded barcode reading capabilities.
`Gs1DataBar_Limited`	`gs1DataBar_Limited` Controls the GS1 DataBar Limited barcode reading capabilities.
`IntentWedge`	`intentWedge` Provides configuration for the Intent Wedge.
`Interleaved25`	`interleaved25` Controls the Interleaved 2 of 5 barcode reading capabilities.
`Inverse`	`inverse` Controls the reverse decoding mode for linear and 2D barcodes.
`KeyboardWedge`	`keyboardWedge` Provides configuration for the Keyboard Wedge.
`LinearQuietZones`	`linearQZ` Controls the admitted valid margins for linear barcodes.
`Matrix25`	`matrix25` Controls the Matrix 2 of 5 barcode reading capabilities.
`Maxicode`	`maxicode` Controls the Maxicode barcode reading capabilities.
`Micropdf417`	`micropdf417` Controls the Micro PDF417 barcode reading capabilities.
`MicroQR`	`microQr` Controls the Micro QR Code barcode reading capabilities.
`Msi`	`msi` Controls the MSI barcode reading capabilities.
`MultiScan`	`multiScan` Provides configuration related to Multi Scan functionalities.
`PostalUsps4State`	`p4State` Controls the USPS 4-State barcode reading capabilities.
`PostalAustralian`	`pAus` Controls the Australia Post barcode reading capabilities.
`Pdf417`	`pdf417` Controls the PDF417 barcode reading capabilities.
`PostalJapan`	`pJap` Controls the Japan Post barcode reading capabilities.
`PostalKix`	`pKix` Controls the KIX barcode reading capabilities.
`PostalUsPlanet`	`pPlanet` Controls the US PLANET barcode reading capabilities.
`PostalUsPostnet`	`pPostnet` Controls the US POSTNET barcode reading capabilities.
`PresentationMode`	`presentationMode` Provides configuration related to presentation mode functionalities.
`PostalRoyalMail`	`pRM` Controls the Royal Mail barcode reading capabilities.
`QRCode`	`qrCode` Controls the QR Code barcode reading capabilities.
`ScannerOptions`	`scannerOptions` Provides configuration related to scanner functionalities.
`UpcA`	`upcA` Controls the UPC-A barcode reading capabilities.
`UpcE`	`upcE` Controls the UPC-E barcode reading capabilities.
`UpcEanExtensions`	`upcEanExtensions` Controls the UPC/EAN extensions reading capabilities.
`WebWedge`	`webWedge` Provides configuration for the Web wedge.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ScannerProperties()
This is an empty constructor that will not be used.

Constructors
Modifier	Constructor and Description
`protected`	`ScannerProperties()` This is an empty constructor that will not be used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScannerProperties`	`edit(PropertyGetter editor)` Returns all the ScannerProperties initialized with the actual values.
`int`	`store(PropertyEditor to, boolean persist)` Provides a way to store the properties through a PropertyEditor.

Methods inherited from class com.datalogic.device.configuration.PropertyGroup
getGroups, getId, getName, getProperties, getPropertyById, getPropertyByName, getPropertyGroupById, getPropertyGroupByName, isFullySupported, isSupported, load, setToDefault

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dnotification
```
public DecodingNotification dnotification
```
    Provides configuration for decoding notifications. DecodingNotification
  - format
```
public Formatting format
```
    Provides configuration for formatting functionalities. Formatting
  - goodread
```
public GoodRead goodread
```
    Provides configuration for good read notifications. GoodRead
  - scannerOptions
```
public ScannerOptions scannerOptions
```
    Provides configuration related to scanner functionalities. ScannerOptions
  - presentationMode
```
public PresentationMode presentationMode
```
    Provides configuration related to presentation mode functionalities. PresentationMode
  - multiScan
```
public MultiScan multiScan
```
    Provides configuration related to Multi Scan functionalities. MultiScan
  - intentWedge
```
public IntentWedge intentWedge
```
    Provides configuration for the Intent Wedge. IntentWedge
  - keyboardWedge
```
public KeyboardWedge keyboardWedge
```
    Provides configuration for the Keyboard Wedge. KeyboardWedge
  - displayNotification
```
public DisplayNotification displayNotification
```
    Provides configuration for the display notification. DisplayNotification
  - webWedge
```
public WebWedge webWedge
```
    Provides configuration for the Web wedge. WebWedge
  - code39
```
public Code39 code39
```
    Controls the Code 39, Code 32 and Tri-Optic barcode reading capabilities. Code39
  - code128
```
public Code128 code128
```
    Controls the Code 128, GS1-128 and ISBT 128 barcode reading capabilities. Code128
  - ean8
```
public Ean8 ean8
```
    Controls the EAN-8 barcode reading capabilities. Ean8
  - ean13
```
public Ean13 ean13
```
    Controls the EAN-13 barcode reading capabilities. Ean13
  - upcA
```
public UpcA upcA
```
    Controls the UPC-A barcode reading capabilities. UpcA
  - upcE
```
public UpcE upcE
```
    Controls the UPC-E barcode reading capabilities. UpcE
  - upcEanExtensions
```
public UpcEanExtensions upcEanExtensions
```
    Controls the UPC/EAN extensions reading capabilities. UpcEanExtensions
  - code93
```
public Code93 code93
```
    Controls the Code 93 barcode reading capabilities. Code93
  - gs1DataBar_14
```
public Gs1DataBar_14 gs1DataBar_14
```
    Controls the GS1 DataBar 14 barcode reading capabilities. Gs1DataBar_14
  - gs1DataBar_Expanded
```
public Gs1DataBar_Expanded gs1DataBar_Expanded
```
    Controls the GS1 DataBar Expanded barcode reading capabilities. Gs1DataBar_Expanded
  - gs1DataBar_Limited
```
public Gs1DataBar_Limited gs1DataBar_Limited
```
    Controls the GS1 DataBar Limited barcode reading capabilities. Gs1DataBar_Limited
  - interleaved25
```
public Interleaved25 interleaved25
```
    Controls the Interleaved 2 of 5 barcode reading capabilities. Interleaved25
  - matrix25
```
public Matrix25 matrix25
```
    Controls the Matrix 2 of 5 barcode reading capabilities. Matrix25
  - discrete25
```
public Discrete25 discrete25
```
    Controls the Discrete 2 of 5 barcode reading capabilities. Discrete25
  - codabar
```
public Codabar codabar
```
    Controls the Codabar barcode reading capabilities. Codabar
  - msi
```
public Msi msi
```
    Controls the MSI barcode reading capabilities. Msi
  - linearQZ
```
public LinearQuietZones linearQZ
```
    Controls the admitted valid margins for linear barcodes. LinearQuietZones
  - qrCode
```
public QRCode qrCode
```
    Controls the QR Code barcode reading capabilities. QRCode
  - microQr
```
public MicroQR microQr
```
    Controls the Micro QR Code barcode reading capabilities. MicroQR
  - aztec
```
public Aztec aztec
```
    Controls the Aztec barcode reading capabilities. Aztec
  - datamatrix
```
public Datamatrix datamatrix
```
    Controls the Data Matrix barcode reading capabilities. Datamatrix
  - pdf417
```
public Pdf417 pdf417
```
    Controls the PDF417 barcode reading capabilities. Pdf417
  - micropdf417
```
public Micropdf417 micropdf417
```
    Controls the Micro PDF417 barcode reading capabilities. Micropdf417
  - maxicode
```
public Maxicode maxicode
```
    Controls the Maxicode barcode reading capabilities. Maxicode
  - pAus
```
public PostalAustralian pAus
```
    Controls the Australia Post barcode reading capabilities. PostalAustralian
  - pJap
```
public PostalJapan pJap
```
    Controls the Japan Post barcode reading capabilities. PostalJapan
  - pKix
```
public PostalKix pKix
```
    Controls the KIX barcode reading capabilities. PostalKix
  - pRM
```
public PostalRoyalMail pRM
```
    Controls the Royal Mail barcode reading capabilities. PostalRoyalMail
  - pPlanet
```
public PostalUsPlanet pPlanet
```
    Controls the US PLANET barcode reading capabilities. PostalUsPlanet
  - pPostnet
```
public PostalUsPostnet pPostnet
```
    Controls the US POSTNET barcode reading capabilities. PostalUsPostnet
  - p4State
```
public PostalUsps4State p4State
```
    Controls the USPS 4-State barcode reading capabilities. PostalUsps4State
  - digimarc
```
public Digimarc digimarc
```
    Controls the Digimarc barcode ™ reading capabilities. Digimarc
  - composite
```
public Composite composite
```
    Controls the GS1 Composite barcode reading capabilities. Composite
  - dotcode
```
public DotCode dotcode
```
    Controls the DotCode barcode reading capabilities. DotCode
  - inverse
```
public Inverse inverse
```
    Controls the reverse decoding mode for linear and 2D barcodes. Inverse
  - frameCaptureConfiguration
```
public FrameCaptureConfiguration frameCaptureConfiguration
```
    Controls the frame capture feature. FrameCaptureConfiguration
- Constructor Detail
  - ScannerProperties
```
protected ScannerProperties()
```
    This is an empty constructor that will not be used. In the implementation a different one protected/private will be invoked. Leave it empty, do not implement. This avoids breaking code if the class is extended.
- Method Detail
  - edit
```
public static ScannerProperties edit(PropertyGetter editor)
```
    Returns all the ScannerProperties initialized with the actual values.
    
    Parameters:
    
    editor - A PropertyGetter used to load the current barcode families and properties.
    
    Returns:
    
    A ScannerProperties instance.
  - store
```
public int store(PropertyEditor to,
                 boolean persist)
```
    Provides a way to store the properties through a PropertyEditor.
    
    Overrides:
    
    store in class PropertyGroup
    
    Parameters:
    
    to - PropertyEditor an editor used to load the current barcode families and properties.
    
    persist - boolean if the property must be persistent or not across reboots.
    
    Returns:
    
    int ConfigException.SUCCESSvin case of success, otherwise a possible error code, matching one of the ConfigException error constants.
    
    Throws:
    
    ConfigException - in case of error, when exceptions are enabled through the ErrorManager singleton.

Class ScannerProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.datalogic.device.configuration.PropertyGroup

Methods inherited from class java.lang.Object

Field Detail

dnotification

format

goodread

scannerOptions

presentationMode

multiScan

intentWedge

keyboardWedge

displayNotification

webWedge

code39

code128

ean8

ean13

upcA

upcE

upcEanExtensions

code93

gs1DataBar_14

gs1DataBar_Expanded

gs1DataBar_Limited

interleaved25

matrix25

discrete25

codabar

msi

linearQZ

qrCode

microQr

aztec

datamatrix

pdf417

micropdf417

maxicode

pAus

pJap

pKix

pRM

pPlanet

pPostnet

p4State

digimarc

composite

dotcode

inverse

frameCaptureConfiguration

Constructor Detail

ScannerProperties

Method Detail

edit

store