Last Updated: 3/4/97
Class NFNoteSet

Class NFNoteSet

public class NFNoteSet

NFNoteSet represents a a group of text annotations with a common font and region style, and mapping strategy to be managed as one set in a graph. The mapping strategy defines how X and Y values are "mapped" to screen coordinates. For example, if the NoteAxis NoteAxis parameter is defined as (BOTTOM, LEFT) then the X and Y values passed in the NoteSet tuple are assumed to be X and Y data values which will be mapped to pixel locations based on the bottom and left Axis scales.

Available Mapping Values:

 	BOTTOM 	(For XAxis only)
 	RIGHT  	(For YAxis only)
 	TOP    	(For XAxis only)
 	LEFT   	(For YAxis only)
 	PIXEL  	(XAxis or YAxis)
 	PERCENT (XAxis or YAxis)

Instance Variables

Type Name Description Default
int MaxNoteSets 20
boolean clip false
String name null
int xaxis default xaxis mapping PIXEL
int yaxis default yaxis mapping PIXEL

Final Variables

Type Name Description
int BOTTOM Use BottomAxis To Map X
int LEFT Use LeftAxis to Map Y
int PERCENT Use Percent Coordinates (0-100)
int PIXEL Use Pixel Coordinates
int RIGHT Use RightAxis To Map Y
int TOP Use TopAxis to Map X

Methods


static void defineAllParams(NFParam p,
                            String param)
defines a bunch of notesets

static void defineNoteSet(NFParam p,
                          String param)
defines the NoteSet to the parameter parser

void draw(Graphics g,
          Graphics clipGraphics)
draws the NoteSet to the graphics object.

static Vector loadAllParams(NFParam p,
                            Vector notesets) 
create and load all defined notesets

void loadParams(NFParam p,
                String param)
loads the NoteSet parameters from the parameter parser

static void setAllMapAxes(NFAxis left,
                          NFAxis right,
                          NFAxis top,
                          NFAxis bottom,
                          Vector notesets)

static void setAllMapComponent(Component comp,
                               Vector notesets)
Set the component associated with all NoteSets in the given vector.

void setMapAxes (NFAxis left,
                 NFAxis right,
                 NFAxis top,
                 NFAxis bottom) throws Exception
Set axes used if mapping x/y values using the axes (instead of a pixel position). This must be called if the following axis mappings are specified:
 	BOTTOM
 	LEFT
 	TOP
 	RIGHT

void setMapComponent(Component comp)
set map component used if mapping x/y values using percentage. the component is just used to derive the size() Dimension object.