Generation Framework

org.eclipse.gmf.tooldef
Interface AbstractTool

All Superinterfaces:
EObject, Notifier
All Known Subinterfaces:
CreationTool, GenericTool, Palette, PaletteSeparator, StandardTool, ToolContainer, ToolGroup
All Known Implementing Classes:
AbstractToolImpl, CreationToolImpl, GenericToolImpl, PaletteImpl, PaletteSeparatorImpl, StandardToolImpl, ToolContainerImpl, ToolGroupImpl

public interface AbstractTool
extends EObject

A representation of the model object 'Abstract Tool'.

The following features are supported:

See Also:
GMFToolPackage.getAbstractTool()
** Generated **
Model:
abstract="true"

Method Summary
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute
 Image getLargeIcon()
          Returns the value of the 'Large Icon' containment reference
 Image getSmallIcon()
          Returns the value of the 'Small Icon' containment reference
 java.lang.String getTitle()
          Returns the value of the 'Title' attribute
 void setDescription(java.lang.String value)
          Sets the value of the 'Description' attribute
 void setLargeIcon(Image value)
          Sets the value of the 'Large Icon' containment reference
 void setSmallIcon(Image value)
          Sets the value of the 'Small Icon' containment reference
 void setTitle(java.lang.String value)
          Sets the value of the 'Title' attribute
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getSmallIcon

public Image getSmallIcon()
Returns the value of the 'Small Icon' containment reference.

If the meaning of the 'Small Icon' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Small Icon' containment reference.
See Also:
AbstractTool.setSmallIcon(Image), GMFToolPackage.getAbstractTool_SmallIcon()
** Generated **
Model:
containment="true"

setSmallIcon

public void setSmallIcon(Image value)
Sets the value of the 'Small Icon' containment reference.

Parameters:
value - the new value of the 'Small Icon' containment reference.
See Also:
AbstractTool.getSmallIcon()
** Generated **

getLargeIcon

public Image getLargeIcon()
Returns the value of the 'Large Icon' containment reference.

If the meaning of the 'Large Icon' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Large Icon' containment reference.
See Also:
AbstractTool.setLargeIcon(Image), GMFToolPackage.getAbstractTool_LargeIcon()
** Generated **
Model:
containment="true"

setLargeIcon

public void setLargeIcon(Image value)
Sets the value of the 'Large Icon' containment reference.

Parameters:
value - the new value of the 'Large Icon' containment reference.
See Also:
AbstractTool.getLargeIcon()
** Generated **

getTitle

public java.lang.String getTitle()
Returns the value of the 'Title' attribute.

If the meaning of the 'Title' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Title' attribute.
See Also:
AbstractTool.setTitle(String), GMFToolPackage.getAbstractTool_Title()
** Generated **
Model:

setTitle

public void setTitle(java.lang.String value)
Sets the value of the 'Title' attribute.

Parameters:
value - the new value of the 'Title' attribute.
See Also:
AbstractTool.getTitle()
** Generated **

getDescription

public java.lang.String getDescription()
Returns the value of the 'Description' attribute.

If the meaning of the 'Description' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' attribute.
See Also:
AbstractTool.setDescription(String), GMFToolPackage.getAbstractTool_Description()
** Generated **
Model:

setDescription

public void setDescription(java.lang.String value)
Sets the value of the 'Description' attribute.

Parameters:
value - the new value of the 'Description' attribute.
See Also:
AbstractTool.getDescription()
** Generated **

Generation Framework

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.