| java.lang.Object | ||
| ↳ | com.datalogic.device.configuration.PropertyGroup | |
| ↳ | com.datalogic.decode.configuration.GoodRead | |
The GoodRead class configures various types of notifications that are triggered
upon a successful read. It includes options for enabling or disabling different notification methods,
such as LED indicators, vibration, and an overlay on the screen.
The class provides properties for customizing each type of notification, allowing developers to fine-tune the user experience based on their specific requirements.
The GoodRead class also includes an advanced notification mechanism called the "Good Read Overlay".
This overlay appears on the screen upon a successful read and can be customized in terms of color, shape, size,
and position. The overlay is adaptable to both portrait and landscape modes, allowing for flexible configuration
based on the device's orientation.
The portrait and landscape properties are not mutually exclusive; both sets of properties
should be configured. Depending on the device's orientation, the appropriate properties will be applied
(portrait settings for portrait mode and landscape settings for landscape mode).
The class GoodReadOverlayManager provides methods to manage custom images to be used as
overlay.
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| goodReadEnable | goodReadEnable requires the use of the good read
notification on a successful read. |
||||||||||
| goodReadLedEnable | goodReadLedEnable requires the use of the led notification
on a successful read. |
||||||||||
| goodReadOverlayColor | goodReadOverlayColor selects which color to use on the overlay as notification
on a successful read. |
||||||||||
| goodReadOverlayCustomShapeNameProfile | goodReadOverlayCustomShapeNameProfile selects which custom shape to use on the
overlay as notification on a successful read. |
||||||||||
| goodReadOverlayEnable | goodReadOverlayEnable requires the use of an overlay as notification
on a successful read. |
||||||||||
| goodReadOverlayLandscapeCustomPositionX | goodReadOverlayLandscapeCustomPositionX selects which custom position for the
starting X coordinate (starting from the left) to use for the overlay in landscape mode. |
||||||||||
| goodReadOverlayLandscapeCustomPositionY | goodReadOverlayLandscapeCustomPositionY selects which custom position for the
starting Y coordinate (starting from the top) to use for the overlay in landscape mode. |
||||||||||
| goodReadOverlayLandscapeCustomSizeMaxHeight | goodReadOverlayLandscapeCustomSizeMaxHeight selects which custom height for the
overlay to use in landscape mode. |
||||||||||
| goodReadOverlayLandscapeCustomSizeMaxWidth | goodReadOverlayLandscapeCustomSizeMaxWidth selects which custom width for the
overlay to use in landscape mode. |
||||||||||
| goodReadOverlayLandscapeDisplayPolicy | goodReadOverlayLandscapeDisplayPolicy selects which node to use for the
overlay in landscape mode. |
||||||||||
| goodReadOverlayLandscapePositionPolicy | goodReadOverlayLandscapePositionPolicy selects which position to use for the
overlay in landscape mode. |
||||||||||
| goodReadOverlayPortraitCustomPositionX | goodReadOverlayPortraitCustomPositionX selects which custom position for the
starting X coordinate (starting from the left) to use for the overlay in portrait mode. |
||||||||||
| goodReadOverlayPortraitCustomPositionY | goodReadOverlayPortraitCustomPositionY selects which custom position for the
starting Y coordinate (starting from the top) to use for the overlay in portrait mode. |
||||||||||
| goodReadOverlayPortraitCustomSizeMaxHeight | goodReadOverlayPortraitCustomSizeMaxHeight defines the max custom height for the
overlay to use in portrait mode. |
||||||||||
| goodReadOverlayPortraitCustomSizeMaxWidth | goodReadOverlayPortraitCustomSizeMaxWidth defines the max custom width for the
overlay to use in portrait mode. |
||||||||||
| goodReadOverlayPortraitDisplayPolicy | goodReadOverlayPortraitDisplayPolicy selects how to display the
overlay in portrait mode. |
||||||||||
| goodReadOverlayPortraitPositionPolicy | goodReadOverlayPortraitPositionPolicy selects which position to use for the
overlay in portrait mode. |
||||||||||
| goodReadOverlayShapePolicy | goodReaderOverlayShapePolicy selects which shape to use on the overlay as notification
on a successful read. |
||||||||||
| goodReadVibrateEnable | goodReadVibrateEnable requires the use of the vibrator
notification on a successful read. |
||||||||||
| greenSpotEnable | greenSpotEnable requires the use of the green spot
notification on a successful read. |
||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This is the constructor of GoodRead.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.datalogic.device.configuration.PropertyGroup
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
goodReadEnable requires the use of the good read
notification on a successful read.
goodReadLedEnable requires the use of the led notification
on a successful read.
goodReadOverlayColor selects which color to use on the overlay as notification
on a successful read. If the property GOOD_READ_OVERLAY_SHAPE_POLICY is set to FULL_SCREEN
once a code is decoded, the full screen of the device is painted with the color selected otherwise
the color is applied on the whole image selected excluding the trasparent areas and painted on top
of the screen. The color of the selected image has no effect, only its opacity. This property uses an ARGB format (32bit 8bpc).
goodReadOverlayCustomShapeNameProfile selects which custom shape to use on the
overlay as notification on a successful read.
goodReadOverlayEnable requires the use of an overlay as notification
on a successful read.
goodReadOverlayLandscapeCustomPositionX selects which custom position for the
starting X coordinate (starting from the left) to use for the overlay in landscape mode.
goodReadOverlayLandscapeCustomPositionY selects which custom position for the
starting Y coordinate (starting from the top) to use for the overlay in landscape mode.
goodReadOverlayLandscapeCustomSizeMaxHeight selects which custom height for the
overlay to use in landscape mode.
goodReadOverlayLandscapeCustomSizeMaxWidth selects which custom width for the
overlay to use in landscape mode.
goodReadOverlayLandscapeDisplayPolicy selects which node to use for the
overlay in landscape mode.
goodReadOverlayLandscapePositionPolicy selects which position to use for the
overlay in landscape mode.
goodReadOverlayPortraitCustomPositionX selects which custom position for the
starting X coordinate (starting from the left) to use for the overlay in portrait mode.
goodReadOverlayPortraitCustomPositionY selects which custom position for the
starting Y coordinate (starting from the top) to use for the overlay in portrait mode.
goodReadOverlayPortraitCustomSizeMaxHeight defines the max custom height for the
overlay to use in portrait mode.
goodReadOverlayPortraitCustomSizeMaxWidth defines the max custom width for the
overlay to use in portrait mode.
goodReadOverlayPortraitDisplayPolicy selects how to display the
overlay in portrait mode.
goodReadOverlayPortraitPositionPolicy selects which position to use for the
overlay in portrait mode.
goodReaderOverlayShapePolicy selects which shape to use on the overlay as notification
on a successful read.
goodReadVibrateEnable requires the use of the vibrator
notification on a successful read.
greenSpotEnable requires the use of the green spot
notification on a successful read.
This is the constructor of GoodRead. All options are initialized by editor.
| editor | A PropertyGetter used to load the current barcode family.
|
|---|