edu.nyu.jet.tipster

Class AnnotationColor

java.lang.Object

edu.nyu.jet.tipster.AnnotationColor

public class AnnotationColor
extends Object

provides a mechanism for associating particular highlighting colors with particular annotation types in Document displays. The color information is retained in a color file. Colors may either be associated with a type or with a type together with the value of one of its features.

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayList<edu.nyu.jet.tipster.AnnotationColorEntry>	colors

Constructor Summary

Constructors

Constructor and Description
AnnotationColor(String dataPath) initializes the colorFrame -- the menu which is used to choose colors for each annotation type.
AnnotationColor(String dataPath, String colorFileName) initializes the colorFrame -- the menu which is used to choose colors for each annotation type.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addType(String type) add a color entry for annotation type 'type'.
static Color	getColor(Annotation ann) returns the Color associated with Annotation ann, or null if there is no Color association for this Annotation.
static void	readColors() read a table of Annotation type/color pairs, one per line, from 'colorFile'.
static void	showColors()
static void	writeColors() write a table of type/color pairs, one per line, to 'colorFile'.

Methods inherited from class java.lang.Object

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

Field Detail

colors

public static ArrayList<edu.nyu.jet.tipster.AnnotationColorEntry> colors

Constructor Detail

AnnotationColor

public AnnotationColor(String dataPath)

initializes the colorFrame -- the menu which is used to choose colors for each annotation type. The color choice is initialized from file 'annColors.clr' in directory 'dataPath'. An application should invoke the constructor once to initialize the color choices.

AnnotationColor

public AnnotationColor(String dataPath,
               String colorFileName)

initializes the colorFrame -- the menu which is used to choose colors for each annotation type. The color choice is initialized from file 'colorFileName' in directory 'dataPath'. An application should invoke the constructor once to initialize the color choices.

Method Detail

readColors

public static void readColors()

read a table of Annotation type/color pairs, one per line, from 'colorFile'. Each line should have the form
type color
or
type feature featureValue color
where 'type' is the name of the type, and 'color' is an integer representing a color; if present, 'feature' and 'featureValue' specialize the color to Annotations with that feature/featureValue combination. The color may be optionally followed by a (single-character) field; this character is used by AnnotationTool for annotating text with that type and featureValue.

writeColors

public static void writeColors()

write a table of type/color pairs, one per line, to 'colorFile'.

addType

public static void addType(String type)

add a color entry for annotation type 'type'. Initialize it to a random color and then display the color frame to offer the user a choice for changing it.

showColors

public static void showColors()

getColor

public static Color getColor(Annotation ann)

returns the Color associated with Annotation ann, or null if there is no Color association for this Annotation.