Zest
1.5.0.201305060205

org.eclipse.zest.core.viewers
Interface IEntityConnectionStyleProvider


public interface IEntityConnectionStyleProvider

An extension for label providers which allows users to set styles for connections that are based on entity end points.


Method Summary
 Color getColor(java.lang.Object src, java.lang.Object dest)
          Returns the color for the connection.
 int getConnectionStyle(java.lang.Object src, java.lang.Object dest)
          Returns the style flags for this connection.
 Color getHighlightColor(java.lang.Object src, java.lang.Object dest)
          Returns the highlighted color for this connection.
 int getLineWidth(java.lang.Object src, java.lang.Object dest)
          Returns the line width of the connection. -1 for default.
 IFigure getTooltip(java.lang.Object entity)
          Returns the tooltop for this node.
 

Method Detail

getConnectionStyle

int getConnectionStyle(java.lang.Object src,
                       java.lang.Object dest)
Returns the style flags for this connection. Valid flags are those that begin with CONNECTION in @see org.eclipse.zest.core.ZestStyles. Check ZestStyles for legal combinations.

Parameters:
src - the source entity.
dest - the destination entity.
Returns:
the style flags for this connection.
See Also:
ZestStyles

getColor

Color getColor(java.lang.Object src,
               java.lang.Object dest)
Returns the color for the connection. Null for default.

Parameters:
src - the source entity. Any resources created by this class must be disposed by this class.
dest - the destination entity.
Returns:
the color.
See Also:
#dispose()

getHighlightColor

Color getHighlightColor(java.lang.Object src,
                        java.lang.Object dest)
Returns the highlighted color for this connection. Null for default.

Parameters:
src - the source entity. Any resources created by this class must be disposed by this class.
dest - the destination entity.
Returns:
the highlighted color. Null for default.
See Also:
#dispose()

getLineWidth

int getLineWidth(java.lang.Object src,
                 java.lang.Object dest)
Returns the line width of the connection. -1 for default.

Parameters:
src - the source entity.
dest - the destination entity.
Returns:
the line width for the connection. -1 for default.

getTooltip

IFigure getTooltip(java.lang.Object entity)
Returns the tooltop for this node. If null is returned Zest will simply use the default tooltip.

Parameters:
entity -
Returns:

Zest
1.5.0.201305060205

Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved.