All Implemented Interfaces:: java.io.Serializable


public final class ButtonConfiguration
 implements Serializable

A configuration class used to alter the default buttons.

Field Summary

Fields
Modifier and Type	Field	Description
`private DocutainButton`	`buttonEditRotate`
`private DocutainButton`	`buttonEditCrop`
`private DocutainButton`	`buttonEditFilter`
`private DocutainButton`	`buttonEditArrange`
`private DocutainButton`	`buttonEditRetake`
`private DocutainButton`	`buttonEditDelete`
`private DocutainButton`	`buttonEditFinish`
`private DocutainButton`	`buttonCropExpand`
`private DocutainButton`	`buttonCropSnap`
`private DocutainButton`	`buttonCropFinish`
`private DocutainButton`	`buttonScanAutoCaptureOn`
`private DocutainButton`	`buttonScanAutoCaptureOff`
`private DocutainButton`	`buttonScanTorch`
`private DocutainButton`	`buttonScanCapture`
`private DocutainButton`	`buttonScanFinish`
`private DocutainButton`	`buttonConfirmationFinish`
`private DocutainButton`	`buttonEditAddPage`
`private DocutainButton`	`buttonScanImport`

Constructor Summary

Constructors
Constructor	Description
`ButtonConfiguration()`

Method Summary

Modifier and Type	Method	Description
`final DocutainButton`	`getButtonEditRotate()`	The button that rotates the current page.
`final Unit`	`setButtonEditRotate(DocutainButton buttonEditRotate)`	The button that rotates the current page.
`final DocutainButton`	`getButtonEditCrop()`	The button that opens the cropping functionality.
`final Unit`	`setButtonEditCrop(DocutainButton buttonEditCrop)`	The button that opens the cropping functionality.
`final DocutainButton`	`getButtonEditFilter()`	The button that opens the filter functionality.
`final Unit`	`setButtonEditFilter(DocutainButton buttonEditFilter)`	The button that opens the filter functionality.
`final DocutainButton`	`getButtonEditArrange()`	The button that opens the page arrangement functionality.
`final Unit`	`setButtonEditArrange(DocutainButton buttonEditArrange)`	The button that opens the page arrangement functionality.
`final DocutainButton`	`getButtonEditRetake()`	The button that starts the process of replacing the current page with a new scan.
`final Unit`	`setButtonEditRetake(DocutainButton buttonEditRetake)`	The button that starts the process of replacing the current page with a new scan.
`final DocutainButton`	`getButtonEditDelete()`	The button that deletes the current page or opens a dialog with options if multiple pages are available.
`final Unit`	`setButtonEditDelete(DocutainButton buttonEditDelete)`	The button that deletes the current page or opens a dialog with options if multiple pages are available.
`final DocutainButton`	`getButtonEditFinish()`	The button that finishes the scan process.
`final Unit`	`setButtonEditFinish(DocutainButton buttonEditFinish)`	The button that finishes the scan process.
`final DocutainButton`	`getButtonCropExpand()`	The button within the cropping functionality that expands the current cropping rectangle to the whole page.
`final Unit`	`setButtonCropExpand(DocutainButton buttonCropExpand)`	The button within the cropping functionality that expands the current cropping rectangle to the whole page.
`final DocutainButton`	`getButtonCropSnap()`	The button within the cropping functionality that snaps the current cropping rectangle to the detected document.
`final Unit`	`setButtonCropSnap(DocutainButton buttonCropSnap)`	The button within the cropping functionality that snaps the current cropping rectangle to the detected document.
`final DocutainButton`	`getButtonCropFinish()`	The button within the cropping functionality that finishes the manual cropping process according to the current cropping rectangle.
`final Unit`	`setButtonCropFinish(DocutainButton buttonCropFinish)`	The button within the cropping functionality that finishes the manual cropping process according to the current cropping rectangle.
`final DocutainButton`	`getButtonScanAutoCaptureOn()`	The button within the scan functionality that is shown when automatic capture is activated.
`final Unit`	`setButtonScanAutoCaptureOn(DocutainButton buttonScanAutoCaptureOn)`	The button within the scan functionality that is shown when automatic capture is activated.
`final DocutainButton`	`getButtonScanAutoCaptureOff()`	The button within the scan functionality that is shown when automatic capture is deactivated.
`final Unit`	`setButtonScanAutoCaptureOff(DocutainButton buttonScanAutoCaptureOff)`	The button within the scan functionality that is shown when automatic capture is deactivated.
`final DocutainButton`	`getButtonScanTorch()`	The button within the scan functionality that toggles the torch.
`final Unit`	`setButtonScanTorch(DocutainButton buttonScanTorch)`	The button within the scan functionality that toggles the torch.
`final DocutainButton`	`getButtonScanCapture()`	The button within the scan functionality that triggers a manual image capture.
`final Unit`	`setButtonScanCapture(DocutainButton buttonScanCapture)`	The button within the scan functionality that triggers a manual image capture.
`final DocutainButton`	`getButtonScanFinish()`	The button within the scan functionality that finishes the current scan process and leads to the editing page.
`final Unit`	`setButtonScanFinish(DocutainButton buttonScanFinish)`	The button within the scan functionality that finishes the current scan process and leads to the editing page.
`final DocutainButton`	`getButtonConfirmationFinish()`	The button on the confirmation page that finishes the scan process.
`final Unit`	`setButtonConfirmationFinish(DocutainButton buttonConfirmationFinish)`	The button on the confirmation page that finishes the scan process.
`final DocutainButton`	`getButtonEditAddPage()`	The button on the edit page that opens the scan screen to add a new page.
`final Unit`	`setButtonEditAddPage(DocutainButton buttonEditAddPage)`	The button on the edit page that opens the scan screen to add a new page.
`final DocutainButton`	`getButtonScanImport()`	The button on the scan page that opens a file importer.
`final Unit`	`setButtonScanImport(DocutainButton buttonScanImport)`	The button on the scan page that opens a file importer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ButtonConfiguration
```
ButtonConfiguration()
```
- Method Detail
  - getButtonEditRotate
