ScanFragment (IScan - The Indian Scanner App || Source Documentation)

java.lang.Object
- android.app.Fragment
- - com.nalinstudios.iscan.scanlibrary.ScanFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.View.OnCreateContextMenuListener
```
public class ScanFragment
extends android.app.Fragment
```
A customized version of ScanFragment

Author:

Nalin Angrish, Jhansi.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`ScanFragment.ScanAsyncTask` A class to scan the image on the click of the button.
`private class`	`ScanFragment.ScanButtonClickListener` A class to know when to scan the image.

Nested classes/interfaces inherited from class android.app.Fragment
android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields
Modifier and Type	Field and Description
`private android.graphics.Bitmap`	`original` The image to be cropped
`private PolygonView`	`polygonView` The polygonView to mark the corners
`private ProgressDialogFragment`	`progressDialogFragment` The Fragment to show when any operation is being performed
`android.widget.Button`	`scanButton` A button to approve the corners selected by the user
`private android.widget.FrameLayout`	`sourceFrame` The frame containing the source image
`private android.widget.ImageView`	`sourceImageView` The imageView containing the image to be cropped
`private android.view.View`	`view` The root view of the fragment

Fields inherited from interface android.content.ComponentCallbacks2
TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors
Constructor and Description

ScanFragment()

Constructors
Constructor and Description
`ScanFragment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`dismissDialog()` A function to dismiss the progress dialog.
`private void`	`getBitmap()` Get the bitmap asynchronously set by the user
`private java.util.List<android.graphics.PointF>`	`getContourEdgePoints(android.graphics.Bitmap tempBitmap)` A function to get the points of the corners
`private java.util.Map<java.lang.Integer,android.graphics.PointF>`	`getEdgePoints(android.graphics.Bitmap tempBitmap)` Get edge points (corners)
`private java.util.Map<java.lang.Integer,android.graphics.PointF>`	`getOutlinePoints(android.graphics.Bitmap tempBitmap)` The outline points of the image (the actual image)
`private android.graphics.Bitmap`	`getScannedBitmap(android.graphics.Bitmap original, java.util.Map<java.lang.Integer,android.graphics.PointF> points)` A function to crop the image to the given points
`private android.net.Uri`	`getUri()` The URI of the bitmap
`private void`	`init()` The main function of the Fragment
`private boolean`	`isScanPointsValid(java.util.Map<java.lang.Integer,android.graphics.PointF> points)` A function to check whether the given points correspond to a quadrilateral or not.
`android.view.View`	`onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)` A function to create the view and start the main function (the init function)
`void`	`onReceiveBitmap(android.graphics.Bitmap bitmap)` A function to receive the requested bitmap
`private java.util.Map<java.lang.Integer,android.graphics.PointF>`	`orderedValidEdgePoints(android.graphics.Bitmap tempBitmap, java.util.List<android.graphics.PointF> pointFs)` A function to order the edge points
`private android.graphics.Bitmap`	`scaledBitmap(android.graphics.Bitmap bitmap, int width, int height)` A function to scale a bitmap
`private void`	`setBitmap(android.graphics.Bitmap original)` A function to set the image in the fragment
`private void`	`showErrorDialog()` A function to show an error dialog.
`protected void`	`showProgressDialog(java.lang.String message)` A function to show the progress dialog.

Methods inherited from class android.app.Fragment
dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreate, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onSaveInstanceState, onStart, onStop, onTrimMemory, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - original
```
private android.graphics.Bitmap original
```
    The image to be cropped
  - polygonView
```
private PolygonView polygonView
```
    The polygonView to mark the corners
  - progressDialogFragment
```
private ProgressDialogFragment progressDialogFragment
```
    The Fragment to show when any operation is being performed
  - scanButton
```
public android.widget.Button scanButton
```
    A button to approve the corners selected by the user
  - sourceFrame
```
private android.widget.FrameLayout sourceFrame
```
    The frame containing the source image
  - sourceImageView
```
private android.widget.ImageView sourceImageView
```
    The imageView containing the image to be cropped
  - view
```
private android.view.View view
```
    The root view of the fragment
- Constructor Detail
  - ScanFragment
```
public ScanFragment()
```
- Method Detail
  - dismissDialog
```
protected void dismissDialog()
```
    A function to dismiss the progress dialog.
  - getBitmap
```
private void getBitmap()
```
    Get the bitmap asynchronously set by the user
  - getContourEdgePoints
```
private java.util.List<android.graphics.PointF> getContourEdgePoints(android.graphics.Bitmap tempBitmap)
```
    A function to get the points of the corners
    
    Parameters:
    
    tempBitmap - the bitmap to find the corners in
    
    Returns:
    
    the List of points
  - getEdgePoints
```
private java.util.Map<java.lang.Integer,android.graphics.PointF> getEdgePoints(android.graphics.Bitmap tempBitmap)
```
    Get edge points (corners)
    
    Parameters:
    
    tempBitmap - the bitmap to track on
    
    Returns:
    
    the Map of corners
  - getOutlinePoints
```
private java.util.Map<java.lang.Integer,android.graphics.PointF> getOutlinePoints(android.graphics.Bitmap tempBitmap)
```
    The outline points of the image (the actual image)
    
    Parameters:
    
    tempBitmap - the image to get points of
    
    Returns:
    
    a list of Integer-Point pairs.
  - getScannedBitmap
```
private android.graphics.Bitmap getScannedBitmap(android.graphics.Bitmap original,
                                                 java.util.Map<java.lang.Integer,android.graphics.PointF> points)
```
    A function to crop the image to the given points
    
    Parameters:
    
    original - the image to be cropped
    
    points - the points to crop the image from
    
    Returns:
    
    the cropped image
  - getUri
```
private android.net.Uri getUri()
```
    The URI of the bitmap
    
    Returns:
    
    the URI
  - init
```
private void init()
```
    The main function of the Fragment
  - isScanPointsValid
```
private boolean isScanPointsValid(java.util.Map<java.lang.Integer,android.graphics.PointF> points)
```
    A function to check whether the given points correspond to a quadrilateral or not.
    
    Parameters:
    
    points - the points to check
    
    Returns:
    
    whether or not thee corners make a quadrilateral
  - onCreateView
```
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)
```
    A function to create the view and start the main function (the init function)
    
    Overrides:
    
    onCreateView in class android.app.Fragment
    
    Parameters:
    
    inflater - the default LayoutInflator
    
    container - the default container
    
    savedInstanceState - the save state of the fragment (not used)
    
    Returns:
    
    the inflated view.
  - onReceiveBitmap
```
public void onReceiveBitmap(android.graphics.Bitmap bitmap)
```
    A function to receive the requested bitmap
    
    Parameters:
    
    bitmap - the requested bitmap
  - orderedValidEdgePoints
```
private java.util.Map<java.lang.Integer,android.graphics.PointF> orderedValidEdgePoints(android.graphics.Bitmap tempBitmap,
                                                                                        java.util.List<android.graphics.PointF> pointFs)
```
    A function to order the edge points
    
    Parameters:
    
    tempBitmap - the bitmap to get ordered points of.
    
    pointFs - the points to be ordered
    
    Returns:
    
    a list of Integer-Point pairs.
  - scaledBitmap
```
private android.graphics.Bitmap scaledBitmap(android.graphics.Bitmap bitmap,
                                             int width,
                                             int height)
```
    A function to scale a bitmap
    
    Parameters:
    
    bitmap - the bitmap to be scaled
    
    width - the width to be scaled to.
    
    height - the height to be scaled to.
    
    Returns:
    
    the scaled bitmap
  - setBitmap
```
private void setBitmap(android.graphics.Bitmap original)
```
    A function to set the image in the fragment
    
    Parameters:
    
    original - the image to be set.
  - showErrorDialog
```
private void showErrorDialog()
```
    A function to show an error dialog.
  - showProgressDialog
```
protected void showProgressDialog(java.lang.String message)
```
    A function to show the progress dialog.
    
    Parameters:
    
    message - the message to show.

Class ScanFragment

Nested Class Summary

Nested classes/interfaces inherited from class android.app.Fragment

Field Summary

Fields inherited from interface android.content.ComponentCallbacks2

Constructor Summary

Method Summary

Methods inherited from class android.app.Fragment

Methods inherited from class java.lang.Object

Field Detail

original

polygonView

progressDialogFragment

scanButton

sourceFrame

sourceImageView

view

Constructor Detail

ScanFragment

Method Detail

dismissDialog

getBitmap

getContourEdgePoints

getEdgePoints

getOutlinePoints

getScannedBitmap

getUri

init

isScanPointsValid

onCreateView

onReceiveBitmap

orderedValidEdgePoints

scaledBitmap

setBitmap

showErrorDialog

showProgressDialog