Class SelectionOverlayConfiguration
-
- All Implemented Interfaces:
-
java.io.Serializable
public final class SelectionOverlayConfiguration implements Serializable
Barcode Selection Overlay configuration
-
-
Field Summary
Fields Modifier and Type Field Description private Boolean
overlayEnabled
private Boolean
automaticSelectionEnabled
private BarcodeOverlayTextFormat
textFormat
private Integer
polygonColor
private Integer
textColor
private Integer
textContainerColor
private Integer
highlightedPolygonColor
private Integer
highlightedTextColor
private Integer
highlightedTextContainerColor
-
Constructor Summary
Constructors Constructor Description SelectionOverlayConfiguration(Boolean overlayEnabled, Boolean automaticSelectionEnabled, BarcodeOverlayTextFormat textFormat, Integer polygonColor, Integer textColor, Integer textContainerColor, Integer highlightedPolygonColor, Integer highlightedTextColor, Integer highlightedTextContainerColor)
-
Method Summary
Modifier and Type Method Description final Boolean
getOverlayEnabled()
Whether the barcode selection overlay is enabled or not. final Unit
setOverlayEnabled(Boolean overlayEnabled)
Whether the barcode selection overlay is enabled or not. final Boolean
getAutomaticSelectionEnabled()
Whether the barcode is selected automatically when being detected or not. final Unit
setAutomaticSelectionEnabled(Boolean automaticSelectionEnabled)
Whether the barcode is selected automatically when being detected or not. final BarcodeOverlayTextFormat
getTextFormat()
Define the way of how to show barcode data with selection overlay. final Unit
setTextFormat(BarcodeOverlayTextFormat textFormat)
Define the way of how to show barcode data with selection overlay. final Integer
getPolygonColor()
The color of the polygon in the selection overlay. final Unit
setPolygonColor(Integer polygonColor)
The color of the polygon in the selection overlay. final Integer
getTextColor()
The color of the text in the selection overlay. final Unit
setTextColor(Integer textColor)
The color of the text in the selection overlay. final Integer
getTextContainerColor()
The color of the texts background in the selection overlay. final Unit
setTextContainerColor(Integer textContainerColor)
The color of the texts background in the selection overlay. final Integer
getHighlightedPolygonColor()
The color of the polygon in the selection overlay, when highlighted. final Unit
setHighlightedPolygonColor(Integer highlightedPolygonColor)
The color of the polygon in the selection overlay, when highlighted. final Integer
getHighlightedTextColor()
The color of the text in the selection overlay, when highlighted. final Unit
setHighlightedTextColor(Integer highlightedTextColor)
The color of the text in the selection overlay, when highlighted. final Integer
getHighlightedTextContainerColor()
The color of the texts background in the selection overlay, when highlighted. final Unit
setHighlightedTextContainerColor(Integer highlightedTextContainerColor)
The color of the texts background in the selection overlay, when highlighted. -
-
Constructor Detail
-
SelectionOverlayConfiguration
SelectionOverlayConfiguration(Boolean overlayEnabled, Boolean automaticSelectionEnabled, BarcodeOverlayTextFormat textFormat, Integer polygonColor, Integer textColor, Integer textContainerColor, Integer highlightedPolygonColor, Integer highlightedTextColor, Integer highlightedTextContainerColor)
-
-
Method Detail
-
getOverlayEnabled
final Boolean getOverlayEnabled()
Whether the barcode selection overlay is enabled or not.
-
setOverlayEnabled
final Unit setOverlayEnabled(Boolean overlayEnabled)
Whether the barcode selection overlay is enabled or not.
-
getAutomaticSelectionEnabled
final Boolean getAutomaticSelectionEnabled()
Whether the barcode is selected automatically when being detected or not. By default -
false
.
-
setAutomaticSelectionEnabled
final Unit setAutomaticSelectionEnabled(Boolean automaticSelectionEnabled)
Whether the barcode is selected automatically when being detected or not. By default -
false
.
-
getTextFormat
final BarcodeOverlayTextFormat getTextFormat()
Define the way of how to show barcode data with selection overlay. By default - BarcodeOverlayTextFormat.CODE.
-
setTextFormat
final Unit setTextFormat(BarcodeOverlayTextFormat textFormat)
Define the way of how to show barcode data with selection overlay. By default - BarcodeOverlayTextFormat.CODE.
-
getPolygonColor
final Integer getPolygonColor()
The color of the polygon in the selection overlay. By default - Color.WHITE.
-
setPolygonColor
final Unit setPolygonColor(Integer polygonColor)
The color of the polygon in the selection overlay. By default - Color.WHITE.
-
getTextColor
final Integer getTextColor()
The color of the text in the selection overlay. By default - Color.BLACK.
-
setTextColor
final Unit setTextColor(Integer textColor)
The color of the text in the selection overlay. By default - Color.BLACK.
-
getTextContainerColor
final Integer getTextContainerColor()
The color of the texts background in the selection overlay. By default - Color.WHITE.
-
setTextContainerColor
final Unit setTextContainerColor(Integer textContainerColor)
The color of the texts background in the selection overlay. By default - Color.WHITE.
-
getHighlightedPolygonColor
final Integer getHighlightedPolygonColor()
The color of the polygon in the selection overlay, when highlighted. By default -
null
.
-
setHighlightedPolygonColor
final Unit setHighlightedPolygonColor(Integer highlightedPolygonColor)
The color of the polygon in the selection overlay, when highlighted. By default -
null
.
-
getHighlightedTextColor
final Integer getHighlightedTextColor()
The color of the text in the selection overlay, when highlighted. By default -
null
.
-
setHighlightedTextColor
final Unit setHighlightedTextColor(Integer highlightedTextColor)
The color of the text in the selection overlay, when highlighted. By default -
null
.
-
getHighlightedTextContainerColor
final Integer getHighlightedTextContainerColor()
The color of the texts background in the selection overlay, when highlighted. By default -
null
.
-
setHighlightedTextContainerColor
final Unit setHighlightedTextContainerColor(Integer highlightedTextContainerColor)
The color of the texts background in the selection overlay, when highlighted. By default -
null
.
-
-
-
-