Runtime

#

## Eclipse Graphical Modeling Framework (GMF)

## Runtime API Specification

Common Core Packages
org.eclipse.gmf.runtime.common.core.command: Provides a set of classes for executing, undoing and redoing units of work, known as Commands.
org.eclipse.gmf.runtime.common.core.resources
org.eclipse.gmf.runtime.common.core.service: Provides the base interfaces for all service providers.
org.eclipse.gmf.runtime.common.core.util: Provides miscellaneous utility classes that are applicable to the modeling platform.

Common UI Packages
org.eclipse.gmf.runtime.common.ui.action: Provides a set of classes for defining Actions which are run in order to carry out application behaviour that the user has requested through the user-interface.
org.eclipse.gmf.runtime.common.ui.action.actions: Provides a set of common action delegates and action handlers for use with the modeling platform.
org.eclipse.gmf.runtime.common.ui.action.actions.global: Provides a set of common global actions and global action handlers for use with the Global Action Handler Service.
org.eclipse.gmf.runtime.common.ui.action.global: Provides a set of classes for creating global actions for use with the Global Action Handler Service.
org.eclipse.gmf.runtime.common.ui.action.global.providers
org.eclipse.gmf.runtime.common.ui.action.ide.actions.global: Provides a set of IDE global actions and global action handlers for use with the Global Action Handler Service.
org.eclipse.gmf.runtime.common.ui.action.ide.global: Provides a class that specifies the ids of several supported IDE Global Actions.
org.eclipse.gmf.runtime.common.ui.action.util: Provides a set of classes that help in using the modeling platform actions.
org.eclipse.gmf.runtime.common.ui.contentassist: Provides a framework to support content assist.
org.eclipse.gmf.runtime.common.ui.dialogs: Provides implementations of various common dialogs.
org.eclipse.gmf.runtime.common.ui.editors
org.eclipse.gmf.runtime.common.ui.preferences: Provides preference page helpers, including an abstract preference page that supports context sensitive help and some field editors intended for use on preference pages.
org.eclipse.gmf.runtime.common.ui.printing: Aurora internal packages.
org.eclipse.gmf.runtime.common.ui.resources: Provides a framework to support Eclipse resource change events, such as those that relate to `IFile` and `IMarker`.
org.eclipse.gmf.runtime.common.ui.services.action.contributionitem: Provides a set of classes that implement a `Service` that facilitates the contribution of actions to modeling platform workbench parts.
org.eclipse.gmf.runtime.common.ui.services.action.filter: Provides a set of classes to help in evaluating expressions for Eclipse plug-in action enablement and visibility.
org.eclipse.gmf.runtime.common.ui.services.action.global: Provides a set of classes that implement a `Service` that provides an extensible way to handle commonly used (global) actions in different views and editors.
org.eclipse.gmf.runtime.common.ui.services.dnd.core: Provides core support for drag and drop.
org.eclipse.gmf.runtime.common.ui.services.dnd.drag: Provides core support for the drag component of drag and drop.
org.eclipse.gmf.runtime.common.ui.services.dnd.drop: Provides core support for the drop component of drag and drop.
org.eclipse.gmf.runtime.common.ui.services.dnd.ide.core: Provides support for drag and drop with IDE dependencies.
org.eclipse.gmf.runtime.common.ui.services.dnd.ide.drag: Provides support for dragging with IDE dependencies.
org.eclipse.gmf.runtime.common.ui.services.dnd.ide.drop: Provides support for dropping with IDE dependencies.
org.eclipse.gmf.runtime.common.ui.services.editor: Provides an editor service for manipulating `Eclipse Editors`, including an operation to open an editor from an `org.eclipse.ui.IEditorInput`.
org.eclipse.gmf.runtime.common.ui.services.elementselection
org.eclipse.gmf.runtime.common.ui.services.icon: Provides the framework for the icon service.
org.eclipse.gmf.runtime.common.ui.services.marker: Provides the Marker Navigation service, which is used to navigate to an Eclipse `IMarker` in an Eclipse `IEditorPart`.
org.eclipse.gmf.runtime.common.ui.services.parser: Provides the framework for the parser service.
org.eclipse.gmf.runtime.common.ui.services.properties: Provides a framework to contribute contribute property descriptors to the Eclipse property view, given a workbench selection.
org.eclipse.gmf.runtime.common.ui.services.properties.descriptors: Provides a framework to contribute contribute properties to the Eclipse property view, given a workbench selection.
org.eclipse.gmf.runtime.common.ui.services.properties.extended: Provides a set of classes for working with modeling platform properties.
org.eclipse.gmf.runtime.common.ui.services.util
org.eclipse.gmf.runtime.common.ui.util: Provides miscellaneous utility classes for the platform.
org.eclipse.gmf.runtime.common.ui.viewers

