com.tensegrity.graph.view
Class InteractionHighlightConfiguration

java.lang.Object
  com.tensegrity.graph.view.InteractionHighlightConfiguration

public final class InteractionHighlightConfiguration

extends java.lang.Object

The InteractionHighlightConfiguration class serves as a central point for the configuration of the highlights that are displayed throughout user interaction.

Version:

$Id: InteractionHighlightConfiguration.java,v 1.4 2005/10/27 10:49:35 MichaelKegel Exp $

Author:

Stepan Rutz, MichaelKegel

See Also:

Composite

Constructor Summary

InteractionHighlightConfiguration()
Constructs a new default InteractionHighlightConfiguration instance.

Method Summary

Composite	createEdgeSplitHighlight() Returns an instance of an edge-split highlight.
Composite	createGroupDropHighlight() Returns an instance of a group-drop highlight.
Composite	createOverlayEdgeCreationHighlight() Returns an instance of an overlay-edge-creation highlight.
Composite	createSuperposedNodeHighlight()
java.lang.String	getEdgeSplitGeometry() Returns the current edge-split highlighting Composite geometry name.
Size	getEdgeSplitSize() Returns the current edge-split highlighting Composite size.
java.lang.String	getEdgeSplitStyle() Returns the current edge-split highlighting Composite style name.
java.lang.String	getGroupDropGeometry() Returns the current group-drop highlighting Composite geometry name.
Size	getGroupDropSize() Returns the current group-drop highlighting Composite size.
java.lang.String	getGroupDropStyle() Returns the current group-drop highlighting Composite style name.
java.lang.String	getOverlayEdgeCreationGeometry() Returns the current overlay-edge-creation highlighting Composite geometry name
Size	getOverlayEdgeCreationSize() Returns the current overlay-edge-creation highlighting Composite size.
java.lang.String	getOverlayEdgeCreationStyle() Returns the current overlay-edge-creation highlighting Composite style name.
java.lang.String	getSuperposedNodeGeometry()
Size	getSuperposedNodeHighlightSize()
java.lang.String	getSuperposedNodeStyle()
boolean	isDisplayOverlayEdgeCreationHighlight()
boolean	isDisplaySuperposedNodeHighlight()
void	setDisplayOverlayEdgeCreationHighlight(boolean displayOverlayEdgeCreationHighlight)
void	setDisplaySuperposedNodeHighlight(boolean displaySuperposedNodeHighlight)
void	setEdgeSplitGeometry(java.lang.String edgeSplitGeometry) Sets the edge-split highlighting Composite geometry name to the value given by edgeSplitGeometry.
void	setEdgeSplitSize(Size edgeSplitSize) Sets the edge-split highlighting Composite size to the value given by edgeSplitSize.
void	setEdgeSplitSize(java.lang.String edgeSplitSize) Sets the edge-split highlighting Composite size to the value given by groupDropSize.
void	setEdgeSplitStyle(java.lang.String edgeSplitStyle) Sets the edge-split highlighting Composite style name to the value given by edgeSplitStyle.
void	setGroupDropGeometry(java.lang.String groupDropGeometry) Sets the group-drop highlighting Composite geometry name to the value given by groupDropGeometry.
void	setGroupDropSize(Size groupDropSize) Sets the group-drop highlighting Composite size to the value given by groupDropSize.
void	setGroupDropSize(java.lang.String groupDropSize) Sets the group-drop highlighting Composite size to the value given by groupDropSize.
void	setGroupDropStyle(java.lang.String groupDropStyle) Sets the group-drop highlighting Composite style name to the value given by groupDropStyle.
void	setOverlayEdgeCreationGeometry(java.lang.String overlayEdgeCreationGeometry) Sets the overlay-edge-creation highlighting Composite geometry name to the value given by overlayEdgeCreationGeometry.
void	setOverlayEdgeCreationSize(Size overlayEdgeCreationSize) Sets the overlay-edge-creation highlighting Composite size to the value given by overlayEdgeCreationSize.
void	setOverlayEdgeCreationSize(java.lang.String overlayEdgeCreationSize) Sets the overlay-edge-creation highlighting Composite size to the value given by overlayEdgeCreationSize.
void	setOverlayEdgeCreationStyle(java.lang.String overlayEdgeCreationStyle) Sets the overlay-edge-creation highlighting Composite style name to the value given by overlayEdgeCreationStyle.
void	setSuperposedNodeHighlightGeometry(java.lang.String superposedNodeHighlightGeometry)
void	setSuperposedNodeHighlightSize(Size superposedNodeHighlightSize)
void	setSuperposedNodeHighlightSize(java.lang.String superposedNodeHighlightSize)
void	setSuperposedNodeHighlightStyle(java.lang.String superposedNodeHighlightStyle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InteractionHighlightConfiguration

public InteractionHighlightConfiguration()

Constructs a new default InteractionHighlightConfiguration instance.

Method Detail

getEdgeSplitGeometry

public final java.lang.String getEdgeSplitGeometry()

Returns the current edge-split highlighting Composite geometry name.

Returns:

String the current edge-split highlight geometry name.

setEdgeSplitGeometry

public final void setEdgeSplitGeometry(java.lang.String edgeSplitGeometry)

Sets the edge-split highlighting Composite geometry name to the value given by edgeSplitGeometry.

Parameters:

edgeSplitGeometry - the name of the geometry to use.

getEdgeSplitStyle

public final java.lang.String getEdgeSplitStyle()

Returns the current edge-split highlighting Composite style name.

Returns:

String the current edge-split hightlight style name

setEdgeSplitStyle

public final void setEdgeSplitStyle(java.lang.String edgeSplitStyle)

Sets the edge-split highlighting Composite style name to the value given by edgeSplitStyle.

Parameters:

edgeSplitStyle - the name of the style to use

getEdgeSplitSize

public final Size getEdgeSplitSize()

Returns the current edge-split highlighting Composite size.

Returns:

Size the current edge-split hightlight size

setEdgeSplitSize

public final void setEdgeSplitSize(java.lang.String edgeSplitSize)
                            throws MetricExpressionParserException

Sets the edge-split highlighting Composite size to the value given by groupDropSize.
Since the size is given within a string representation the method expects a metric expression for each dimension starting with x. The metric expressions must be separated by a comma. NOTICE:the given string must contain at least two valid metric expressions. For instance the string could look like '1.5cm, 1.5cm' or '10mm, 7.5mm'. If one of the two given metric expressions is not valid a MetricExpressionParserException is thrown.

Parameters:

edgeSplitSize - the size to use in string representation

Throws:

MetricExpressionParserException - is thrown if one of the two given metric expressions cannot be parsed

setEdgeSplitSize

public final void setEdgeSplitSize(Size edgeSplitSize)

Sets the edge-split highlighting Composite size to the value given by edgeSplitSize.

Parameters:

edgeSplitSize - the size to use

createEdgeSplitHighlight

public final Composite createEdgeSplitHighlight()

Returns an instance of an edge-split highlight. The properties of the edge-split highlight are set to the values configured through this class. If an error occurs (for instance due to a wrong geometry name) null is returned.
If it is needed the returned instance of the edge-split highlight can be modified.

Returns:

Composite an instance of an edge-split highlight

isDisplayOverlayEdgeCreationHighlight

public final boolean isDisplayOverlayEdgeCreationHighlight()

setDisplayOverlayEdgeCreationHighlight

public final void setDisplayOverlayEdgeCreationHighlight(boolean displayOverlayEdgeCreationHighlight)

getOverlayEdgeCreationGeometry

public final java.lang.String getOverlayEdgeCreationGeometry()

Returns the current overlay-edge-creation highlighting Composite geometry name

Returns:

String the current overlay-edge-creation highlight geometry name

setOverlayEdgeCreationGeometry

public final void setOverlayEdgeCreationGeometry(java.lang.String overlayEdgeCreationGeometry)

Sets the overlay-edge-creation highlighting Composite geometry name to the value given by overlayEdgeCreationGeometry.

Parameters:

overlayEdgeCreationGeometry - the name of the geometry to use

getOverlayEdgeCreationStyle

public final java.lang.String getOverlayEdgeCreationStyle()

Returns the current overlay-edge-creation highlighting Composite style name.

Returns:

String the current overlay-edge-creation hightlight style name.

setOverlayEdgeCreationStyle

public final void setOverlayEdgeCreationStyle(java.lang.String overlayEdgeCreationStyle)

Sets the overlay-edge-creation highlighting Composite style name to the value given by overlayEdgeCreationStyle.

Parameters:

overlayEdgeCreationStyle - the name of the style to use.

getOverlayEdgeCreationSize

public final Size getOverlayEdgeCreationSize()

Returns the current overlay-edge-creation highlighting Composite size.

Returns:

Size the current overlay-edge-creation hightlight size

setOverlayEdgeCreationSize

public final void setOverlayEdgeCreationSize(java.lang.String overlayEdgeCreationSize)
                                      throws MetricExpressionParserException

Sets the overlay-edge-creation highlighting Composite size to the value given by overlayEdgeCreationSize.
Since the size is given within a string representation the method expects a metric expression for each dimension starting with x. The metric expressions must be separated by a comma. NOTICE:the given string must contain at least two valid metric expressions. For instance the string could look like '1.5cm, 1.5cm' or '10mm, 7.5mm'. If one of the two given metric expressions is not valid a MetricExpressionParserException is thrown.

Parameters:

overlayEdgeCreationSize - the size to use in string representation

Throws:

MetricExpressionParserException - is thrown if one of the two given metric expressions cannot be parsed

setOverlayEdgeCreationSize

public final void setOverlayEdgeCreationSize(Size overlayEdgeCreationSize)

Sets the overlay-edge-creation highlighting Composite size to the value given by overlayEdgeCreationSize.

Parameters:

overlayEdgeCreationSize - the size to use

createOverlayEdgeCreationHighlight

public final Composite createOverlayEdgeCreationHighlight()

Returns an instance of an overlay-edge-creation highlight. The properties of the overlay-edge-creation highlight are set to the values configured through this class. If an error occurs (for instance due to a wrong geometry name) null is returned.
If it is needed the returned instance of the overlay-edge-creation highlight can be modified.

Returns:

Composite an instance of an overlay-edge-creation highlight

isDisplaySuperposedNodeHighlight

public final boolean isDisplaySuperposedNodeHighlight()

setDisplaySuperposedNodeHighlight

public final void setDisplaySuperposedNodeHighlight(boolean displaySuperposedNodeHighlight)

getSuperposedNodeGeometry

public final java.lang.String getSuperposedNodeGeometry()

setSuperposedNodeHighlightGeometry

public final void setSuperposedNodeHighlightGeometry(java.lang.String superposedNodeHighlightGeometry)

getSuperposedNodeStyle

public final java.lang.String getSuperposedNodeStyle()

setSuperposedNodeHighlightStyle

public final void setSuperposedNodeHighlightStyle(java.lang.String superposedNodeHighlightStyle)

getSuperposedNodeHighlightSize

public final Size getSuperposedNodeHighlightSize()

setSuperposedNodeHighlightSize

public final void setSuperposedNodeHighlightSize(java.lang.String superposedNodeHighlightSize)
                                          throws MetricExpressionParserException

Throws:

MetricExpressionParserException

setSuperposedNodeHighlightSize

public final void setSuperposedNodeHighlightSize(Size superposedNodeHighlightSize)

createSuperposedNodeHighlight

public final Composite createSuperposedNodeHighlight()

getGroupDropGeometry

public final java.lang.String getGroupDropGeometry()

Returns the current group-drop highlighting Composite geometry name.

Returns:

String the current group-drop highlight geometry name.

setGroupDropGeometry

public final void setGroupDropGeometry(java.lang.String groupDropGeometry)

Sets the group-drop highlighting Composite geometry name to the value given by groupDropGeometry.

Parameters:

groupDropGeometry - the group-drop-highlight geometry to use.

getGroupDropStyle

public final java.lang.String getGroupDropStyle()

Returns the current group-drop highlighting Composite style name.

Returns:

String the current group-drop hightlight style name.

setGroupDropStyle

public final void setGroupDropStyle(java.lang.String groupDropStyle)

Sets the group-drop highlighting Composite style name to the value given by groupDropStyle.

Parameters:

groupDropStyle - the group-drop-highlight style to use.

getGroupDropSize

public final Size getGroupDropSize()

Returns the current group-drop highlighting Composite size.

Returns:

Size the current group-drop hightlight size

setGroupDropSize

public final void setGroupDropSize(java.lang.String groupDropSize)
                            throws MetricExpressionParserException

Sets the group-drop highlighting Composite size to the value given by groupDropSize.
Since the size is given within a string representation the method expects a metric expression for each dimension starting with x. The metric expressions must be separated by a comma. NOTICE:the given string must contain at least two valid metric expressions. For instance the string could look like '1.5cm, 1.5cm' or '10mm, 7.5mm'. If one of the two given metric expressions is not valid a MetricExpressionParserException is thrown.

Parameters:

groupDropSize - the size to use in string representation

Throws:

MetricExpressionParserException - is thrown if one of the two given metric expressions cannot be parsed

setGroupDropSize

public final void setGroupDropSize(Size groupDropSize)

Sets the group-drop highlighting Composite size to the value given by groupDropSize.

Parameters:

groupDropSize - the size to use

createGroupDropHighlight

public final Composite createGroupDropHighlight()

Returns an instance of a group-drop highlight. The properties of the group-drop highlight are set to the values configured through this class. If an error occurs (for instance due to a wrong geometry name) null is returned.
If it is needed the returned instance of the group-drop highlight can be modified.

Returns:

Composite an instance of a group-drop highlight