Skip to content

[SDC-29428] Remove Java snippets #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JuanRomero-Scandit merged 1 commit into from
Feb 25, 2026
+6 −423
Merged

[SDC-29428] Remove Java snippets #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/hosted/express/getting-started/rollout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ To automatically synchronize your Scandit Express configuration with Scandit, yo
2. Click on your project card.

3. The Android Scandit Express App specifies the following Application Restriction:
```java
```xml
<restriction

android:key="deploymentCode"
Expand Down Expand Up @@ -118,4 +118,4 @@ Scandit Express automatically updates the license and configuration when restart

2. Tap on **Refresh Project**.

![Refresh Project](/img/express/refresh_project.png)
![Refresh Project](/img/express/refresh_project.png)
28 changes: 0 additions & 28 deletions docs/sdks/android/agents-android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,12 @@ This file guides coding agents (and humans!) to install and integrate the **Scan

## Initialize the SDK (Core)

Kotlin:
```kotlin
import com.scandit.datacapture.core.DataCaptureContext

val dataCaptureContext = DataCaptureContext.forLicenseKey(BuildConfig.SCANDIT_LICENSE_KEY)
```

Java:
```java
import com.scandit.datacapture.core.capture.DataCaptureContext;
DataCaptureContext dataCaptureContext =
DataCaptureContext.forLicenseKey(BuildConfig.SCANDIT_LICENSE_KEY);
```

> Tip: The built‑in UI components (e.g., `SparkScanView`, `BarcodeFindView`) manage camera start/stop when you route lifecycle calls to them.

---
Expand All @@ -78,7 +70,6 @@ DataCaptureContext dataCaptureContext =

**Dependencies**: `ScanditCaptureCore`, `ScanditBarcodeCapture`.

Kotlin (Activity/Fragment extract):
```kotlin
import com.scandit.datacapture.barcode.spark.ui.SparkScanView
import com.scandit.datacapture.barcode.spark.ui.SparkScanViewSettings
Expand Down Expand Up @@ -106,21 +97,6 @@ sparkScan.addListener(object : SparkScanListener {
})
```

Java (snippets equivalent):
```java
SparkScanSettings settings = new SparkScanSettings();
HashSet<Symbology> syms = new HashSet<>();
syms.add(Symbology.EAN13_UPCA);
settings.enableSymbologies(syms);

SparkScan sparkScan = new SparkScan(settings);
SparkScanViewSettings viewSettings = new SparkScanViewSettings();
SparkScanView sparkView = SparkScanView.newInstance(parentView, dataCaptureContext, sparkScan, viewSettings);

@Override protected void onResume() { sparkView.onResume(); super.onResume(); }
@Override protected void onPause() { sparkView.onPause(); super.onPause(); }
```

---

