com.myscript.iink

Enum EditorError

java.lang.Object

java.lang.Enum<EditorError>

com.myscript.iink.EditorError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EditorError>

public enum EditorError
extends java.lang.Enum<EditorError>

Represents an Editor error code.

Since:

1.5

See Also:

IEditorListener.onError(com.myscript.iink.Editor, java.lang.String, com.myscript.iink.EditorError, java.lang.String)

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERIC Generic error, refer to the `message` parameter for more information.
GESTURE_NOTIFICATION_CANNOT_MOVE_ABOVE_FIRSTLINE Gesture notification, cannot move above first line.
GESTURE_NOTIFICATION_NO_WORDS_TO_JOIN Gesture notification, no words to join.
GESTURE_NOTIFICATION_UNABLE_TO_APPLY Gesture notification, unable to apply.
INK_REJECTED_ABOVE_FIRST_LINE Ink was rejected, the stroke is too far above the first line.
INK_REJECTED_BEFORE_FIRST_COLUMN Ink was rejected, the stroke is too far left.
INK_REJECTED_OUT_OF_PAGE Ink was rejected, the stroke is out of the page bounds.
INK_REJECTED_SMALL_TYPESET Ink was rejected, can not write on DIGITAL_PUBLISH blocks (convert to DIGITAL_EDIT).
INK_REJECTED_TOO_BIG Ink was rejected, the stroke is too big.
INK_REJECTED_TOO_LONG Ink was rejected, the stroke is too long.
INK_REJECTED_TOO_SMALL Ink was rejected, the stroke is too small.

Method Summary

Modifier and Type	Method and Description
static EditorError	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EditorError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GENERIC

public static final EditorError GENERIC

Generic error, refer to the `message` parameter for more information.

INK_REJECTED_TOO_SMALL

public static final EditorError INK_REJECTED_TOO_SMALL

Ink was rejected, the stroke is too small.

INK_REJECTED_TOO_BIG

public static final EditorError INK_REJECTED_TOO_BIG

Ink was rejected, the stroke is too big.

INK_REJECTED_ABOVE_FIRST_LINE

public static final EditorError INK_REJECTED_ABOVE_FIRST_LINE

Ink was rejected, the stroke is too far above the first line.

INK_REJECTED_SMALL_TYPESET

public static final EditorError INK_REJECTED_SMALL_TYPESET

Ink was rejected, can not write on DIGITAL_PUBLISH blocks (convert to DIGITAL_EDIT).

INK_REJECTED_BEFORE_FIRST_COLUMN

public static final EditorError INK_REJECTED_BEFORE_FIRST_COLUMN

Ink was rejected, the stroke is too far left.

INK_REJECTED_OUT_OF_PAGE

public static final EditorError INK_REJECTED_OUT_OF_PAGE

Ink was rejected, the stroke is out of the page bounds.

INK_REJECTED_TOO_LONG

public static final EditorError INK_REJECTED_TOO_LONG

Ink was rejected, the stroke is too long.

GESTURE_NOTIFICATION_NO_WORDS_TO_JOIN

public static final EditorError GESTURE_NOTIFICATION_NO_WORDS_TO_JOIN

Gesture notification, no words to join.

GESTURE_NOTIFICATION_CANNOT_MOVE_ABOVE_FIRSTLINE

public static final EditorError GESTURE_NOTIFICATION_CANNOT_MOVE_ABOVE_FIRSTLINE

Gesture notification, cannot move above first line.

GESTURE_NOTIFICATION_UNABLE_TO_APPLY

public static final EditorError GESTURE_NOTIFICATION_UNABLE_TO_APPLY

Gesture notification, unable to apply.

Method Detail

values

public static EditorError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EditorError c : EditorError.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EditorError valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null