eTextReader.clientInterface
Enum Notation.AnnotationType

java.lang.Object
  java.lang.Enum<Notation.AnnotationType>
      eTextReader.clientInterface.Notation.AnnotationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Notation.AnnotationType>

Enclosing class:

Notation

public static enum Notation.AnnotationType
extends java.lang.Enum<Notation.AnnotationType>

An enum outlining all the possible types of annotations, and allowing access to several properties based on this type.

Author:

mcfall

Enum Constant Summary

ANNOTATION_BOOKMARK

BOOKMARK

DIAGRAM

DISCUSSION

GLOBAL_BOOKMARK

HIGHLIGHT

INK_DIAGRAM

LAST_POSITION

LINK

PROGRAM_REFERENCE

QUICK_NOTE

READING_BOOKMARK

TAB_POSITION

TEXT_NOTE

Field Summary

private static java.util.Hashtable<java.lang.String,Notation.AnnotationType>

names

Method Summary

boolean	displayIconForAnnotation() Determines whether or not an icon is displayed for this annotation type
java.lang.String	getHref() Returns a string used to identify the type of icon when it is moused over
java.lang.String	getIcon() Returns a string representing the icon filename used to represent the given
Notation.ICON_LOCATION	getIconLocation() Indicates where, relative to the selected text, an icon should be placed for the annotation
int	getImageBorder() Returns the size of the border that should be drawn around the image associated with this type of annotation.
static Notation.AnnotationType	getTypeForName(java.lang.String name)
boolean	highlightSelectionOnMouseOver() Indicates whether or not the selected portion of text associated with this annotation should be highlighted when the mouse hovers over the icon for the annotation
boolean	includeInAnnotationListing() Indicates whether this type of annotation listing should be included in the annotation listing window
boolean	isPopupEnabledByDefault() Determines whether or not a popup window is shown by default for this type of annotation
boolean	showDeleteInPopupMenu() Indicates whether or not a popup menu should include a "Delete" entry in a popup menu
boolean	showPopupOnMouseOver() Indicates whether or not the a popup window should be shown when the mouse hovers over the icon for the annotation
boolean	showViewAnnotationInPopupMenu() Indicates whether or not a popup menu should include a "View" entry in a popup menu
java.lang.String	toString() Returns a human-friendly string representation of this type of annotation
static Notation.AnnotationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Notation.AnnotationType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GLOBAL_BOOKMARK

public static final Notation.AnnotationType GLOBAL_BOOKMARK

READING_BOOKMARK

public static final Notation.AnnotationType READING_BOOKMARK

BOOKMARK

public static final Notation.AnnotationType BOOKMARK

ANNOTATION_BOOKMARK

public static final Notation.AnnotationType ANNOTATION_BOOKMARK

DIAGRAM

public static final Notation.AnnotationType DIAGRAM

INK_DIAGRAM

public static final Notation.AnnotationType INK_DIAGRAM

TEXT_NOTE

public static final Notation.AnnotationType TEXT_NOTE

HIGHLIGHT

public static final Notation.AnnotationType HIGHLIGHT

LINK

public static final Notation.AnnotationType LINK

LAST_POSITION

public static final Notation.AnnotationType LAST_POSITION

DISCUSSION

public static final Notation.AnnotationType DISCUSSION

PROGRAM_REFERENCE

public static final Notation.AnnotationType PROGRAM_REFERENCE

QUICK_NOTE

public static final Notation.AnnotationType QUICK_NOTE

TAB_POSITION

public static final Notation.AnnotationType TAB_POSITION

Field Detail

names

private static java.util.Hashtable<java.lang.String,Notation.AnnotationType> names

Method Detail

values

public static final Notation.AnnotationType[] values()

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

for(Notation.AnnotationType c : Notation.AnnotationType.values())
        System.out.println(c);

Returns:

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

valueOf

public static Notation.AnnotationType 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

getTypeForName

public static Notation.AnnotationType getTypeForName(java.lang.String name)
                                              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getIcon

public java.lang.String getIcon()

Returns a string representing the icon filename used to represent the given

Returns:

getHref

public java.lang.String getHref()

Returns a string used to identify the type of icon when it is moused over

Returns:

isPopupEnabledByDefault

public boolean isPopupEnabledByDefault()

Determines whether or not a popup window is shown by default for this type of annotation

Returns:

getImageBorder

public int getImageBorder()

Returns the size of the border that should be drawn around the image associated with this type of annotation.

Returns:

showPopupOnMouseOver

public boolean showPopupOnMouseOver()

Indicates whether or not the a popup window should be shown when the mouse hovers over the icon for the annotation

Returns:

toString

public java.lang.String toString()

Returns a human-friendly string representation of this type of annotation

Overrides:

toString in class java.lang.Enum<Notation.AnnotationType>

showDeleteInPopupMenu

public boolean showDeleteInPopupMenu()

Indicates whether or not a popup menu should include a "Delete" entry in a popup menu

Returns:

true if a "Delete" entry should be included, false otherwise

includeInAnnotationListing

public boolean includeInAnnotationListing()

Indicates whether this type of annotation listing should be included in the annotation listing window

Returns:

true if this type should be included, false otherwise

highlightSelectionOnMouseOver

public boolean highlightSelectionOnMouseOver()

Indicates whether or not the selected portion of text associated with this annotation should be highlighted when the mouse hovers over the icon for the annotation

Returns:

getIconLocation

public Notation.ICON_LOCATION getIconLocation()

Indicates where, relative to the selected text, an icon should be placed for the annotation

Returns:

Either ICON_LOCATION.START or ICON_LOCATION.END

showViewAnnotationInPopupMenu

public boolean showViewAnnotationInPopupMenu()

Indicates whether or not a popup menu should include a "View" entry in a popup menu

Returns:

true if a "View" entry should be included, false otherwise

displayIconForAnnotation

public boolean displayIconForAnnotation()

Determines whether or not an icon is displayed for this annotation type

Returns:

true if an icon should be displayed, false otherwise