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

java.lang.Object
  pl.edu.agh.cast.figure.icons.NodeIcon

public final class NodeIcon
extends java.lang.Object

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

Author:

tmilos

Constructor Summary

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

Method Summary

java.lang.String	getGroup() Returns the name of the group this icon belongs to.
org.eclipse.jface.resource.ImageDescriptor	getIconDescriptor() Returns the large icon descriptor.
java.lang.String	getIconId() Returns the large icon unique ID.
java.lang.String	getName() Returns icon's display name.
java.lang.String	getNodeType() Returns the type of node this icon is for (by default).
org.eclipse.jface.resource.ImageDescriptor	getSmallIconDescriptor() Returns the small icon descriptor.
java.lang.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(java.lang.String nodeType,
                java.lang.String name,
                org.eclipse.jface.resource.ImageDescriptor icon,
                org.eclipse.jface.resource.ImageDescriptor smallIcon,
                java.lang.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 java.lang.String getName()

Returns icon's display name.

Returns:

the name

getNodeType

public java.lang.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 java.lang.String getIconId()

Returns the large icon unique ID. This ID may be used as a key in ImageRegistry.

Returns:

the iconId

getSmallIconId

public java.lang.String getSmallIconId()

Returns the small icon unique ID. This ID may be used as a key in ImageRegistry.

Returns:

the smallIconId

getGroup

public java.lang.String getGroup()

Returns the name of the group this icon belongs to. This may be used for palette grouping.

Returns:

the group