Package com.ironsoftware.ironpdf.annotation

Enum AnnotationIcon

java.lang.Object

java.lang.Enum<AnnotationIcon>

com.ironsoftware.ironpdf.annotation.AnnotationIcon

All Implemented Interfaces:

Serializable, Comparable<AnnotationIcon>

public enum AnnotationIcon
extends Enum<AnnotationIcon>

Icons used to interact (open/close) with a PDF annotation on a page.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMENT	A Comment Icon
HELP	A Help Icon
INSERT	An 'Insert' Icon
KEY	A Key Icon
NEW_PARAGRAPH	A New Paragraph Icon
NO_ICON	No icon, this is useful when an annotation will be signified by an existing graphic or object.
NOTE	A Note Icon
PARAGRAPH	A 'Paragraph of Text' Icon

Method Summary

Modifier and Type	Method	Description
static AnnotationIcon	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AnnotationIcon[]	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

NO_ICON

public static final AnnotationIcon NO_ICON

No icon, this is useful when an annotation will be signified by an existing graphic or object.

COMMENT

public static final AnnotationIcon COMMENT

A Comment Icon

HELP

public static final AnnotationIcon HELP

A Help Icon

INSERT

public static final AnnotationIcon INSERT

An 'Insert' Icon

KEY

public static final AnnotationIcon KEY

A Key Icon

NEW_PARAGRAPH

public static final AnnotationIcon NEW_PARAGRAPH

A New Paragraph Icon

NOTE

public static final AnnotationIcon NOTE

A Note Icon

PARAGRAPH

public static final AnnotationIcon PARAGRAPH

A 'Paragraph of Text' Icon

Method Detail

values

public static AnnotationIcon[] 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 (AnnotationIcon c : AnnotationIcon.values())
    System.out.println(c);

Returns:

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

valueOf

public static AnnotationIcon valueOf(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:

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

NullPointerException - if the argument is null