com.togethersoft.openapi.modelnavigator
Class NodeUIProvider


public class NodeUIProvider

Class used as a source of information that defines representation of tree nodes.
Use NodeUIService.addNodeUIProvider method to register your UI provider.
You can use default values or override methods to return necessary information.

Author:
TogetherSoft

Method Summary
 StringgetDisplayName(Reference ref)
          Returns string that will be displayed as a name of a node.
 IcongetIcon(Reference ref)
          Return an icon to be displayed for node representing specified model reference.
 ColorgetTextColor(Reference ref)
          Returns color of text to be used to display node's name.
 FontgetTextFont(Reference ref)
          Returns text font to be used to display node's name.
 StringgetToolTipText(Reference ref)
          Returns tooltip text to be displayed for a node.

Method Detail

getDisplayName

public String getDisplayName(Reference ref)
Returns string that will be displayed as a name of a node.
The value of Property.NAME is used by default.
Parameters:
ref Reference object that belongs to node
Returns: Text string used as node's name

getIcon

public Icon getIcon(Reference ref)
Return an icon to be displayed for node representing specified model reference.
Parameters:
ref Reference object that belongs to node
Returns: Icon object

getTextColor

public Color getTextColor(Reference ref)
Returns color of text to be used to display node's name.
Parameters:
ref Reference object that belongs to node
Returns: Color of node's name text

getTextFont

public Font getTextFont(Reference ref)
Returns text font to be used to display node's name.
Parameters:
ref Reference object that belongs to node
Returns: Font object

getToolTipText

public String getToolTipText(Reference ref)
Returns tooltip text to be displayed for a node.
Parameters:
ref Reference object that belongs to node
Returns: Text string used as tooltip