```
 final DocutainButton getButtonEditRotate()
```
    The button that rotates the current page.
  - setButtonEditRotate
```
 final Unit setButtonEditRotate(DocutainButton buttonEditRotate)
```
    The button that rotates the current page.
  - getButtonEditCrop
```
 final DocutainButton getButtonEditCrop()
```
    The button that opens the cropping functionality.
  - setButtonEditCrop
```
 final Unit setButtonEditCrop(DocutainButton buttonEditCrop)
```
    The button that opens the cropping functionality.
  - getButtonEditFilter
```
 final DocutainButton getButtonEditFilter()
```
    The button that opens the filter functionality.
  - setButtonEditFilter
```
 final Unit setButtonEditFilter(DocutainButton buttonEditFilter)
```
    The button that opens the filter functionality.
  - getButtonEditArrange
```
 final DocutainButton getButtonEditArrange()
```
    The button that opens the page arrangement functionality.
  - setButtonEditArrange
```
 final Unit setButtonEditArrange(DocutainButton buttonEditArrange)
```
    The button that opens the page arrangement functionality.
  - getButtonEditRetake
```
 final DocutainButton getButtonEditRetake()
```
    The button that starts the process of replacing the current page with a new scan.
  - setButtonEditRetake
```
 final Unit setButtonEditRetake(DocutainButton buttonEditRetake)
```
    The button that starts the process of replacing the current page with a new scan.
  - getButtonEditDelete
```
 final DocutainButton getButtonEditDelete()
```
    The button that deletes the current page or opens a dialog with options if multiple pages are available.
  - setButtonEditDelete
```
 final Unit setButtonEditDelete(DocutainButton buttonEditDelete)
```
    The button that deletes the current page or opens a dialog with options if multiple pages are available.
  - getButtonEditFinish
```
 final DocutainButton getButtonEditFinish()
```
    The button that finishes the scan process.
  - setButtonEditFinish
```
 final Unit setButtonEditFinish(DocutainButton buttonEditFinish)
```
    The button that finishes the scan process.
  - getButtonCropExpand
```
 final DocutainButton getButtonCropExpand()
```
    The button within the cropping functionality that expands the current cropping rectangle to the whole page.
  - setButtonCropExpand
```
 final Unit setButtonCropExpand(DocutainButton buttonCropExpand)
```
    The button within the cropping functionality that expands the current cropping rectangle to the whole page.
  - getButtonCropSnap
```
 final DocutainButton getButtonCropSnap()
```
    The button within the cropping functionality that snaps the current cropping rectangle to the detected document.
  - setButtonCropSnap
```
 final Unit setButtonCropSnap(DocutainButton buttonCropSnap)
```
    The button within the cropping functionality that snaps the current cropping rectangle to the detected document.
  - getButtonCropFinish
```
 final DocutainButton getButtonCropFinish()
```
    The button within the cropping functionality that finishes the manual cropping process according to the current cropping rectangle.
  - setButtonCropFinish
```
 final Unit setButtonCropFinish(DocutainButton buttonCropFinish)
```
    The button within the cropping functionality that finishes the manual cropping process according to the current cropping rectangle.
  - getButtonScanAutoCaptureOn
```
 final DocutainButton getButtonScanAutoCaptureOn()
```
    The button within the scan functionality that is shown when automatic capture is activated.
  - setButtonScanAutoCaptureOn
```
 final Unit setButtonScanAutoCaptureOn(DocutainButton buttonScanAutoCaptureOn)
```
    The button within the scan functionality that is shown when automatic capture is activated.
  - getButtonScanAutoCaptureOff
```
 final DocutainButton getButtonScanAutoCaptureOff()
```
    The button within the scan functionality that is shown when automatic capture is deactivated.
  - setButtonScanAutoCaptureOff
```
 final Unit setButtonScanAutoCaptureOff(DocutainButton buttonScanAutoCaptureOff)
```
    The button within the scan functionality that is shown when automatic capture is deactivated.
  - getButtonScanTorch
```
 final DocutainButton getButtonScanTorch()
```
    The button within the scan functionality that toggles the torch.
  - setButtonScanTorch
```
 final Unit setButtonScanTorch(DocutainButton buttonScanTorch)
```
    The button within the scan functionality that toggles the torch.
  - getButtonScanCapture
```
 final DocutainButton getButtonScanCapture()
```
    The button within the scan functionality that triggers a manual image capture.
  - setButtonScanCapture
```
 final Unit setButtonScanCapture(DocutainButton buttonScanCapture)
```
    The button within the scan functionality that triggers a manual image capture.
  - getButtonScanFinish
```
 final DocutainButton getButtonScanFinish()
```
    The button within the scan functionality that finishes the current scan process and leads to the editing page.
  - setButtonScanFinish
```
 final Unit setButtonScanFinish(DocutainButton buttonScanFinish)
```
    The button within the scan functionality that finishes the current scan process and leads to the editing page.
  - getButtonConfirmationFinish
```
 final DocutainButton getButtonConfirmationFinish()
```
    The button on the confirmation page that finishes the scan process. See DocumentScannerConfiguration.confirmPages.
  - setButtonConfirmationFinish
```
 final Unit setButtonConfirmationFinish(DocutainButton buttonConfirmationFinish)
```
    The button on the confirmation page that finishes the scan process. See DocumentScannerConfiguration.confirmPages.
  - getButtonEditAddPage
```
 final DocutainButton getButtonEditAddPage()
```
    The button on the edit page that opens the scan screen to add a new page.
  - setButtonEditAddPage
```
 final Unit setButtonEditAddPage(DocutainButton buttonEditAddPage)
```
    The button on the edit page that opens the scan screen to add a new page.
  - getButtonScanImport
```
 final DocutainButton getButtonScanImport()
```
    The button on the scan page that opens a file importer.
  - setButtonScanImport
```
 final Unit setButtonScanImport(DocutainButton buttonScanImport)
```
    The button on the scan page that opens a file importer.

Class ButtonConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ButtonConfiguration

Method Detail

getButtonEditRotate

setButtonEditRotate

getButtonEditCrop

setButtonEditCrop

getButtonEditFilter

setButtonEditFilter

getButtonEditArrange

setButtonEditArrange

getButtonEditRetake

setButtonEditRetake

getButtonEditDelete

setButtonEditDelete

getButtonEditFinish

setButtonEditFinish

getButtonCropExpand

setButtonCropExpand

getButtonCropSnap

setButtonCropSnap

getButtonCropFinish

setButtonCropFinish

getButtonScanAutoCaptureOn

setButtonScanAutoCaptureOn

getButtonScanAutoCaptureOff

setButtonScanAutoCaptureOff

getButtonScanTorch

setButtonScanTorch

getButtonScanCapture

setButtonScanCapture

getButtonScanFinish

setButtonScanFinish

getButtonConfirmationFinish

setButtonConfirmationFinish

getButtonEditAddPage

setButtonEditAddPage

getButtonScanImport

setButtonScanImport