to top

Summary: Methods | Inherited Methods | [Expand All]

Added in revision 1

public class

PropertyGroup

extends Object

java.lang.Object
↳	com.datalogic.device.configuration.PropertyGroup

Known Direct Subclasses

Aztec, CameraWedge, Codabar, Code128, Code39, Code93, Composite, Datamatrix, DecodeResultCrop, DecodingNotification, Digimarc, Discrete25, DisplayNotification, DotCode, Ean13, and 41 others.

Aztec	`Aztec` is the class that configures the Aztec Code.
CameraWedge	`CameraWedge` is the class that allows to configure the scanner to act in place of the rear camera of the device.
Codabar	`Codabar` is the class that configures the Codabar Symbology.
Code128	`Code128` is the class that configures the Code 128, GS1-128 and ISBT 128 Symbologies.
Code39	`Code39` is the class that configures the Code39, Code32 and TriOptic Symbologies.
Code93	`Code93` is the class that configures the Code 93 Symbology.
Composite	`Composite` is the class that configures the EAN.UCC Composite and GS1 Composite Symbologies.
Datamatrix	`Datamatrix` is the class that configures the Data Matrix Symbology.
DecodeResultCrop	`DecodeResultCrop` is the class that allows to configure the decode result in order to include a crop of the decoded barcode or OCR.
DecodingNotification	`DecodingNotification` is the class that configures the notification to produce on a successful read .
Digimarc	`Digimarc`® is the class that configures the Digimarc barcode ™ reading capability.
Discrete25	`Discrete25` is the class that configures the Discrete 2/5 Symbology.
DisplayNotification	`DisplayNotification` is the class that configures the Display Notification capability via a displaying message.
DotCode	`DotCode` is the class that configures the Dot Code.
Ean13	`Ean13` is the class that configures the EAN-13 Symbology.
Ean8	`Ean8` is the class that configures the EAN-8 Symbology.
ExtScannerSource	`ExtScannerSource` is the class that configures the possibility to receive barcode results from an external scanner.
Formatting	`Formatting` is the class that configures the properties related to barcode text formatting.
FrameCaptureConfiguration	`FrameCaptureConfiguration` is the class responsible for configuring the scanner to capture, store, and provide frames during barcode scanning operations.
GoodRead	The `GoodRead` class configures various types of notifications that are triggered upon a successful read.
Gs1DataBar_14	`Gs1DataBar_14` is the class that configures the GS1 DataBar-14 Symbology.
Gs1DataBar_Expanded	`Gs1DataBar_Expanded` is the class that configures the GS1 DataBar Expanded Symbology.
Gs1DataBar_Limited	`Gs1DataBar_Limited` is the class that configures the GS1 DataBar Limited Symbology.
HanXin	`HanXin` is the class that configures the Han Xin Symbology.
IntentWedge	`IntentWedge` is the class that configures the Decode Wedge capability with the intent mode.
Interleaved25	`Interleaved25` is the class that configures the Interleaved 2/5 Symbology.
Inverse	`Inverse` is the class that configures the inverse mode for the supported linear and 2D symbologies.
KeyboardWedge	`KeyboardWedge` is the class that configures the Decode Wedge capability with the keystroke mode.
LinearQuietZones	`LinearQuietZones` is the class that configures the admitted quiet zones for the supported linear symbologies.
Matrix25	`Matrix25` is the class that configures the Matrix 2/5 Symbology.
Maxicode	`Maxicode` is the class that configures the Maxicode Symbology.
MicroQR	`MicroQR` is the class that configures the Micro QR Code Symbology.
Micropdf417	`Micropdf417` is the class that configures the MicroPDF-417 Symbology.
Msi	`Msi` is the class that configures the MSI Symbology.
MultiScan	`MultiScan` is the class that configures the Multi Scan functionality.
OCR	`OCR` is the class that configure the MRZ reader.
Pdf417	`Pdf417` is the class that configures the PDF 417 Symbology.
PostalAustralian	`PostalAustralian` is the class that configures the Postal Australian.
PostalJapan	`PostalJapan` is the class that configures the Postal Japan.
PostalKix	`PostalKix` is the class that configures the Postal Kix.
PostalRoyalMail	`PostalRoyalMail` is the class that configures the Postal Royal Mail.
PostalUsPlanet	`PostalUsPlanet` is the class that configures the Postal US Planet.
PostalUsPostnet	`PostalUsPostnet` is the class that configures the Postal US Postnet.
PostalUsps4State	`PostalUsps4State` is the class that configures the Postal USPS4State.
PresentationMode	`PresentationMode` is the class that configures the presentation mode functionalities.
QRCode	`QRCode` is the class that configures the QR Code Symbology.
ScannerOptions	`ScannerOptions` is the class that configures the scanner target beam and other scanner functionalities.
ScannerProperties	`ScannerProperties` is the scanner property container class.
SnapOcr	`SnapOcr` is the class that configures the Snap OCR feature, used to capture and provide OCR text found in the scanner/camera frames.
SnapOcrResultSettings	`SnapOcrResultSettings` is the class that configures the Snap OCR settings related to the OCR results.
SnapOcrUiCustomization	`SnapOcrUiCustomization` is the class that configures the Snap OCR settings related to the UI customization.
Tlc39	`Tlc39` is the class that configures the TLC 39 Symbology.
UpcA	`UpcA` is the class that configures the UPC-A Symbology.
UpcE	`UpcE` is the class that configures the UPC-E Symbology.
UpcEanExtensions	`UpcEanExtensions` is the class that configures the UPC/EAN Extensions.
WebWedge	`WebWedge` is the class that configures the Decode Wedge capability for direct web browsing.

