com.so.net

Class SignApi.Dialog

java.lang.Object

com.so.net.SignApi.Dialog

Enclosing class:

SignApi

public static final class SignApi.Dialog
extends Object

Can present a dialog of the loaded document on the device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignApi.Dialog.Button The dialog may have buttons.
static interface	SignApi.Dialog.Callback The callback to call when a dialog button is pressed.
static class	SignApi.Dialog.Color Can change the colors of the dialog.
static class	SignApi.Dialog.ComponentType The dialog consists of various components.
static class	SignApi.Dialog.Event The parameter of the Callback.
static class	SignApi.Dialog.Keyboard A keyboard for editing text in the dialog.
static class	SignApi.Dialog.Margin Can change the dialog crop margins.
static class	SignApi.Dialog.TextCapture Two ways to write text.

Method Summary

Modifier and Type	Method and Description
static boolean	addKeyboard(SignApi.Dialog.Keyboard keyboard) Adds a keyboard to the set of available dialog keyboards.
static boolean	create(int pageNumber) Creates a dialog starting at the specified page.
static boolean	deleteKeyboard(SignApi.Dialog.Keyboard.Name name) Deletes a keyboard.
static boolean	disableFormFields() Disables all form fields except signature fields.
static Optional<SignApi.Dialog.TextCapture>	getDefaultTextCapture() How to write text.
static Optional<Integer>	getScrollValue() How far to scroll.
static Optional<Path>	save() Saves the changes made to the form fields.
static Optional<Path>	save(Path path) Saves the changes made to the form fields.
static boolean	setCallback(SignApi.Dialog.Callback callback) Sets the callback to call when a dialog component has been pressed.
static boolean	setDefaultTextCapture(SignApi.Dialog.TextCapture textCapture) Sets how to write text.
static boolean	setScrollValue(int scrollValue) Sets how far to scroll.
static boolean	showMessageBox(String heading, String message, List<String> labels)
static boolean	showMessageBox(String heading, String message, String... labels) Shows a message box in the dialog with a heading, a message and up to three buttons.
static boolean	startSignature(Path path, boolean scroll) Starts signing the signature fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setCallback

public static boolean setCallback(SignApi.Dialog.Callback callback)

Sets the callback to call when a dialog component has been pressed.

Parameters:

callback - The callback.

Returns:

True in case of success.

addKeyboard

public static boolean addKeyboard(SignApi.Dialog.Keyboard keyboard)

Adds a keyboard to the set of available dialog keyboards.

Parameters:

keyboard - The keyboard.

Returns:

True in case of success.

deleteKeyboard

public static boolean deleteKeyboard(SignApi.Dialog.Keyboard.Name name)

Deletes a keyboard.

Parameters:

name - The name of the keyboard.

Returns:

True in case of success.

getScrollValue

public static Optional<Integer> getScrollValue()

How far to scroll.

Returns:

Some scroll value in case of success.

setScrollValue

public static boolean setScrollValue(int scrollValue)

Sets how far to scroll.

Parameters:

scrollValue - The scroll value.

Returns:

True in case of success.

create

public static boolean create(int pageNumber)

Creates a dialog starting at the specified page.

Parameters:

pageNumber - The zero-based page number.

Returns:

True in case of success.

disableFormFields

public static boolean disableFormFields()

Disables all form fields except signature fields.

Returns:

True in case of success.

save

public static Optional<Path> save()

Saves the changes made to the form fields.

Returns:

True in case of success.

save

public static Optional<Path> save(Path path)

Saves the changes made to the form fields.

Parameters:

path - The path to probably save the document to.

Returns:

The path the file has been saved to.

showMessageBox

public static boolean showMessageBox(String heading,
                                     String message,
                                     String... labels)

Shows a message box in the dialog with a heading, a message and up to three buttons.

Parameters:

heading - The heading

message - The message text.

labels - The button labels.

Returns:

True in case of success.

showMessageBox

public static boolean showMessageBox(String heading,
                                     String message,
                                     List<String> labels)

startSignature

public static boolean startSignature(Path path,
                                     boolean scroll)

Starts signing the signature fields.

Parameters:

path - The path to save the signed document to.

scroll - Whether to scroll to the signature fields.

Returns:

True in case of success.

getDefaultTextCapture

public static Optional<SignApi.Dialog.TextCapture> getDefaultTextCapture()

How to write text.

Returns:

Some text capture way in case of success.

setDefaultTextCapture

public static boolean setDefaultTextCapture(SignApi.Dialog.TextCapture textCapture)

Sets how to write text.

Parameters:

textCapture - The text capture way.

Returns:

True in case of success.