Zest
1.5.100.201405261516

org.eclipse.zest.core.viewers
Interface IEntityStyleProvider


public interface IEntityStyleProvider

An extension to Label providers for graphs. Gets specific details about the style of an entity before it is created. This style provider offers: -Background and forground colours -Hilighted and unhighlighted colours (colours defined by selections). -Border color. -Highlighted and unhighlighted colours for borders. -Border width -Font for text inside the entity. Any method may return null if the Zest defaults are preferred. NOTE: It is up to the implementors of this interface to dispose of any Colors or Fonts that are created by this class. The dispose() method will be called at the end of the entity's life-cycle so that this class may dispose of its resources.

See Also:
IColorProvider

Method Summary
 boolean fisheyeNode(java.lang.Object entity)
           
 Color getBackgroundColour(java.lang.Object entity)
          Returns the colour that this node should be coloured.
 Color getBorderColor(java.lang.Object entity)
          Returns the background colour for this entity.
 Color getBorderHighlightColor(java.lang.Object entity)
          Returns the border highlight colour for this entity.
 int getBorderWidth(java.lang.Object entity)
          Returns the border width for this entity.
 Color getForegroundColour(java.lang.Object entity)
           
 Color getNodeHighlightColor(java.lang.Object entity)
          Returns the forground colour of this entity.
 IFigure getTooltip(java.lang.Object entity)
          Returns the tooltop for this node.
 

Method Detail

getNodeHighlightColor

Color getNodeHighlightColor(java.lang.Object entity)
Returns the forground colour of this entity. May return null for defaults. Any resources created by this class must be disposed by this class.

Parameters:
entity - the entity to be styled.
Returns:
the forground colour of this entity.
See Also:
#dispose()

getBorderColor

Color getBorderColor(java.lang.Object entity)
Returns the background colour for this entity. May return null for defaults. Any resources created by this class must be disposed by this class.

Parameters:
entity - the entity to be styled.
Returns:
the background colour for this entity.
See Also:
#dispose()

getBorderHighlightColor

Color getBorderHighlightColor(java.lang.Object entity)
Returns the border highlight colour for this entity. May return null for defaults. Any resources created by this class must be disposed by this class.

Parameters:
entity - the entity to be styled.
Returns:
the border highlight colour for this entity.
See Also:
#dispose()

getBorderWidth

int getBorderWidth(java.lang.Object entity)
Returns the border width for this entity. May return -1 for defaults.

Parameters:
entity - the entity to be styled.
Returns:
the border width, or -1 for defaults.

getBackgroundColour

Color getBackgroundColour(java.lang.Object entity)
Returns the colour that this node should be coloured. This will be ignored if getNodeColour returns null. Any resources created by this class must be diposed by this class.

Parameters:
entity - The entity to be styled
Returns:
The colour for the node
See Also:
#dispose()

getForegroundColour

Color getForegroundColour(java.lang.Object entity)

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:

fisheyeNode

boolean fisheyeNode(java.lang.Object entity)

Zest
1.5.100.201405261516

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