Draw2D Packages
org.eclipse.gmf.runtime.draw2d.ui.figures: Provides a set of classes that extend from the org.eclipse.draw2d hierarchies for rendering, geometric manipulation and layout of figures on the drawing surface.
org.eclipse.gmf.runtime.draw2d.ui.geometry: Provides a set of classes for geometric manipulation.
org.eclipse.gmf.runtime.draw2d.ui.mapmode: This package contains the `org.eclipse.gmf.runtime.draw2d.ui.mapmode.MapMode` class.
org.eclipse.gmf.runtime.draw2d.ui.render: This package contains the default interfaces for defining and using a `RenderedImage`.
org.eclipse.gmf.runtime.draw2d.ui.render.factory: Contains the factory class and supporting classes.
org.eclipse.gmf.runtime.draw2d.ui.render.figures: All `IFigure` implementors that depend on the `RenderedImage` interface reside in this package.

EMF Modeling Services Layer Packages
org.eclipse.gmf.runtime.emf.commands.core.command: Specification of the command API for operations that modify EMF models.
org.eclipse.gmf.runtime.emf.commands.core.commands: A collection of concrete (or at least partially realized) commands that may be reused by any MSL client application.
org.eclipse.gmf.runtime.emf.core
org.eclipse.gmf.runtime.emf.core.clipboard: MSL extensions to the clipboard copy/paste framework.
org.eclipse.gmf.runtime.emf.core.resources: GMF resource API.
org.eclipse.gmf.runtime.emf.core.util: Miscellaneous utility classes for working with MSL-managed resources, objects, and meta-models.
org.eclipse.gmf.runtime.emf.type.ui: Provides UI-related classes that use the `ElementTypeRegistry`.
org.eclipse.gmf.runtime.emf.ui.action: Extension to the Common UI action API to support actions that operate on MSL-managed models.
org.eclipse.gmf.runtime.emf.ui.dialogs: Reusable dialogs providing support for working with MSL models, such as browsing for and selecting elements.
org.eclipse.gmf.runtime.emf.ui.preferences: Implementation of preference pages controlling the GMF EMF UI plug-in's UI interaction with the user.
org.eclipse.gmf.runtime.emf.ui.properties.actions: Actions for showing property pages and other properties-related operations.
org.eclipse.gmf.runtime.emf.ui.properties.commands: Reusable commands for use in implementing property editors.
org.eclipse.gmf.runtime.emf.ui.properties.descriptors: Composite property descriptors for EMF property sources.
org.eclipse.gmf.runtime.emf.ui.properties.providers: Defines a generic, MSL-based properties provider for EMF.
org.eclipse.gmf.runtime.emf.ui.properties.sections: Classes for use in defining property editors to compose sections of the properties view.
org.eclipse.gmf.runtime.emf.ui.properties.util: Miscellaneous utility classes for re-use in implementing property editors, actions, etc.
org.eclipse.gmf.runtime.emf.ui.providers.marker: Extension of the Common UI marker-navigation provider API that supports navigation to elements within MSL-managed models.
org.eclipse.gmf.runtime.emf.ui.services.action: Extension of the Common UI action filter framework for filters that need to test elements of MSL-managed models.
org.eclipse.gmf.runtime.emf.ui.services.modelingassistant: The Modeling Assistant Service provides an extensible algorithm for offering users easy access to the most common editing gestures in a particular context of model elements and/or diagrams.
org.eclipse.gmf.runtime.emf.ui.services.parser: MSL-specific extensions to the common parser service.

