Top Description Fields Constructors Methods
org.jabref.model.pdf

public final Enum FileAnnotationType

extends Enum<FileAnnotationType>
Class Inheritance
Imports
java.util.Locale, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation, org.slf4j.Logger, .LoggerFactory
Our representation of the type of the FileAnnotation. This is needed as some FileAnnotationTypes require special handling (e.g., Highlight or Underline), because of the linked FileAnnotations.

Field Summary

Modifier and TypeField and Description
public static final FileAnnotationType
CIRCLE

public static final FileAnnotationType
FREETEXT

public static final FileAnnotationType
HIGHLIGHT

public static final FileAnnotationType
INK

public static final FileAnnotationType
LINE

private final boolean
linkedFileAnnotationType

private static final Logger
LOGGER

private final String
name

Hides java.lang.Enum.name.

public static final FileAnnotationType
NONE

public static final FileAnnotationType
POLYGON

public static final FileAnnotationType
POPUP

public static final FileAnnotationType
SQUIGGLY

public static final FileAnnotationType
STRIKEOUT

public static final FileAnnotationType
TEXT

public static final FileAnnotationType
UNDERLINE

public static final FileAnnotationType
UNKNOWN

Constructor Summary

AccessConstructor and Description
private
FileAnnotationType(String name, boolean linkedFileAnnotationType)

Method Summary

Modifier and TypeMethod and Description
public boolean
isLinkedFileAnnotationType()

public static boolean

Returns:

true if annotationType is a supported marked FileAnnotation type
isMarkedFileAnnotationType(String
a type descriptor
annotationType)

Determines if a String is a supported marked FileAnnotation type.

public static FileAnnotationType

Returns:

The determined FileAnnotationType
parse(org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
the raw PDAnnotation
annotation)

Determines the FileAnnotationType of a raw PDAnnotation.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static FileAnnotationType
valueOf(String name)

public static FileAnnotationType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

CIRCLEback to summary
public static final FileAnnotationType CIRCLE
FREETEXTback to summary
public static final FileAnnotationType FREETEXT
HIGHLIGHTback to summary
public static final FileAnnotationType HIGHLIGHT
INKback to summary
public static final FileAnnotationType INK
LINEback to summary
public static final FileAnnotationType LINE
linkedFileAnnotationTypeback to summary
private final boolean linkedFileAnnotationType
LOGGERback to summary
private static final Logger LOGGER
nameback to summary
private final String name

Hides java.lang.Enum.name.

NONEback to summary
public static final FileAnnotationType NONE
POLYGONback to summary
public static final FileAnnotationType POLYGON
SQUIGGLYback to summary
public static final FileAnnotationType SQUIGGLY
STRIKEOUTback to summary
public static final FileAnnotationType STRIKEOUT
TEXTback to summary
public static final FileAnnotationType TEXT
UNDERLINEback to summary
public static final FileAnnotationType UNDERLINE
UNKNOWNback to summary
public static final FileAnnotationType UNKNOWN

Constructor Detail

FileAnnotationTypeback to summary
private FileAnnotationType(String name, boolean linkedFileAnnotationType)

Method Detail

isLinkedFileAnnotationTypeback to summary
public boolean isLinkedFileAnnotationType()
isMarkedFileAnnotationTypeback to summary
public static boolean isMarkedFileAnnotationType(String annotationType)

Determines if a String is a supported marked FileAnnotation type.

Parameters
annotationType:String

a type descriptor

Returns:boolean

true if annotationType is a supported marked FileAnnotation type

parseback to summary
public static FileAnnotationType parse(org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation)

Determines the FileAnnotationType of a raw PDAnnotation. Returns 'UNKNOWN' if the type is currently not in our list of FileAnnotationTypes.

Parameters
annotation:org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

the raw PDAnnotation

Returns:FileAnnotationType

The determined FileAnnotationType

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

valueOfback to summary
public static FileAnnotationType valueOf(String name)
valuesback to summary
public static FileAnnotationType[] values()