Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame Class Reference

This class handles various visual properties for the ImageCaptureView. More...

Public Member Functions

int getFrameWidth ()
 Gets the frame width. More...
 
void setFrameWidth (int frameWidth)
 Sets the frame width. More...
 
int getFrameHeight ()
 Gets the frame height. More...
 
void setFrameHeight (int frameHeight)
 Sets the frame height. More...
 
int getFrameBorderWidth ()
 Gets the frame capture border width. More...
 
void setFrameBorderWidth (int frameBorderWidth)
 Sets the frame capture border width. More...
 
int getFrameBorderColor ()
 Gets the frame border color. More...
 
void setFrameBorderColor (int frameBorderColor)
 Sets the frame border color. More...
 
int getFrameOuterColor ()
 Get the frame outer color. More...
 
void setFrameOuterColor (int frameOuterColor)
 Set the frame outer color. More...
 

Detailed Description

This class handles various visual properties for the ImageCaptureView.

This class handles various visual properties for the ImageCaptureView. Options include the ability to draw a frame to help the user line up a document with its borders, of which the border color, thickness, height, and width can be specified. There is also the option to obscure the area outside of this border with a set color.

Member Function Documentation

int com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.getFrameBorderColor ( )
inline

Gets the frame border color.

Description: Returns the color of the border of the capture frame.

Returns
An int that represents the RGBA value of the color.
int com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.getFrameBorderWidth ( )
inline

Gets the frame capture border width.

Description: This method returns an int that represents the width in pixels of the capture frame border.

Returns
Returns an int that represents the width in pixels of the capture frame border.
int com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.getFrameHeight ( )
inline

Gets the frame height.

Description: Gets the height of the frame.

Returns
The height of the frame in pixel units.
int com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.getFrameOuterColor ( )
inline

Get the frame outer color.

Description: Returns the color of the area outside of the capture frame.

Returns
An int that represents the RGBA value of the color.
int com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.getFrameWidth ( )
inline

Gets the frame width.

Description: Gets the width of the frame.

Returns
The width of the frame in pixel units.
void com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.setFrameBorderColor ( int  frameBorderColor)
inline

Sets the frame border color.

Description: Sets the color of the border of the capture frame.

Parameters
frameBorderColorAn int that represents the RGBA value of the desired border color.
Returns
void
void com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.setFrameBorderWidth ( int  frameBorderWidth)
inline

Sets the frame capture border width.

Description: Sets the width of the capture frame border.

Parameters
frameWidththe width of the capture frame border in pixel units.
Returns
void
void com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.setFrameHeight ( int  frameHeight)
inline

Sets the frame height.

Description: Sets the height of the frame.

Parameters
frameWidththe height of the frame in pixel units.
Returns
void
void com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.setFrameOuterColor ( int  frameOuterColor)
inline

Set the frame outer color.

Description: Set the color of the area outside of the capture frame. Use this property if you wish to have that area obscured in some way to emphasize the capture frame area.

Parameters
frameOuterColorAn int that represents the RGBA value of the desired color.
Returns
void
void com.kofax.kmc.kui.uicontrols.data.ImageCaptureFrame.setFrameWidth ( int  frameWidth)
inline

Sets the frame width.

Description: Sets the width of the frame.

Parameters
frameWidththe width of the frame in pixel units.
Returns
void

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.