|
Kofax Mobile SDK API 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) |
| Sets the text of this message. More... | |
| boolean | getVisibility () |
| void | setVisibility (boolean visibility) |
| void | setOrientation (KUIMessageOrientation orientation) |
| KUIMessageOrientation | getOrientation () |
| void | setMessageIcons (Bitmap[] messageIcons) |
| Bitmap[] | getMessageIcons () |
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
| CaptureMessage | ( | ) |
| Drawable getBackground | ( | ) |
| int getBackgroundColor | ( | ) |
| int getHeight | ( | ) |
| String getMessage | ( | ) |
| Bitmap [] getMessageIcons | ( | ) |
| KUIMessageOrientation getOrientation | ( | ) |
| int getPosX | ( | ) |
| int getPosY | ( | ) |
| int getTextColor | ( | ) |
| int getTextSize | ( | ) |
| Typeface getTypeface | ( | ) |
| boolean getVisibility | ( | ) |
| int getWidth | ( | ) |
| void setBackground | ( | Drawable | background | ) |
| background | The background Drawable behind the displayed text |
| void setBackgroundColor | ( | int | backgroundColor | ) |
All color values are valid. The default background is transparent.
| backgroundColor | The background Color of the message |
| void setHeight | ( | int | height | ) |
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.
| height | The height of the message box text |
| void setMessage | ( | String | message | ) |
Sets the text of this message.
The default value is null (no text).
| void setMessageIcons | ( | Bitmap[] | messageIcons | ) |
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.
| messageIcons | The array of images used to display an animation |
| void setOrientation | ( | KUIMessageOrientation | orientation | ) |
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.
| orientation | The orientation of the message displayed. |
| void setPosX | ( | int | posX | ) |
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.
| posX | The x position of the message |
| void setPosY | ( | int | posY | ) |
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.
| posY | The Y position of the message |
| void setTextColor | ( | int | textColor | ) |
All color values are valid. The default color is white.
| textColor | The Color that the message text will be rendered with |
| void setTextSize | ( | int | textSize | ) |
The default is -1, which causes the message text font size to be determined as the SDK sees fit.
| textSize | The text font size |
| void setTypeface | ( | Typeface | typeface | ) |
The default is null, which causes the message text typeface to be determined as the SDK sees fit.
| typeface | The text typeface |
| void setVisibility | ( | boolean | visibility | ) |
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.
| visibility | The message visibility |
| void setWidth | ( | int | width | ) |
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.
| width | The width of the message box |