## Barcode Capture (low‑level single scan)
Expand All @@ -129,7 +105,6 @@ SparkScanView sparkView = SparkScanView.newInstance(parentView, dataCaptureConte

**Dependencies**: `ScanditCaptureCore`, `ScanditBarcodeCapture`.

Kotlin (essentials):
```kotlin
val barcodeSettings = BarcodeCaptureSettings().apply {
enableSymbologies(setOf(Symbology.CODE128, Symbology.QR))
Expand All @@ -155,7 +130,6 @@ barcodeCapture.addListener(object : BarcodeCaptureListener {
**When to use**: highlight items that match a *list*; quickly search shelves/containers.
**Note**: MatrixScan Count/Find are powered by **BarcodeFind** + **BarcodeFindView**.

Kotlin:
```kotlin
val findSettings = BarcodeFindSettings().apply {
setSymbologyEnabled(Symbology.EAN13_UPCA, true)
Expand Down Expand Up @@ -186,8 +160,6 @@ findView.setListener(object : BarcodeFindViewUiListener {
findView.startSearching()
```

Java equivalents mirror the above (per docs).

---

## Smart Label Capture (barcodes + printed text in one shot)
Expand Down
228 changes: 0 additions & 228 deletions docs/sdks/android/label-capture/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ To customize the appearance of an overlay you can implement a [LabelCaptureBasic

The method [brushForLabel()](https://docs.scandit.com/data-capture-sdk/android/label-capture/api/ui/label-capture-basic-overlay-listener.html#method-scandit.datacapture.label.ui.ILabelCaptureBasicOverlayListener.BrushForLabel) is called every time a label is captured, and [brushForField()](https://docs.scandit.com/data-capture-sdk/android/label-capture/api/ui/label-capture-basic-overlay-listener.html#method-scandit.datacapture.label.ui.ILabelCaptureBasicOverlayListener.BrushForField) is called for each of its fields to determine the brush for the label or field.

<Tabs groupId="language">
<TabItem value="kotlin" label="Kotlin">

```kotlin
overlay.listener = object : LabelCaptureBasicOverlayListener {
/*
Expand Down Expand Up @@ -55,49 +52,6 @@ overlay.listener = object : LabelCaptureBasicOverlayListener {
}

```
</TabItem>
<TabItem value="java" label="Java">

```java
overlay.setListener(new LabelCaptureBasicOverlayListener() {
@Nullable
@Override
public Brush brushForLabel(
@NonNull LabelCaptureBasicOverlay overlay,
@NonNull CapturedLabel label
) {
return null;
}

@Nullable
@Override
public Brush brushForField(
@NonNull LabelCaptureBasicOverlay overlay,
@NonNull LabelField field,
@NonNull CapturedLabel label
) {
if (field.getName().equals("<your-barcode-field-name>")) {
return new Brush(
getResources().getColor(R.color.barcode_overlay_fill),
getResources().getColor(R.color.barcode_overlay_stroke),
0f
);
}

if (field.getName().equals("<your-expiry-date-field-name>")) {
return new Brush(
getResources().getColor(R.color.expiry_date_overlay_fill),
getResources().getColor(R.color.expiry_date_overlay_stroke),
0f
);
}

return null;
}
});
```
</TabItem>
</Tabs>

:::tip
You can also use `LabelCaptureBasicOverlay.setLabelBrush()` and `LabelCaptureBasicOverlay.setCapturedFieldBrush()` to configure the overlay if you don't need to customize the appearance based on the name or content of the fields.
Expand All @@ -107,9 +61,6 @@ You can also use `LabelCaptureBasicOverlay.setLabelBrush()` and `LabelCaptureBas

For more advanced use cases, such as adding custom views or implementing Augmented Reality (AR) features, you can use the `LabelCaptureAdvancedOverlay`. The example below creates an advanced overlay, configuring it to display a styled warning message below expiry date fields when they’re close to expiring, while ignoring other fields.

<Tabs groupId="language">
<TabItem value="kotlin" label="Kotlin">

```kotlin
// Create an advanced overlay that allows for custom views to be added over detected label fields
// This is the key component for implementing Augmented Reality features
Expand Down Expand Up @@ -190,123 +141,6 @@ advancedOverlay.listener = object : LabelCaptureAdvancedOverlayListener {
}
```

</TabItem>
<TabItem value="java" label="Java">

```java
// Create an advanced overlay that allows for custom views to be added over detected label fields
// This is the key component for implementing Augmented Reality features
LabelCaptureAdvancedOverlay advancedOverlay = LabelCaptureAdvancedOverlay.newInstance(
labelCapture, dataCaptureView);

// Configure the advanced overlay with a listener that handles AR content creation and positioning
advancedOverlay.setListener(new LabelCaptureAdvancedOverlayListener() {

@Nullable
@Override
public View viewForCapturedLabel(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull CapturedLabel capturedLabel
) {
// We return null since we're only adding AR elements to specific fields, not the entire label
return null;
}

@NonNull
@Override
public Anchor anchorForCapturedLabel(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull CapturedLabel capturedLabel
) {
// This defines where on the detected label the AR view would be anchored
return Anchor.CENTER;
}

@NonNull
@Override
public PointWithUnit offsetForCapturedLabel(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull CapturedLabel capturedLabel,
@NonNull View view
) {
// This defines the offset from the anchor point for the label's AR view
return new PointWithUnit(
new FloatWithUnit(0f, MeasureUnit.PIXEL),
new FloatWithUnit(0f, MeasureUnit.PIXEL)
);
}

@Nullable
@Override
public View viewForCapturedLabelField(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull LabelField labelField
) {
// We only want to create AR elements for expiry date fields that are text-based
if (labelField.getName().toLowerCase().contains("expiry") &&
labelField.getType() == LabelFieldType.TEXT) {

//
// data extraction from expiry date field and days until expiry date calculation
//

// Assume we have a method `daysUntilExpiry()` that returns the days left until expiry
int daysUntilExpiry = daysUntilExpiry(labelField.getText());
int dayLimit = 3; // Example threshold

if (daysUntilExpiry < dayLimit) {
// Create and configure the AR element - a TextView with appropriate styling
// This view will appear as an overlay on the camera feed
TextView textView = new TextView(context);
textView.setText("Item expires soon!");
textView.setTextColor(Color.WHITE);
textView.setBackgroundColor(Color.RED);
textView.setPadding(16, 8, 16, 8);

// Add an icon to the left of the text for visual guidance
Drawable drawable = ContextCompat.getDrawable(context, R.drawable.ic_warning);
if (drawable != null) {
drawable.setBounds(0, 0, drawable.getIntrinsicWidth(), drawable.getIntrinsicHeight());
textView.setCompoundDrawables(drawable, null, null, null);
}
textView.setCompoundDrawablePadding(16); // Padding between icon and text

return textView;
}
}
// Return null for any fields that aren't expiry dates, which means no AR overlay
return null;
}

@NonNull
@Override
public Anchor anchorForCapturedLabelField(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull LabelField labelField
) {
// BOTTOM_CENTER places it right below the expiry date text for better visibility
return Anchor.BOTTOM_CENTER;
}

@NonNull
@Override
public PointWithUnit offsetForCapturedLabelField(
@NonNull LabelCaptureAdvancedOverlay overlay,
@NonNull LabelField labelField,
@NonNull View view
) {
// This defines the offset from the anchor point
return new PointWithUnit(
new FloatWithUnit(0f, MeasureUnit.DIP),
new FloatWithUnit(22f, MeasureUnit.DIP)
);
}
});
```
</TabItem>
</Tabs>


## Validation Flow

Implementing a validation flow in your Smart Label Capture application differs from the [Get Started](/sdks/android/label-capture/get-started.md) steps outlined earlier as follows:
Expand All @@ -315,9 +149,6 @@ Implementing a validation flow in your Smart Label Capture application differs f

Validation flow uses a different overlay, the [LabelCaptureValidationFlowOverlay](https://docs.scandit.com/data-capture-sdk/android/label-capture/api/ui/label-capture-validation-flow-overlay.html). This overlay provides a user interface that guides users through the label capture process, including validation steps.

<Tabs groupId="language">
<TabItem value="kotlin" label="Kotlin">

```kotlin
// Create the overlay
val validationFlowOverlay = LabelCaptureValidationFlowOverlay.newInstance(
Expand All @@ -329,27 +160,9 @@ val validationFlowOverlay = LabelCaptureValidationFlowOverlay.newInstance(
// Set the listener to receive validation events
validationFlowOverlay.listener = this
```
</TabItem>
<TabItem value="java" label="Java">

```java
// Create the overlay
validationFlowOverlay = LabelCaptureValidationFlowOverlay.newInstance(
getContext(),
labelCapture,
dataCaptureView
);
// Set the listener to receive validation events
validationFlowOverlay.setListener(this);
```
</TabItem>
</Tabs>

### Adjust the Hint Messages

<Tabs groupId="language">
<TabItem value="kotlin" label="Kotlin">

```kotlin
// Configure the validation flow with custom settings
val validationSettings = LabelCaptureValidationFlowSettings.newInstance().apply {
Expand All @@ -364,31 +177,11 @@ val validationSettings = LabelCaptureValidationFlowSettings.newInstance().apply
// Apply the settings to the overlay
validationFlowOverlay.applySettings(validationSettings)
```
</TabItem>

<TabItem value="java" label="Java">

```java
// Configure the validation flow with custom settings
LabelCaptureValidationFlowSettings validationSettings = LabelCaptureValidationFlowSettings.newInstance();

validationSettings.setStandbyHintText("No label detected, camera paused");
validationSettings.setValidationHintText("fields captured"); // X/Y (X fields out of total Y) is shown in front of this string
validationSettings.setValidationErrorText("Input not valid");

// Apply the settings to the overlay
validationFlowOverlay.applySettings(validationSettings);
```
</TabItem>
</Tabs>

### Define a Listener

To handle validation events, implement the [LabelCaptureValidationFlowOverlayListener](https://docs.scandit.com/data-capture-sdk/android/label-capture/api/ui/label-capture-validation-flow-listener.html) interface.

<Tabs groupId="language">
<TabItem value="kotlin" label="Kotlin">

```kotlin
// This is called by the validation flow overlay when a label has been fully captured and validated
override fun onValidationFlowLabelCaptured(fields: List<LabelField>) {
Expand All @@ -398,24 +191,3 @@ override fun onValidationFlowLabelCaptured(fields: List<LabelField>) {
val expiryDate = fields.find { it.name == "<your-expiry-date-field-name>" }?.text
}
```
</TabItem>
<TabItem value="java" label="Java">

```java
// This is called by the validation flow overlay when a label has been fully captured and validated
@Override
public void onValidationFlowLabelCaptured(@NonNull List<LabelField> fields) {

String barcodeData = null;
for (LabelField field : fields) {
if (field.getName().equals("<your-barcode-field-name>")) {
barcodeData = field.getBarcode().getData();
} else if (field.getName().equals("<your-expiry-date-field-name>")) {
String expiryDate = field.getText();
}
}
}
```
</TabItem>
</Tabs>

Loading