Eclipse GMF Guide (Galileo) - org.eclipse.gmf.runtime.emf.clipboard.core (Eclipse GMF Documentation)

Eclipse GMF Guide
Previous Page	Home	Next Page

GMF Developer Guide Reference API Reference GMF Runtime

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Runtime

PREV PACKAGE NEXT PACKAGE

NO FRAMES

Package org.eclipse.gmf.runtime.emf.clipboard.core

API for clipboard-oriented copy/paste services that are customizable for metamodel-specific semantics.

See:
Description

Interface Summary

IClipboardSupport An interface to be implemented by EMF metamodel providers to inject metamodel-specific semantics into copy/paste operations.

IClipboardSupportFactory Interface for objects that can create IClipboardSupports for supporting clipboard copy/paste operations on EMF models.

Class Summary

AbstractClipboardSupport A convenient default implementation of most of the features required of a clipboard support utility.

BasePasteOperation Abstract specification of all paste operations, providing common behaviours and enforcing certain protocols.

ClipboardOperation Abstract specification of a copy or paste operation.

ClipboardSupportUtil Utilities to assist the implementation of IClipboardSupports by plug-ins extending the clipboardSupport extension point.

ClipboardUtil Utility for the creation of IClipboardSupport instances for specific EMF metamodels, and for copy/paste operations to and from a String form for use on the system clipboard.

CopyObjects A data structure that holds info needed through the copy process

CopyOperation The default copy operation.

ObjectInfo Data structure storing meta-data related to the copying of an element.

OverrideCopyOperation Abstract definition of an IClipboardSupport-defined operation that completely overrides the default copy behaviour.

OverridePasteChildOperation Abstract definition of an IClipboardSupport-defined operation that completely overrides the default paste-child behaviour.

PasteAction An enumeration of actions to resolve paste collisions.

PasteChildOperation An operation to paste a child object into a new target parent object.

PasteOption An enumeration of paste options.

PasteTarget A class which stores the target object for the paste operation.

PostPasteChildOperation Abstract definition of an IClipboardSupport-defined operation that follows the pasting of a child element into the target parent, to perform additional work.

Package org.eclipse.gmf.runtime.emf.clipboard.core Description

API for clipboard-oriented copy/paste services that are customizable for metamodel-specific semantics. For invocation of the copy/paste functionality, see ClipboardUtil.

Package Specification

The primary mechanism for customization of a meta-model's copy/paste requirements is the IClipboardSupport interface. Where this interface is not sufficient to control copy/paste behaviour, the specialization of the following classes is permitted to define custom copy and paste operations:

OverrideCopyOperation: for special copying behaviour. This class inherits a number of useful operations from the CopyOperation class to find out about the objects that the user selected for copying, additional objects required my the IClipboardSupport, and the relationships between them. It also has methods for adding elements to be copied
OverridePasteChildOperation: for special pasting behaviour. This class inherits a wealth of useful operations from the PasteChildOperation class to find out about the objects that the user selected for copying, additional objects required my the IClipboardSupport, and the relationships between them. It also has methods do find which elements have failed to paste, to paste additional elements (including handling paste collisions), etc.

See Also:: ClipboardUtil.copyElementsToString(java.util.Collection, java.util.Map, org.eclipse.core.runtime.IProgressMonitor), ClipboardUtil.pasteElementsFromString(java.lang.String, org.eclipse.emf.ecore.EObject, java.util.Map, org.eclipse.core.runtime.IProgressMonitor), ClipboardUtil.createClipboardSupport(org.eclipse.emf.ecore.EClass)