There can be one or more Pages in a Document. This object is serializable. More...
Classes | |
| enum | Side |
| Indicates whether this Page is front or back of the sheet. More... | |
Public Member Functions | |
| Page () | |
| List< Image > | getImages () |
| Array of image objects associated with the Page. More... | |
| String | getPageID () |
| Unique GUID identifying the page. Generated as part of object initialization. More... | |
| String | getDocumentID () |
| Unique Document identifier which contains this Page. Generated at the time this Page is added to a Document. More... | |
| void | addImage (Image image) |
| Adds Image Object to images array property. More... | |
| ErrorInfo | removeImage (String imageID) |
| Removes Image Object from images array property. More... | |
| int | getSheetID () |
| Unique ID identifying the sheet. Allows two pages that are part of a sheet to be identified. More... | |
| void | setSheetID (int sheetID) |
| Unique ID identifying the sheet. Allows two pages that are part of a sheet to be identified. More... | |
| int | getCurrentImageIndex () |
| Indicates the current image of several images associated with a page. More... | |
| void | setCurrentImageIndex (int currentImageIndex) |
| Specifies the current image of several images associated with a page. More... | |
| void | setSide (Side pageSide) |
| Set page side as Front or Back. More... | |
| Side | getSide () |
Protected Member Functions | |
| void | setDocumentID (String documentID) |
Detailed Description
There can be one or more Pages in a Document. This object is serializable.
Each Page can contain one or more Image objects. Each Page also has a Side associated with it. In order to add/remove the Images from a Page, use add/remove methods. When a Page object is instantiated a unique page id is generated.
Page objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.
Constructor & Destructor Documentation
| Page | ( | ) |
Member Function Documentation
| void addImage | ( | Image | image | ) |
Adds Image Object to images array property.
This method adds an image object to the 'images' array property. After the image is added, the currentImageIndex is updated to indicate that the most recent image is current.
- Parameters
-
image to add.
- Exceptions
-
IllegalArgumentException (image parameter is null).
| int getCurrentImageIndex | ( | ) |
Indicates the current image of several images associated with a page.
Indicates the image index for the page from which the extraction is associated. It is especially useful for a multipage document. When an image is added using the 'addImage' method, this variable is automatically set to the index of the added image.
| String getDocumentID | ( | ) |
Unique Document identifier which contains this Page. Generated at the time this Page is added to a Document.
Returns the unique ID which identifies a particular Document. The application may invent this ID according to its own client application and back-end server architecture. Its usage in AppStats events requires this ID to be a random UUID (also known as a GUID). The DocumentID property provides a way of linking each Page object to its parent Document object.
- Returns
- documentID
| String getPageID | ( | ) |
Unique GUID identifying the page. Generated as part of object initialization.
| int getSheetID | ( | ) |
Unique ID identifying the sheet. Allows two pages that are part of a sheet to be identified.
| Side getSide | ( | ) |
| ErrorInfo removeImage | ( | String | imageID | ) |
Removes Image Object from images array property.
Removes the image object from the page. The image to be removed is determined by matching the supplied imageID string to the contents of the images in the array. If the current image is removed, the currentImageIndex is set to 0. Otherwise, the currentImageIndex refers to the same image.
- Parameters
-
imageID the id of the image to remove.
- Returns
- ErrorInfo: KMC_SUCCESS, or KMC_LO_IMAGE_NOT_FOUND.
| void setCurrentImageIndex | ( | int | currentImageIndex | ) |
Specifies the current image of several images associated with a page.
Specifies the image index for the page from which the extraction is associated. It is especially useful for a multipage document.
|
protected |
| void setSheetID | ( | int | sheetID | ) |
Unique ID identifying the sheet. Allows two pages that are part of a sheet to be identified.
| void setSide | ( | Side | pageSide | ) |
Set page side as Front or Back.
The documentation for this class was generated from the following file: