eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/element/ISelectableElement.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.taxeditor.ui.element;
  12
  13
  14
  15 /**
  16  * Implementors of this interface provide a {@link SelectionArbitrator}.<br>
  17  * The arbitrator allows the element to be selected to show e.g.
  18  * supplemental data.<br>
  19  * An arbitrator can be added like in the following code example:
  20  * <br>
  21  * <br>
  22  * <pre>
  23  * //make element selectable
  24  *  if(cdmFormFactory.getSelectionProvider() != null){
  25  *     selectionArbitrator = cdmFormFactory.createSelectionArbitrator(this);
  26  *  }
  27  *  </pre>
  28  *
  29  * @author n.hoffmann
  30  * @created Mar 5, 2010
  31  * @version 1.0
  32  */
  33 public interface ISelectableElement {
  34
  35         /**
  36          * Returns this elements selection arbitrator
  37          *
  38          * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator} object.
  39          */
  40         public SelectionArbitrator getSelectionArbitrator();
  41 }