salvo.jesus.graph.visual

Interface VisualGraphComponent

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractVisualGraphComponent, VisualEdge, VisualVertex

public interface VisualGraphComponent
extends Serializable

The interface for all 'components' in a VisualGraph. Note that classes implementing this interface may not be real components in the same sense as AWT or Swing components.

Author:

Jesus M. Salvo Jr.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(MouseListener l) Adds a listener to receive mouse events on this VisualGraphComponent.
void	addMouseMotionListener(MouseMotionListener l) Adds a listener to receive mouse motion events on this VisualGraphComponent.
Rectangle	getBounds() Returns the bounding Rectangle of the VisualGraphComponent.
Rectangle2D	getBounds2D() Returns the bounding Rectangle of the VisualGraphComponent.
Color	getFillcolor() Returns the color used to fill the VisualGraphComponent
Font	getFont() Returns the font used to draw the String describing the VisualGraphComponent.
Color	getFontcolor() Returns the color used to draw the string representation of the VisualGraphComponent
FontMetrics	getFontMetrics() Return the FontMetrics for this VisualGraphComponent., which is used to define the width and height of the text and therefore also of the component.
GeneralPath	getGeneralPath() Returns the GeneralPath used for rendering the outline of the VisualGraphComponent.
String	getLabel() Returns the text displayed for the VisualGraphComponent
Color	getOutlinecolor() Returns the color used to draw the outline of the VisualGraphComponent
VisualGraph	getVisualGraph() Returns the VisualGraph where the VisualGraphComponent is contained.
void	processKeyEvent(KeyEvent e) Processes key events occuring on this VisualGraphComponent.
void	processMouseEvent(MouseEvent e) Processes mouse events occuring on this VisualGraphComponent.
void	processMouseMotionEvent(MouseEvent e) Processes mouse motion events occuring on this VisualGraphComponent.
void	removeMouseListener(MouseListener l) Removes the specified mouse listener so that it no longer receives mouse events from this VisualGraphComponent.
void	removeMouseMotionListener(MouseMotionListener l) Removes the specified mouse motion listener so that it no longer receives mouse motion events from this VisualGraphComponent.
void	rescale() Rescales the VisualGraphComponent.
void	setFillcolor(Color fillcolor) Sets the fill color used to draw the VisualGraphComponent
void	setFont(Font font) Sets the font used to draw the String describing the VisualGraphComponent
void	setFontcolor(Color fontcolor) Sets the color of the font used to draw the String describing the VisualGraphComponent
void	setGeneralPath(GeneralPath path) Sets geometry used to draw the outline of the VisualGraphComponent.
void	setGeneralPath(PathIterator pathIterator) Sets geometry used to draw the outline of the VisualGraphComponent.
void	setLabel(String text) Sets the text displayed for the VisualGraphComponent
void	setOutlinecolor(Color outlinecolor) Sets the outline color used to draw the VisualGraphComponent
String	toString() String representation of the VisualGraphComponent.

Method Detail

getLabel

String getLabel()

Returns the text displayed for the VisualGraphComponent

getFillcolor

Color getFillcolor()

Returns the color used to fill the VisualGraphComponent

Returns:

The fill or background Color

getOutlinecolor

Color getOutlinecolor()

Returns the color used to draw the outline of the VisualGraphComponent

Returns:

The outline Color

getFont

Font getFont()

Returns the font used to draw the String describing the VisualGraphComponent.

Returns:

The Font used to draw the string

getFontMetrics

FontMetrics getFontMetrics()

Return the FontMetrics for this VisualGraphComponent., which is used to define the width and height of the text and therefore also of the component.

getFontcolor

Color getFontcolor()

Returns the color used to draw the string representation of the VisualGraphComponent

Returns:

The font Color

getGeneralPath

GeneralPath getGeneralPath()

Returns the GeneralPath used for rendering the outline of the VisualGraphComponent.

Returns:

The GeneralPath used to draw the outline of the VisualGraphComponent.

getVisualGraph

VisualGraph getVisualGraph()

Returns the VisualGraph where the VisualGraphComponent is contained.

setLabel

void setLabel(String text)

Sets the text displayed for the VisualGraphComponent

setFillcolor

void setFillcolor(Color fillcolor)

Sets the fill color used to draw the VisualGraphComponent

Parameters:

c - The new Color object that will be used as the fill color on the next painting of the VisualGraphComponent

setOutlinecolor

void setOutlinecolor(Color outlinecolor)

Sets the outline color used to draw the VisualGraphComponent

Parameters:

c - The new Color object that will be used as the outline color on the next painting of the VisualGraphComponent

setFont

void setFont(Font font)

Sets the font used to draw the String describing the VisualGraphComponent

Parameters:

f - The new Font that will be used

setFontcolor

void setFontcolor(Color fontcolor)

Sets the color of the font used to draw the String describing the VisualGraphComponent

Parameters:

fontcolor - Font color to be used

setGeneralPath

void setGeneralPath(GeneralPath path)

Sets geometry used to draw the outline of the VisualGraphComponent.

Parameters:

path - A GeneralPath object used to draw outline of the VisualGraphComponent.

setGeneralPath

void setGeneralPath(PathIterator pathIterator)

Sets geometry used to draw the outline of the VisualGraphComponent.

Parameters:

pathIterator - A PathIterator object used to draw outline of the VisualGraphComponent.

getBounds

Rectangle getBounds()

Returns the bounding Rectangle of the VisualGraphComponent.

Returns:

The Rectangle bounding the VisualGraphComponent.

rescale

void rescale()

Rescales the VisualGraphComponent.

getBounds2D

Rectangle2D getBounds2D()

Returns the bounding Rectangle of the VisualGraphComponent.

Returns:

The Rectangle2D bounding the VisualGraphComponent.

toString

String toString()

String representation of the VisualGraphComponent.

Overrides:

toString in class Object

addMouseListener

void addMouseListener(MouseListener l)

Adds a listener to receive mouse events on this VisualGraphComponent.

Parameters:

l - The listener to receive mouse events.

addMouseMotionListener

void addMouseMotionListener(MouseMotionListener l)

Adds a listener to receive mouse motion events on this VisualGraphComponent.

Parameters:

l - The listener to receive mouse motion events.

removeMouseListener

void removeMouseListener(MouseListener l)

Removes the specified mouse listener so that it no longer receives mouse events from this VisualGraphComponent.

Parameters:

l - The listener to be removed.

removeMouseMotionListener

void removeMouseMotionListener(MouseMotionListener l)

Removes the specified mouse motion listener so that it no longer receives mouse motion events from this VisualGraphComponent.

Parameters:

l - The listener to receive mouse events.

processMouseEvent

void processMouseEvent(MouseEvent e)

Processes mouse events occuring on this VisualGraphComponent. This method is not directly called by Java, but must be called explicitly by the container (GraphPanel) where VisualGraphComponent is contained.

Parameters:

e - The mouse event

processMouseMotionEvent

void processMouseMotionEvent(MouseEvent e)

Processes mouse motion events occuring on this VisualGraphComponent. This method is not directly called by Java, but must be called explicitly by the container (GraphPanel) where VisualGraphComponent is contained.

Parameters:

e - The mouse event

processKeyEvent

void processKeyEvent(KeyEvent e)

Processes key events occuring on this VisualGraphComponent. This method is not directly called by Java, but must be called explicitly by the container (GraphPanel) where VisualGraphComponent is contained.