bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Parent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.g2d.element.handler;
  13
  14 import org.simantics.g2d.element.IElement;
  15 import org.simantics.g2d.element.ElementClass.Single;
  16
  17 /**
  18  * A handler for retrieving the parent element of a of an element. Elements can
  19  * receive a parent when they are grouped.
  20  *
  21  * @author Tuukka Lehtonen
  22  */
  23 @Single
  24 public interface Parent extends ElementHandler {
  25
  26     /**
  27      * @param element the element to check for a parent element
  28      * @return <code>null</code> if the specified element has no parent element.
  29      */
  30     IElement getParent(IElement element);
  31
  32 }