Java tutorial
/* * Copyright 2009 ZXing authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.google.zxing.integration.android; import android.annotation.TargetApi; import android.app.Activity; import android.app.Fragment; import android.content.Intent; import android.os.Build; import android.os.Bundle; import com.google.zxing.client.android.Intents; import com.journeyapps.barcodescanner.CaptureActivity; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; /** * * @author Sean Owen * @author Fred Lin * @author Isaac Potoczny-Jones * @author Brad Drehmer * @author gcstang */ @SuppressWarnings("unused") public class CustomerIntentIntegrator { public static final int REQUEST_CODE = 0x0000c0de; // Only use bottom 16 bits private static final String TAG = CustomerIntentIntegrator.class.getSimpleName(); // supported barcode formats public static final Collection<String> PRODUCT_CODE_TYPES = list("UPC_A", "UPC_E", "EAN_8", "EAN_13", "RSS_14"); public static final Collection<String> ONE_D_CODE_TYPES = list("UPC_A", "UPC_E", "EAN_8", "EAN_13", "CODE_39", "CODE_93", "CODE_128", "ITF", "RSS_14", "RSS_EXPANDED"); public static final Collection<String> QR_CODE_TYPES = Collections.singleton("QR_CODE"); public static final Collection<String> DATA_MATRIX_TYPES = Collections.singleton("DATA_MATRIX"); public static final Collection<String> ALL_CODE_TYPES = null; private final Activity activity; private Fragment fragment; private android.support.v4.app.Fragment supportFragment; private final Map<String, Object> moreExtras = new HashMap<String, Object>(3); private Collection<String> desiredBarcodeFormats; private Class<?> captureActivity; protected Class<?> getDefaultCaptureActivity() { return CaptureActivity.class; } /** * @param activity {@link Activity} invoking the integration */ public CustomerIntentIntegrator(Activity activity) { this.activity = activity; } public Class<?> getCaptureActivity() { if (captureActivity == null) { captureActivity = getDefaultCaptureActivity(); } return captureActivity; } /** * Set the Activity class to use. It can be any activity, but should handle the intent extras * as used here. * * @param captureActivity the class */ public CustomerIntentIntegrator setCaptureActivity(Class<?> captureActivity) { this.captureActivity = captureActivity; return this; } /** * @param fragment {@link Fragment} invoking the integration. * {@link #startActivityForResult(Intent, int)} will be called on the {@link Fragment} instead * of an {@link Activity} */ public static CustomerIntentIntegrator forSupportFragment(android.support.v4.app.Fragment fragment) { CustomerIntentIntegrator integrator = new CustomerIntentIntegrator(fragment.getActivity()); integrator.supportFragment = fragment; return integrator; } /** * @param fragment {@link Fragment} invoking the integration. * {@link #startActivityForResult(Intent, int)} will be called on the {@link Fragment} instead * of an {@link Activity} */ @TargetApi(Build.VERSION_CODES.HONEYCOMB) public static CustomerIntentIntegrator forFragment(Fragment fragment) { CustomerIntentIntegrator integrator = new CustomerIntentIntegrator(fragment.getActivity()); integrator.fragment = fragment; return integrator; } public Map<String, ?> getMoreExtras() { return moreExtras; } public final CustomerIntentIntegrator addExtra(String key, Object value) { moreExtras.put(key, value); return this; } /** * Set a prompt to display on the capture screen, instead of using the default. * * @param prompt the prompt to display */ public final CustomerIntentIntegrator setPrompt(String prompt) { if (prompt != null) { addExtra(Intents.Scan.PROMPT_MESSAGE, prompt); } return this; } /** * By default, the orientation is locked. Set to false to not lock. * * @param locked true to lock orientation */ public CustomerIntentIntegrator setOrientationLocked(boolean locked) { addExtra(Intents.Scan.ORIENTATION_LOCKED, locked); return this; } /** * Use the specified camera ID. * * @param cameraId camera ID of the camera to use. A negative value means "no preference". * @return this */ public CustomerIntentIntegrator setCameraId(int cameraId) { if (cameraId >= 0) { addExtra(Intents.Scan.CAMERA_ID, cameraId); } return this; } /** * Set to false to disable beep on scan. * * @param enabled false to disable beep * @return this */ public CustomerIntentIntegrator setBeepEnabled(boolean enabled) { addExtra(Intents.Scan.BEEP_ENABLED, enabled); return this; } /** * Set to true to enable saving the barcode image and sending its path in the result Intent. * * @param enabled true to enable barcode image * @return this */ public CustomerIntentIntegrator setBarcodeImageEnabled(boolean enabled) { addExtra(Intents.Scan.BARCODE_IMAGE_ENABLED, enabled); return this; } /** * Set the desired barcode formats to scan. * * @param desiredBarcodeFormats names of {@code BarcodeFormat}s to scan for * @return this */ public CustomerIntentIntegrator setDesiredBarcodeFormats(Collection<String> desiredBarcodeFormats) { this.desiredBarcodeFormats = desiredBarcodeFormats; return this; } /** * Initiates a scan for all known barcode types with the default camera. */ public final void initiateScan() { startActivityForResult(createScanIntent(), REQUEST_CODE); } /** * Create an scan intent with the specified options. * * @return the intent */ public Intent createScanIntent() { Intent intentScan = new Intent(activity, getCaptureActivity()); intentScan.setAction(Intents.Scan.ACTION); // check which types of codes to scan for if (desiredBarcodeFormats != null) { // set the desired barcode types StringBuilder joinedByComma = new StringBuilder(); for (String format : desiredBarcodeFormats) { if (joinedByComma.length() > 0) { joinedByComma.append(','); } joinedByComma.append(format); } intentScan.putExtra(Intents.Scan.FORMATS, joinedByComma.toString()); } intentScan.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); intentScan.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET); attachMoreExtras(intentScan); return intentScan; } /** * Initiates a scan, only for a certain set of barcode types, given as strings corresponding * to their names in ZXing's {@code BarcodeFormat} class like "UPC_A". You can supply constants * like {@link #PRODUCT_CODE_TYPES} for example. * * @param desiredBarcodeFormats names of {@code BarcodeFormat}s to scan for */ public final void initiateScan(Collection<String> desiredBarcodeFormats) { setDesiredBarcodeFormats(desiredBarcodeFormats); initiateScan(); } /** * Start an activity. This method is defined to allow different methods of activity starting for * newer versions of Android and for compatibility library. * * @param intent Intent to start. * @param code Request code for the activity * @see Activity#startActivityForResult(Intent, int) * @see Fragment#startActivityForResult(Intent, int) */ protected void startActivityForResult(Intent intent, int code) { if (fragment != null) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) { fragment.startActivityForResult(intent, code); } } else if (supportFragment != null) { supportFragment.startActivityForResult(intent, code); } else { activity.startActivityForResult(intent, code); } } protected void startActivity(Intent intent) { if (fragment != null) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) { fragment.startActivity(intent); } } else if (supportFragment != null) { supportFragment.startActivity(intent); } else { activity.startActivity(intent); } } /** * <p>Call this from your {@link Activity}'s * {@link Activity#onActivityResult(int, int, Intent)} method.</p> * * @param requestCode request code from {@code onActivityResult()} * @param resultCode result code from {@code onActivityResult()} * @param intent {@link Intent} from {@code onActivityResult()} * @return null if the event handled here was not related to this class, or * else an {@link IntentResult} containing the result of the scan. If the user cancelled scanning, * the fields will be null. */ public static CustomerIntentResult parseActivityResult(int requestCode, int resultCode, Intent intent) { if (requestCode == REQUEST_CODE) { if (resultCode == Activity.RESULT_OK) { String contents = intent.getStringExtra(Intents.Scan.RESULT); String formatName = intent.getStringExtra(Intents.Scan.RESULT_FORMAT); byte[] rawBytes = intent.getByteArrayExtra(Intents.Scan.RESULT_BYTES); int intentOrientation = intent.getIntExtra(Intents.Scan.RESULT_ORIENTATION, Integer.MIN_VALUE); Integer orientation = intentOrientation == Integer.MIN_VALUE ? null : intentOrientation; String errorCorrectionLevel = intent.getStringExtra(Intents.Scan.RESULT_ERROR_CORRECTION_LEVEL); String barcodeImagePath = intent.getStringExtra(Intents.Scan.RESULT_BARCODE_IMAGE_PATH); return new CustomerIntentResult(contents, formatName, rawBytes, orientation, errorCorrectionLevel, barcodeImagePath); } return new CustomerIntentResult(); } return null; } private static List<String> list(String... values) { return Collections.unmodifiableList(Arrays.asList(values)); } private void attachMoreExtras(Intent intent) { for (Map.Entry<String, Object> entry : moreExtras.entrySet()) { String key = entry.getKey(); Object value = entry.getValue(); // Kind of hacky if (value instanceof Integer) { intent.putExtra(key, (Integer) value); } else if (value instanceof Long) { intent.putExtra(key, (Long) value); } else if (value instanceof Boolean) { intent.putExtra(key, (Boolean) value); } else if (value instanceof Double) { intent.putExtra(key, (Double) value); } else if (value instanceof Float) { intent.putExtra(key, (Float) value); } else if (value instanceof Bundle) { intent.putExtra(key, (Bundle) value); } else { intent.putExtra(key, value.toString()); } } } }