Atalasoft MobileImage API Reference
Classes | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl Class Reference

The view shows the image as captured by the camera/gallery and image from imageprocessing. More...

Inheritance diagram for com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl:

Classes

enum  Line_Style_Solid
 An enum which lists the drawing style options the edge of the tetragon. More...
 
class  MyScaleGestureListener
 

Public Member Functions

void setImage (Image i) throws KmcException
 Image that is to be reviewed and/or edited. More...
 
Image getImage ()
 Image that is to be reviewed and/or edited. More...
 
void showCropRectangle (boolean isVisible)
 Displays cropping rectangle with draggable corner indicators. More...
 
int getCropLineColor ()
 The ARGB line color of the bounding rect/tetragon. More...
 
void setCropLineColor (int lColor)
 The ARGB line color of the bounding rect/tetragon. More...
 
int getCropCornerColor ()
 The ARGB corner color of the bounding rect/tetragon. More...
 
void setCropCornerColor (int cColor)
 The ARGB corner color of the bounding rect/tetragon. More...
 
void setCropLineStyle (Line_Style_Solid myStyle)
 The ARGB line style of the bounding rect/tetragon sides. More...
 
void setCropTetragon (BoundingTetragon bt)
 Contains coordinates of all four tetragon corners. May or may not be a rectangle. More...
 
void showHighlights (BoundingRect[] rectArr)
 
void clearHighlights ()
 
void setHighlightColor (int color)
 
BoundingTetragon getCropTetragon ()
 Returns the coordinates of all four tetragon corners. May or may not be a rectangle. More...
 
 ImgReviewEditCntrl (Context context)
 
 ImgReviewEditCntrl (Context context, AttributeSet attrs)
 
 ImgReviewEditCntrl (Context context, AttributeSet attrs, int defStyle)
 
void setImageFilePath (String imageFilePath)
 
boolean onTouch (View v, MotionEvent event)
 
Parcelable onSaveInstanceState ()
 
void onRestoreInstanceState (Parcelable state)
 
void clearImage ()
 

Public Attributes

ScaleGestureDetector scaleGestureDetector
 

Protected Member Functions

void onDraw (Canvas canvas)
 
void onSizeChanged (int w, int h, int oldw, int oldh)
 

Detailed Description

The view shows the image as captured by the camera/gallery and image from imageprocessing.

This is the view which is presented to the user when either a picture is taken or chosen photo from the photo gallery. When the image processor is done processing either via quick analysis or direct processing the output image can be viewed in the control.

Constructor & Destructor Documentation

com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.ImgReviewEditCntrl ( Context  context)
inline
com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.ImgReviewEditCntrl ( Context  context,
AttributeSet  attrs 
)
inline
com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.ImgReviewEditCntrl ( Context  context,
AttributeSet  attrs,
int  defStyle 
)
inline

Member Function Documentation

void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.clearHighlights ( )
inline

Function to clear highlights from the widget.

void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.clearImage ( )
inline

Removes the bitmap from the control.

int com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.getCropCornerColor ( )
inline

The ARGB corner color of the bounding rect/tetragon.

The ARGB corner color of the bounding rect/tetragon. Range = 0x00000000 0xFFFFFFFF

Returns
- tetragon corner color
int com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.getCropLineColor ( )
inline

The ARGB line color of the bounding rect/tetragon.

The ARGB line color of the bounding rect/tetragon. Range = 0x00000000 0xFFFFFFFF

Returns
color of the edge of the tetragon
BoundingTetragon com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.getCropTetragon ( )
inline

Returns the coordinates of all four tetragon corners. May or may not be a rectangle.

Returns a BoundingTetragon object which has four points, each point corresponds to a corner of the tetragon. The tetragon consists of the integer coordinates of its top-left, top-right, bottom-left, and bottom-right edges.

Returns
- tetragon that defines the corners of the cropped image or image
Image com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.getImage ( )
inline

Image that is to be reviewed and/or edited.

The image scale and size is the same as the original image The image internally is downsized for viewing purposes only

Returns
image object
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.onDraw ( Canvas  canvas)
inlineprotected
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.onRestoreInstanceState ( Parcelable  state)
inline
Parcelable com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.onSaveInstanceState ( )
inline
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.onSizeChanged ( int  w,
int  h,
int  oldw,
int  oldh 
)
inlineprotected
boolean com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.onTouch ( View  v,
MotionEvent  event 
)
inline
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setCropCornerColor ( int  cColor)
inline

The ARGB corner color of the bounding rect/tetragon.

The ARGB corner color of the bounding rect/tetragon. Range = 0x00000000 0xFFFFFFFF

Parameters
cColor
  • color for the corner of the rectangle, default is blue
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setCropLineColor ( int  lColor)
inline

The ARGB line color of the bounding rect/tetragon.

The ARGB line color of the bounding rect/tetragon. Range = 0x00000000 0xFFFFFFFF

void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setCropLineStyle ( Line_Style_Solid  myStyle)
inline

The ARGB line style of the bounding rect/tetragon sides.

The ARGB line style of the bounding rect/tetragon sides. Range = 0x00000000 � 0xFFFFFFFF

Parameters
myStyle
  • This crop rectangle lines should be solid or dashed
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setCropTetragon ( BoundingTetragon  bt)
inline

Contains coordinates of all four tetragon corners. May or may not be a rectangle.

Contains coordinates of all four tetragon corners. May or may not be a rectangle. The tetragon consists of the integer coordinates of its top-left, top-right, bottom-left, and bottom-right edges.

Parameters
bt
  • bounding tetragon
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setHighlightColor ( int  color)
inline

Sets user defined color for the highlights. Default color is Yellow.

Parameters
color
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setImage ( Image  i) throws KmcException
inline

Image that is to be reviewed and/or edited.

If the size of the image is rather large and there isnt enough memory then we throw an exception asking the user to reduce the scaling factor further. If the user does not set a scaling factor the sdk will automatically down scale the image by 0.5 for viewing purposes. The original scale of the image will be maintained in the image object.

Parameters
i- image object
Exceptions
KmcException
KmcRuntimeException(ErrorInfo.KMC_UT_LICENSE_IMAGE_CAPTURE)
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.setImageFilePath ( String  imageFilePath)
inline
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.showCropRectangle ( boolean  isVisible)
inline

Displays cropping rectangle with draggable corner indicators.

Displays cropping rectangle with draggable corner indicators. Corners can be repositioned independently, creating a tetragon. Individual sides can be dragged to resize the rectangle and maintain the rectangular shape.

Parameters
isVisible
  • boolean
void com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.showHighlights ( BoundingRect[]  rectArr)
inline

Function to show highlights on the widget.

Parameters
rectArr
  • Array of BoundingRect containing screen coordinates of the highlight rectangles to be drawn.

Member Data Documentation

ScaleGestureDetector com.kofax.kmc.kui.uicontrols.ImgReviewEditCntrl.scaleGestureDetector

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.