Overview | Package | Class | Tree | Index | Help			NetCharts 4.5
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class netcharts.graphics.
NFActiveLabel

java.lang.Object
  |
  +--netcharts.graphics.NFActiveLabel

public class NFActiveLabel

This class holds information about a single active label.

Field Summary

java.awt.Polygon	areaPoly The bounding Polygon if this active label's boundary is not defined by a Rectangle.
java.lang.String	label The label for this ActiveLabel.
int	selectedItemIndex The CDL Parameter index corrsdonding to the Item over which this ActiveLabel appears.
java.util.Vector	selectedItemLabels The chart specific data corresponding to the Item over which this ActiveLabel appears.
java.lang.String	selectedItemParam The CDL Parameter corrsdonding to the Item over which this ActiveLabel appears.
java.lang.String	target The frame target for this ActiveLabel's URL.
java.net.URL	url The URL for this ActiveLabel.
int	xmax The X of the bottom right corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.
int	xmin The X of the top left corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.
int	ymax The Y of the bottom right corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.
int	ymin The Y of the top left corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.

Constructor Summary

NFActiveLabel()
Create a new object, with no values assigned.

NFActiveLabel(java.lang.String label, java.net.URL url, java.lang.String target)
Create a new object, with the given values assigned.

Method Summary

void	activate(java.applet.AppletContext ac) Activate the active label by showing any document specified by the url attribute.
void	draw(java.awt.Graphics g, int x, int y, NFLabelIntf label) Draw the active label at the given location using the given graphics and label objects
void	draw(java.awt.Graphics g, NFLabelIntf label) Draw the active label using the given graphics and label objects
void	drawOutline(java.awt.Graphics g, NFLabelIntf label) Draw the outline of the active label's rectangle or polygon using colors extracted from the passed in NFLabel.
boolean	inside(int x, int y) Returns true if the given point is inside of the active label bounds.
boolean	isValid() Check if this ActiveLabel's area is valid.
static java.util.Vector	loadAllParams(NFParam p, java.lang.String name) Build a vector of ActiveLabels based on the definition of the parameter with the given name.
static NFActiveLabel	loadParams(NFParam p, java.lang.Object val) Build an ActiveLabel using the value vector provided by the parser.
static NFActiveLabel	loadParams(NFParam p, java.lang.Object val, int offset) Use the parser values stored in the given vector, starting at the given offset.
void	reset() Reset this ActiveLabel's area.
void	setBounds(int x, int y, int width, int height) Set the boundary for the active label
void	setBounds(java.awt.Polygon p) Set the boundary for the active label
void	setLabel(java.lang.String label) Set the label.
void	setTarget(java.lang.String target) Set the target
void	setURL(java.net.URL url) Set the URL

Field Detail

label

public java.lang.String label

The label for this ActiveLabel.

url

public java.net.URL url

The URL for this ActiveLabel.

target

public java.lang.String target

The frame target for this ActiveLabel's URL.

xmin

public int xmin

The X of the top left corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.

ymin

public int ymin

The Y of the top left corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.

xmax

public int xmax

The X of the bottom right corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.

ymax

public int ymax

The Y of the bottom right corner of the bounding Rectangle if this active label's boundary is not defined by a Polygon.

areaPoly

public java.awt.Polygon areaPoly

The bounding Polygon if this active label's boundary is not defined by a Rectangle.

selectedItemParam

public java.lang.String selectedItemParam

The CDL Parameter corrsdonding to the Item over which this ActiveLabel appears.

selectedItemIndex

public int selectedItemIndex

The CDL Parameter index corrsdonding to the Item over which this ActiveLabel appears. This index is 0 based. For Example: A selectedItemParam of 'DataSet1' and a selectedItemIndex of 3 would indicate this is the fourth data value in the first data set.

selectedItemLabels

public java.util.Vector selectedItemLabels

The chart specific data corresponding to the Item over which this ActiveLabel appears. Not set for non-data items. May include multiple items including axis labels and legend item. This Vector contains String[2] objects. Index 0 of the String[] is the name and index 1 is the value.

Constructor Detail

NFActiveLabel

public NFActiveLabel()

Create a new object, with no values assigned.

NFActiveLabel

public NFActiveLabel(java.lang.String label,
                     java.net.URL url,
                     java.lang.String target)

Create a new object, with the given values assigned.

Parameters:

label - The ActiveLabel label.

url - The URL of this ActiveLabel.

target - The ActiveLabel target.

Method Detail

setLabel

public void setLabel(java.lang.String label)

Set the label. If the label is set to null, no label will be drawn.

Parameters:

label - The ActiveLabel label.

setURL

public void setURL(java.net.URL url)

Set the URL

Parameters:

url - The URL of this ActiveLabel.

setTarget

public void setTarget(java.lang.String target)

Set the target

Parameters:

target - The ActiveLabel target.

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Set the boundary for the active label

Parameters:

x - The X coordinate of the area.

y - The Y coordinate of the area.

width - The width of the area.

height - The height of the area.

setBounds

public void setBounds(java.awt.Polygon p)

Set the boundary for the active label

Parameters:

p - The Polygon area.

inside

public boolean inside(int x,
                      int y)

Returns true if the given point is inside of the active label bounds.

Parameters:

x - The X coordinate of the area.

y - The Y coordinate of the area.

Returns:

true if the point is inside the area of this ActiveLabel, false otherwise.

reset

public void reset()

Reset this ActiveLabel's area.

isValid

public boolean isValid()

Check if this ActiveLabel's area is valid.

Returns:

true if valid, false otherwise.

activate

public void activate(java.applet.AppletContext ac)

Activate the active label by showing any document specified by the url attribute.

Parameters:

ac - The AppletContext to use to show documents.

drawOutline

public void drawOutline(java.awt.Graphics g,
                        NFLabelIntf label)

Draw the outline of the active label's rectangle or polygon using colors extracted from the passed in NFLabel.

Parameters:

g - The Graphics to draw on.

label - The NFLabel compatible object to get color info from.

draw

public void draw(java.awt.Graphics g,
                 int x,
                 int y,
                 NFLabelIntf label)

Draw the active label at the given location using the given graphics and label objects

Parameters:

g - The Graphics to draw on.

x - The X coordinate of the area.

y - The Y coordinate of the area.

label - The NFLabel compatible object to get color info from.

draw

public void draw(java.awt.Graphics g,
                 NFLabelIntf label)

Draw the active label using the given graphics and label objects

Parameters:

g - The Graphics to draw on.

label - The NFLabel compatible object to get color info from.

loadAllParams

public static java.util.Vector loadAllParams(NFParam p,
                                   java.lang.String name)

Build a vector of ActiveLabels based on the definition of the parameter with the given name.

Parameters:

p - The NFParam to load parameters from.

name - The name of the parameter to load.

Returns:

The Vector of ActiveLabels.

loadParams

public static NFActiveLabel loadParams(NFParam p,
                                       java.lang.Object val)

Build an ActiveLabel using the value vector provided by the parser.

Parameters:

p - The NFParam to load parameters from.

val - The parameter value.

Returns:

The constructed ActiveLabel.

loadParams

public static NFActiveLabel loadParams(NFParam p,
                                       java.lang.Object val,
                                       int offset)

Use the parser values stored in the given vector, starting at the given offset.

Parameters:

p - The NFParam to load parameters from.

val - The parameter value.

offset - The offset of the ActiveLabel parameter.

Returns:

The constructed ActiveLabel.