EMF Clipboard Support Packages
org.eclipse.gmf.runtime.emf.clipboard.core: API for clipboard-oriented copy/paste services that are customizable for metamodel-specific semantics.

EMF Element Type Framework Packages
org.eclipse.gmf.runtime.emf.type.core: This package contains the classes that define primary classes in the Element Type framework.
org.eclipse.gmf.runtime.emf.type.core.commands: Provides a set of commands that are used to edit model elements.
org.eclipse.gmf.runtime.emf.type.core.edithelper: Provides the edit helper and edit helper advice for the Element Type framework.
org.eclipse.gmf.runtime.emf.type.core.requests: Provides a set of requests that are used to ask for commands to edit model elements.

GEF Packages
org.eclipse.gmf.runtime.gef.ui.figures: Provides a set of classes that extend from the org.eclipse.draw2d hierarchies for rendering, geometric manipulation and layout of figures on the drawing surface.

Diagram Core Packages
org.eclipse.gmf.runtime.diagram.core
org.eclipse.gmf.runtime.diagram.core.commands: Aurora internal packages Package Specification this package contains all the supported commands by the diagram layer
org.eclipse.gmf.runtime.diagram.core.edithelpers: Aurora internal packages Package Specification this package contains classes used to help in create the element requests
org.eclipse.gmf.runtime.diagram.core.listener: Aurora internal packages Package Specification this package contains classes related to the listening and Notifying capabilities provided by the diagram layer
org.eclipse.gmf.runtime.diagram.core.preferences
org.eclipse.gmf.runtime.diagram.core.providers
org.eclipse.gmf.runtime.diagram.core.services
org.eclipse.gmf.runtime.diagram.core.services.view: Aurora internal packages Package Specification Provides a set of classes to use when creating views.
org.eclipse.gmf.runtime.diagram.core.util: Aurora internal packages Package Specification This package contains utility classes used by this plugin.
org.eclipse.gmf.runtime.diagram.core.view.factories: Aurora internal packages Package Specification ToDo: Fill in specific content

Diagram Notation Packages
org.eclipse.gmf.runtime.notation: Notation meta-model primary package.
org.eclipse.gmf.runtime.notation.datatype: Aurora internal packages Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.notation.impl: Aurora internal packages Package Specification ToDo: Fill in specific content

