bundles/org.simantics.diagram/src/org/simantics/diagram/handler/CopyStrategy.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.diagram.handler;\r
  13 \r
  14 import org.eclipse.core.runtime.IStatus;\r
  15 \r
  16 /**\r
  17  * An additional interface for {@link CopyPasteStrategy} implementation to\r
  18  * implement. This can be used to control the set of elements allowed to be\r
  19  * copied/cut in the first place.\r
  20  * \r
  21  * @author Tuukka Lehtonen\r
  22  * @see CopyPasteStrategy\r
  23  * @since 1.23\r
  24  */\r
  25 public interface CopyStrategy {\r
  26 \r
  27     /**\r
  28      * @param operation\r
  29      *            the contents of the intended copy that this method is allowed\r
  30      *            to modify freely.\r
  31      * @return status to indicate whether the copy operation can succeed or not.\r
  32      *         An OK status indicates the copy operation is ok to commence. Any\r
  33      *         other status means that the strategy prevented copy the reason\r
  34      *         shown by the status.\r
  35      */\r
  36     IStatus copy(CopyOperation operation);\r
  37 \r
  38 }\r