Class Overview

PropertyGroup contains properties and/or other property groups.

Summary

Public Methods
ArrayList<PropertyGroup>	getGroups() Returns the property groups contained in this group, not in the whole subtree.
int	getId() Gets the integer value of the unique identifier `PropertyGroupID` of the group.
String	getName() Gets the name of the unique identifier`PropertyGroupID` of the group.
ArrayList<Property>	getProperties() Returns the properties contained in this group, not in the whole subtree.
Property	getPropertyById(int id) Gets the `Property`, belonging to this group's subtree, whose identifier has the given integer value in `PropertyID`.
Property	getPropertyByName(String name) Gets the `Property`, belonging to this group's subtree, whose identifier has the integer value defined by the given string in `PropertyID`.
PropertyGroup	getPropertyGroupById(int id) Gets the `PropertyGroup`, belonging to this group's subtree, whose identifier has the given integer value in `PropertyGroupID`.
PropertyGroup	getPropertyGroupByName(String name) Gets the `PropertyGroup`, belonging to this group's subtree, whose identifier has the integer value defined by the given string in `PropertyGroupID`.
boolean	isFullySupported() Tells if this property group is completely supported by the underling decoding hardware.
boolean	isSupported() Tells if this property group is supported by the underling decoding hardware.
int	load(PropertyGetter from) Load the properties values contained by this group from the PropertyGetter.
void	setToDefault() Resets to the default value all the properties contained in the subtree.
int	store(PropertyEditor to, boolean persist) Store the properties values contained by this property into the PropertyEditor persistently or not, depending from the `persist` parameter.

[Expand]

Inherited Methods

From class java.lang.Object

Public Methods

public ArrayList<PropertyGroup> getGroups ()

Added in revision 1

Returns the property groups contained in this group, not in the whole subtree.

Returns

ArrayList of property groups contained in the group.
Empty if there are no other property groups in this group, not in the whole subtree.

public int getId ()

Added in revision 27

Gets the integer value of the unique identifier PropertyGroupID of the group. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Returns

int.

public String getName ()

Added in revision 27

Gets the name of the unique identifierPropertyGroupID of the group. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Returns

String.

public ArrayList<Property> getProperties ()

Added in revision 1

Returns the properties contained in this group, not in the whole subtree.

Returns

ArrayList of properties contained in the group.
Empty if there are no properties in this group, not in the whole subtree.

public Property getPropertyById (int id)

Added in revision 27

Gets the Property, belonging to this group's subtree, whose identifier has the given integer value in PropertyID. If a property with the given id is not found NULL is returned. If the returned property is not supported, get and set on the property will fail. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Parameters

id	`int` unique identifier of the requested property.

Returns

Property.

public Property getPropertyByName (String name)

Added in revision 27

Gets the Property, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyID. If a property with the given name is not found NULL is returned. If the returned property is not supported, get and set on the property will fail. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Parameters

name	`String` defining string of the unique identifier of the requested property.

Returns

Property.

public PropertyGroup getPropertyGroupById (int id)

Added in revision 27

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Parameters

id	`int` unique identifier of the requested group.

Returns

PropertyGroup.

public PropertyGroup getPropertyGroupByName (String name)

Added in revision 27

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

Parameters

name	`String` name of the requested group.

Returns

PropertyGroup.

public boolean isFullySupported ()

Added in revision 4

Tells if this property group is completely supported by the underling decoding hardware.

Returns

true if all contained property are supported by the underling decoding hardware.
If this property group doesn't contain any property, this method returns false.

public boolean isSupported ()

Added in revision 1

Tells if this property group is supported by the underling decoding hardware.

Returns

true if at least one contained property is supported by the underling decoding hardware.
If this property group doesn't contain any property, this method returns false.

public int load (PropertyGetter from)

Added in revision 1

Load the properties values contained by this group from the PropertyGetter.

Parameters

from	The `PropertyGetter` called to synchronize the current values.

Returns

int SUCCESS in 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.

public void setToDefault ()

Added in revision 27

Resets to the default value all the properties contained in the subtree. To make the change persistent the commit() must be called. The method is meaningful only for propertyGroups of the ConfigurationManager tree not for the classes, derived from PropertyGroup, handled by BarcodeManager like for example Code39.

public int store (PropertyEditor to, boolean persist)

Added in revision 1

Store the properties values contained by this property into the PropertyEditor persistently or not, depending from the persist parameter.

Parameters

to	The `PropertyEditor` in charge of applying the desired values.
persist	`boolean` if true the configuration is saved in a persistent way across system reboots with an implicit call to `commitProperties()`; it could happens to persists properties not related to the property group and previously changed not persistently. See the `BarcodeManager` `persistance note`;

Returns

int SUCCESS in 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.

Results

Interfaces

Classes

Enums

Exceptions

PropertyGroup

Class Overview

Summary

Public Methods

public ArrayList<PropertyGroup> getGroups ()

Returns

public int getId ()

Returns

public String getName ()

Returns

public ArrayList<Property> getProperties ()

Returns

public Property getPropertyById (int id)

Parameters

Returns

public Property getPropertyByName (String name)

Parameters

Returns

public PropertyGroup getPropertyGroupById (int id)

Parameters

Returns

public PropertyGroup getPropertyGroupByName (String name)

Parameters

Returns

public boolean isFullySupported ()

Returns

public boolean isSupported ()

Returns

public int load (PropertyGetter from)

Parameters

Returns

Throws

public void setToDefault ()

public int store (PropertyEditor to, boolean persist)

Parameters

Returns

Throws