Diagram UI Packages
org.eclipse.gmf.runtime.diagram.ui: Aurora internal packages Package Specification This package contains the necessary plugin classes: DebugOptions Plugin StatusCodes
org.eclipse.gmf.runtime.diagram.ui.actions: Aurora internal packages Package Specification This package contains the necessary plugin classes: DebugOptions Plugin StatusCodes
org.eclipse.gmf.runtime.diagram.ui.commands: Aurora internal packages Package Specification Diagram ui commands
org.eclipse.gmf.runtime.diagram.ui.dialogs.sortfilter: Aurora internal packages Package Specification dialogs for the sort filter
org.eclipse.gmf.runtime.diagram.ui.dnd.parts: Aurora internal packages Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.editparts: Aurora internal packages Package Specification This package contains the edit part classes.
org.eclipse.gmf.runtime.diagram.ui.editpolicies: Aurora internal packages Package Specification This package contains the edit policy classes.
org.eclipse.gmf.runtime.diagram.ui.figures: Aurora internal packages Package Specification the figures package
org.eclipse.gmf.runtime.diagram.ui.handles: Aurora internal packages Package Specification handles and handle locator package
org.eclipse.gmf.runtime.diagram.ui.image: Aurora internal packages Package Specification this package contains classes related to the imge support
org.eclipse.gmf.runtime.diagram.ui.l10n: Aurora internal packages Package Specification This package contains classes to manage the string, image, font and cursor resources for this plugin.
org.eclipse.gmf.runtime.diagram.ui.layout
org.eclipse.gmf.runtime.diagram.ui.menus: High level UI menus intended for the diagram surface.
org.eclipse.gmf.runtime.diagram.ui.parts: Aurora internal packages Package Specification this package sontains the editors and the editing domain
org.eclipse.gmf.runtime.diagram.ui.preferences
org.eclipse.gmf.runtime.diagram.ui.printing.actions: Package Specification This package contains a set of classes for defining Actions which are run in order to carry out application behaviour that the user has requested through the user-interface.
org.eclipse.gmf.runtime.diagram.ui.printing.providers
org.eclipse.gmf.runtime.diagram.ui.printing.render.actions: Package Specification This package contains printing actions or action helpers.
org.eclipse.gmf.runtime.diagram.ui.printing.render.providers: Package Specification This package contains the service provider classes for this plugin.
org.eclipse.gmf.runtime.diagram.ui.printing.render.util: Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.printing.util: Package Specification This package contains utility classes used by this plugin.
org.eclipse.gmf.runtime.diagram.ui.properties.descriptors: Aurora internal packages Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.properties.filters: Aurora internal packages.
org.eclipse.gmf.runtime.diagram.ui.properties.providers: Aurora internal packages Package Specification This package contains the service provider classes for this plugin.
org.eclipse.gmf.runtime.diagram.ui.properties.sections: Aurora internal packages.
org.eclipse.gmf.runtime.diagram.ui.properties.sections.appearance
org.eclipse.gmf.runtime.diagram.ui.properties.sections.grid
org.eclipse.gmf.runtime.diagram.ui.properties.views: Aurora internal packages.
org.eclipse.gmf.runtime.diagram.ui.providers: Aurora internal packages Package Specification This package contains the necessary plugin classes: DebugOptions Plugin StatusCodes
org.eclipse.gmf.runtime.diagram.ui.providers.ide.providers: This package contains a contribution item provider and a global action handler and provider for diagram IDE Global Actions.
org.eclipse.gmf.runtime.diagram.ui.render.actions
org.eclipse.gmf.runtime.diagram.ui.render.clipboard: Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.render.editparts: Package Specification This package contains the edit part classes.
org.eclipse.gmf.runtime.diagram.ui.render.providers: Package Specification This package contains the service provider classes for this plugin.
org.eclipse.gmf.runtime.diagram.ui.render.util: Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.requests: Aurora internal packages Package Specification thispackage contains the supported request classes
org.eclipse.gmf.runtime.diagram.ui.resources.editor.document
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.document
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.editor
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.util: This package contains utility classes used by this plugin which have IDE dependencies.
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.wizards: Package Specification ToDo: Fill in specific content
org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts
org.eclipse.gmf.runtime.diagram.ui.resources.editor.util
org.eclipse.gmf.runtime.diagram.ui.services.decorator: Aurora internal packages Package Specification this package contains the decorator specific classes like the provider, operation and the decorator itself
org.eclipse.gmf.runtime.diagram.ui.services.editpart: Aurora internal packages Package Specification This package contains the edit part classes.
org.eclipse.gmf.runtime.diagram.ui.services.editpolicy: Aurora internal packages Package Specification This package contains the edit policy classes.
org.eclipse.gmf.runtime.diagram.ui.services.layout: Aurora internal packages Package Specification Lauout specific classes either operations or types
org.eclipse.gmf.runtime.diagram.ui.services.palette: Aurora internal packages Package Specification contains the palette service and the palette type
org.eclipse.gmf.runtime.diagram.ui.tools: Aurora internal packages Package Specification This package contains the creation tool specific classes, they could create Notation views or Semantic elemetn sor both
org.eclipse.gmf.runtime.diagram.ui.util: Aurora internal packages Package Specification This package contains utility classes used by this plugin.
org.eclipse.gmf.runtime.diagram.ui.view.factories: Aurora internal packages Package Specification This package contains the Notation meta model View Factories.

Runtime

Guidelines for using Eclipse APIs.

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