org.graphstream.ui.graphicGraph

Class GraphicElement

java.lang.Object

org.graphstream.graph.implementations.AbstractElement

org.graphstream.ui.graphicGraph.GraphicElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

GraphicEdge, GraphicNode, GraphicSprite

public abstract class GraphicElement
extends AbstractElement

Super class of all graphic node, edge, and sprite elements.

Each graphic element references a style, a graphic graph and has a label.

The element also defines the basic behaviour to reload the style when needed, defines abstract methods to set and get the position and bounds in spaces of the element, and to do appropriate actions when specific predefined attributes change (most of them starting with the prefix "ui.").

The graphic element has the ability to store attributes like any other graph element, however the attributes stored by the graphic element are restricted. There is a filter on the attribute adding methods that let pass only :

• All attributes starting with "ui.".
• The "x", "y", "z", "xy" and "xyz" attributes.
• The "stylesheet" attribute.
• The "label" attribute.

All other attributes are filtered and not stored. The result is that if the graphic graph is used as an input (a source of graph events) some attributes will not pass through the filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraphicElement.SwingElementRenderer Interface for renderers registered in each style group.

Nested classes/interfaces inherited from class org.graphstream.graph.implementations.AbstractElement

AbstractElement.AttributeChangeEvent

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object	component Associated GUI component.
boolean	hidden Do not show.
java.lang.String	label The label or null if not specified.
StyleGroup	style The node style.

Constructor Summary

Constructors

Constructor and Description
GraphicElement(java.lang.String id, GraphicGraph graph) New element.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getComponent() The associated GUI component.
java.lang.String	getLabel() Label or null if not set.
abstract Selector.Type	getSelectorType() Type of selector for the graphic element (Node, Edge, Sprite ?).
StyleGroup	getStyle() Style group.
abstract double	getX() Abscissa of the element, always in GU (graph units).
abstract double	getY() Ordinate of the element, always in GU (graph units).
abstract double	getZ() Depth of the element, always in GU (graph units).
abstract void	move(double x, double y, double z) Try to force the element to move at the give location in graph units (GU).
GraphicGraph	myGraph()
void	setAttribute(java.lang.String attribute, java.lang.Object... values) Add or replace the value of an attribute.
void	setComponent(java.lang.Object component) Set the GUI component of this element.

Methods inherited from class org.graphstream.graph.implementations.AbstractElement

attributeKeys, clearAttributes, getAttribute, getAttribute, getAttributeCount, getFirstAttributeOf, getFirstAttributeOf, getId, getIndex, hasAttribute, hasAttribute, removeAttribute, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graphstream.graph.Element

getArray, getLabel, getMap, getNumber, getVector, hasArray, hasLabel, hasMap, hasNumber, hasVector, setAttributes

Field Detail

label

public java.lang.String label

The label or null if not specified.

style

public StyleGroup style

The node style.

component

public java.lang.Object component

Associated GUI component.

hidden

public boolean hidden

Do not show.

Constructor Detail

GraphicElement

public GraphicElement(java.lang.String id,
                      GraphicGraph graph)

New element.

Method Detail

myGraph

public GraphicGraph myGraph()

getSelectorType

public abstract Selector.Type getSelectorType()

Type of selector for the graphic element (Node, Edge, Sprite ?).

getStyle

public StyleGroup getStyle()

Style group. An style group may reference several elements.

Returns:

The style group corresponding to this element.

getLabel

public java.lang.String getLabel()

Label or null if not set.

getX

public abstract double getX()

Abscissa of the element, always in GU (graph units). For edges this is the X of the "from" node.

getY

public abstract double getY()

Ordinate of the element, always in GU (graph units). For edges this is the Y of the "from" node.

getZ

public abstract double getZ()

Depth of the element, always in GU (graph units). For edges this is the Z of the "from" node.

getComponent

public java.lang.Object getComponent()

The associated GUI component.

Returns:

An object.

move

public abstract void move(double x,
                          double y,
                          double z)

Try to force the element to move at the give location in graph units (GU). For edges, this may move the two attached nodes.

Parameters:

x - The new X.

y - The new Y.

z - the new Z.

setComponent

public void setComponent(java.lang.Object component)

Set the GUI component of this element.

Parameters:

component - The component.

setAttribute

public void setAttribute(java.lang.String attribute,
                         java.lang.Object... values)

Description copied from interface: Element

Add or replace the value of an attribute. Existing attributes are overwritten silently. All classes inheriting from Number can be considered as numbers. All classes inheriting from CharSequence can be considered as labels. You can pass zero, one or more arguments for the attribute values. If no value is given, a boolean with value "true" is added. If there is more than one value, an array is stored. If there is only one value, the value is stored (but not in an array).

Specified by:

setAttribute in interface Element

Overrides:

setAttribute in class AbstractElement

Parameters:

attribute - The attribute name.

values - The attribute value or set of values.