netcharts.pro.charts.diagram
Class NFNode

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.charts.diagram.NFNode

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFNode
extends NFBaseClass
implements NFCDLGenerator

The NFNode object represents a textual, image, shape, or a point on a diagram chart. Lines may be drawn between nodes by use of the NFNodeEdge class.

Constructor Summary

NFNode()
Constructs a default node.

NFNode(java.lang.String nodeName)
Constructs a node with the given name.

Method Summary

NFActiveLabel	getActiveLabel() Gets the node's active label.
java.lang.String	getCDL() Generate CDL parameters representing this node
java.lang.String	getNodeName() Gets the name of this node.
NFPoint	getPoint() Return the pixel location of the node.
NFRegion	getRegion() Gets the region style for the node
java.lang.String	getText() Gets the text to be displayed on the node.
NFTextStyle	getTextStyle() Gets the text style for the node.
double	getX() Returns the x coordinate of the node.
double	getY() Returns the y coordinate of the node.
void	setActiveLabel(NFActiveLabel activeLabel) Sets the node's active label.
void	setCDL(java.lang.String cdl) Configures this object from a CDL parameter representation.
void	setNodeName(java.lang.String nodeName) Sets the name of the node.
void	setPoint(NFPoint point) Sets the pixel location of the node.
void	setRegion(NFRegion region) Sets the region style for the node
void	setText(java.lang.String text) Sets the text to be displayed on the node..
void	setTextStyle(NFTextStyle textStyle) Sets the text style for the node.
void	setX(double x) Set the x coordinate of the node.
void	setY(double y) Set the y coordinate of the node.
java.lang.String	toString() Returns a new String object representing this node.

Methods inherited from class netcharts.pro.common.NFBaseClass

clone, getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NFNode

public NFNode()

Constructs a default node.

NFNode

public NFNode(java.lang.String nodeName)

Constructs a node with the given name.

Parameters:

nodeName - The name of the node.

Method Detail

getNodeName

public java.lang.String getNodeName()

Gets the name of this node.

Returns:

the name of the node. If a name has not been set, an automatically generated name will be provided.

setNodeName

public void setNodeName(java.lang.String nodeName)

Sets the name of the node. If the name is null, then the name will not be set.

Parameters:

nodeName - The name of the node.

setText

public void setText(java.lang.String text)

Sets the text to be displayed on the node..

Parameters:

text - The node text.

getText

public java.lang.String getText()

Gets the text to be displayed on the node.

Returns:

the node text or null if not defined.

setPoint

public void setPoint(NFPoint point)

Sets the pixel location of the node.

Parameters:

point - The node's location.

getPoint

public NFPoint getPoint()

Return the pixel location of the node.

Returns:

the node's location or null if not defined.

getX

public double getX()

Returns the x coordinate of the node.

Returns:

The x coordinate of the node

getY

public double getY()

Returns the y coordinate of the node.

Returns:

The y coordinate of the node

setX

public void setX(double x)

Set the x coordinate of the node.

Parameters:

x - The x coordinate of the node

setY

public void setY(double y)

Set the y coordinate of the node.

Parameters:

y - The y coordinate of the node

setTextStyle

public void setTextStyle(NFTextStyle textStyle)

Sets the text style for the node.

Parameters:

textStyle - The node's text style.

getTextStyle

public NFTextStyle getTextStyle()

Gets the text style for the node.

Parameters:

the - node's text style or null if not defined.

setRegion

public void setRegion(NFRegion region)

Sets the region style for the node

Parameters:

region. - The node's region style.

getRegion

public NFRegion getRegion()

Gets the region style for the node

Returns:

region. The node's region style or null if not defined.

setActiveLabel

public void setActiveLabel(NFActiveLabel activeLabel)

Sets the node's active label.

Parameters:

activeLabel. - The node's active label.

getActiveLabel

public NFActiveLabel getActiveLabel()

Gets the node's active label.

Returns:

the node's active label or null if not defined.

toString

public java.lang.String toString()

Returns a new String object representing this node.

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class java.lang.Object

Returns:

A new String object in the same form as that given by getCDL().

setCDL

public void setCDL(java.lang.String cdl)

Configures this object from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in the form: ("nodeName", "text", X, Y)

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this node

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: ("nodeName", "text", X, Y)