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

Classes

enum  KUIMessageOrientation
 

Public Member Functions

 CaptureMessage ()
 
int getTextColor ()
 
void setTextColor (int textColor)
 
int getBackgroundColor ()
 
void setBackgroundColor (int backgroundColor)
 
Drawable getBackground ()
 
void setBackground (Drawable background)
 
int getPosX ()
 
void setPosX (int posX)
 
int getPosY ()
 
void setPosY (int posY)
 
int getWidth ()
 
void setWidth (int width)
 
int getHeight ()
 
void setHeight (int height)
 
int getTextSize ()
 
void setTextSize (int textSize)
 
Typeface getTypeface ()
 
void setTypeface (Typeface typeface)
 
String getMessage ()
 
void setMessage (String message)
 
boolean getVisibility ()
 
void setVisibility (boolean visibility)
 
void setOrientation (KUIMessageOrientation orientation)
 
KUIMessageOrientation getOrientation ()
 
void setMessageIcons (Bitmap[] messageIcons)
 
Bitmap[] getMessageIcons ()
 

Detailed Description

This class is responsible for rendering the messages on the Image Capture View. It allows the attributes of the messages to be configured and hence enhance the visual feedback to the user

Constructor & Destructor Documentation

com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.CaptureMessage ( )
inline

Member Function Documentation

Drawable com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getBackground ( )
inline
Returns
Drawable The background Drawable behind the displayed text
See also
setBackground(Drawable)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getBackgroundColor ( )
inline
Returns
int The background Color of the message
See also
setBackgroundColor(int)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getHeight ( )
inline
Returns
int The height of the message box text
See also
setHeight(int)
String com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getMessage ( )
inline
Returns
String The message
See also
setMessage(String)
Bitmap [] com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getMessageIcons ( )
inline
Returns
Bitmap[] The array of images used to display an animation
See also
setMessageIcons(Bitmap[])
KUIMessageOrientation com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getOrientation ( )
inline
Returns
KUIMessageOrientation The orientation of the message displayed
See also
setOrientation(KUIMessageOrientation)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getPosX ( )
inline
Returns
int The x position of the message
See also
setPosX(int)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getPosY ( )
inline
Returns
int The Y position of the message
See also
setPosY(int)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getTextColor ( )
inline
Returns
int The Color that the message text will be rendered with
See also
setTextColor(int)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getTextSize ( )
inline
Returns
int The text font size
See also
setTextSize(int)
Typeface com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getTypeface ( )
inline
Returns
Typeface The text typeface
See also
setTypeface(Typeface)
boolean com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getVisibility ( )
inline
Returns
boolean The message visibility
See also
setVisibility(boolean)
int com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.getWidth ( )
inline
Returns
int The width of the message box text
See also
setWidth(int)
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setBackground ( Drawable  background)
inline
Parameters
backgroundThe background Drawable behind the displayed text
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setBackgroundColor ( int  backgroundColor)
inline

All color values are valid. The default background is transparent.

Parameters
backgroundColorThe background Color of the message
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setHeight ( int  height)
inline

Text will be contained within this boundary, and any set background color will completely cover this area. The default (-1) causes the message text height to be determined as the SDK sees fit.

Parameters
heightThe height of the message box text
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setMessage ( String  message)
inline

The default value is null, which causes a default message to be displayed.

Parameters
messageThe message
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setMessageIcons ( Bitmap[]  messageIcons)
inline

Specifies an array of images used to display an animation in additional to the text message. The animation is a repeating sequence of images. By default, this is an empty array and no animation will be displayed.

Parameters
messageIconsThe array of images used to display an animation
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setOrientation ( KUIMessageOrientation  orientation)
inline

Once the orientation is set for messages, they stay in that mode even if the device rotates. By default, UserInstructionMessage, NoDocumentFoundMessage, and ZoomInMessage default to landscape. PageOrientationMessage defaults to portrait.

Parameters
orientationThe orientation of the message displayed.
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setPosX ( int  posX)
inline

The message object will be displayed on top of an Image Capture View with the left of the message being located at this coordinate. Changes in the size of the capture control will usually require updating the position of the message as well. The default value (-1) causes the message to be positioned as the SDK sees fit.

Parameters
posXThe x position of the message
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setPosY ( int  posY)
inline

The message object will be displayed on top of an Image Capture View with the top of the message being located at this coordinate. Changes in the size of the capture control will usually require updating the position of the message as well. The default value (-1) causes the message to be positioned as the SDK sees fit.

Parameters
posYThe Y position of the message
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setTextColor ( int  textColor)
inline

All color values are valid. The default color is white.

Parameters
textColorThe Color that the message text will be rendered with
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setTextSize ( int  textSize)
inline

The default is -1, which causes the message text font size to be determined as the SDK sees fit.

Parameters
textSizeThe text font size
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setTypeface ( Typeface  typeface)
inline

The default is null, which causes the message text typeface to be determined as the SDK sees fit.

Parameters
typefaceThe text typeface
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setVisibility ( boolean  visibility)
inline

A value of true will show the message, if there is nothing else to prevent it from appearing. A value of false will prevent the message from appearing. The default value is true. Some objects that use messages, like the capture experience objects, will automatically manage and update this state.

Parameters
visibilityThe message visibility
void com.kofax.kmc.kui.uicontrols.captureanimations.CaptureMessage.setWidth ( int  width)
inline

Text will be contained within this boundary, and any set background color will completely fill this area. The default (-1) causes the message text width to be determined as the SDK sees fit.

Parameters
widthThe width of the message box

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.