pl.edu.agh.cast.backward.figure.icons
Class NodeIcon

java.lang.Object
  extended by pl.edu.agh.cast.backward.figure.icons.NodeIcon

public final class NodeIcon
extends Object

Representation of diagram icon specific for given node type. For each node type there may be only one default NodeIcon.

Author:
AGH CAST Team

Constructor Summary
NodeIcon(String nodeType, String name, org.eclipse.jface.resource.ImageDescriptor icon, org.eclipse.jface.resource.ImageDescriptor smallIcon, String group)
          Constructor.
 
Method Summary
 String getGroup()
          Returns the name of the group this icon belongs to.
 org.eclipse.jface.resource.ImageDescriptor getIconDescriptor()
          Returns the large icon descriptor.
 String getIconId()
          Returns the large icon unique ID.
 String getName()
          Returns icon's display name.
 String getNodeType()
          Returns the type of node this icon is for (by default).
 org.eclipse.jface.resource.ImageDescriptor getSmallIconDescriptor()
          Returns the small icon descriptor.
 String getSmallIconId()
          Returns the small icon unique ID.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeIcon

public NodeIcon(String nodeType,
                String name,
                org.eclipse.jface.resource.ImageDescriptor icon,
                org.eclipse.jface.resource.ImageDescriptor smallIcon,
                String group)
Constructor.

Parameters:
nodeType - type of node this icon is for (by default). Should be unique for each NodeIcon.
name - localized icon display name
icon - descriptor of icon's large image
smallIcon - descriptor of icon's small image
group - localized name of the group this icon is in (ex. Billing)
Method Detail

getName

public String getName()
Returns icon's display name.

Returns:
the name

getNodeType

public String getNodeType()
Returns the type of node this icon is for (by default).

Returns:
the nodeType

getIconDescriptor

public org.eclipse.jface.resource.ImageDescriptor getIconDescriptor()
Returns the large icon descriptor.

Returns:
the iconDescriptor

getSmallIconDescriptor

public org.eclipse.jface.resource.ImageDescriptor getSmallIconDescriptor()
Returns the small icon descriptor.

Returns:
the smallIconDescriptor

getIconId

public String getIconId()
Returns the large icon unique ID. This ID may be used as a key in ImageRegistry.

Returns:
the iconId

getSmallIconId

public String getSmallIconId()
Returns the small icon unique ID. This ID may be used as a key in ImageRegistry.

Returns:
the smallIconId

getGroup

public String getGroup()
Returns the name of the group this icon belongs to. This may be used for palette grouping.

Returns:
the group


Copyright © 2007-2009 IISG AGH-UST Krakow, Poland. All Rights Reserved.