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

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