bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/SelectionFilter.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.browsing.ui;
  13
  14 /**
  15  * A SelectionFilter gives a {@link GraphExplorer} client primitive control over
  16  * what objects the explorer puts into the selections it provides.
  17  *
  18  * <p>
  19  * Normally, a {@link GraphExplorer} selection contains only {@link NodeContext}
  20  * instances which exist separately for each separate visible UI element, like a
  21  * tree node. Presenting an implementation of this interface to an explorer will
  22  * cause the explorer to filter its selected NodeContexts, one by one, through
  23  * this interface.
  24  *
  25  * @author Tuukka Lehtonen
  26  *
  27  * @see GraphExplorer#setSelectionFilter(SelectionFilter)
  28  */
  29 public interface SelectionFilter {
  30
  31     /**
  32      * @param context the context to filter
  33      * @return the filtered object
  34      */
  35     Object filter(NodeContext context);
  36
  37 }