bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/CheckedState.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 import java.util.EnumSet;
  15
  16 /**
  17  * Describes the checked state of a NodeContext in the browsing framework.
  18  * Commonly in a viewer (for example SWT/JFace) viewed items can have have a
  19  * check-box attached to them telling, e.g. are they selected or not.
  20  *
  21  * @author Tuukka Lehtonen
  22  *
  23  * @see BuiltinKeys#IS_CHECKED
  24  */
  25 public enum CheckedState {
  26
  27     /**
  28      * Node is checked.
  29      */
  30     CHECKED,
  31
  32     /**
  33      * Node is "grayed", e.g. indirectly selected.
  34      */
  35     GRAYED,
  36
  37     /**
  38      * Node is not checked.
  39      */
  40     NOT_CHECKED
  41     ;
  42
  43     public static final EnumSet<CheckedState> CHECKED_STATES = EnumSet.of(CHECKED, GRAYED);
  44
  45     public static CheckedState of(boolean b) {
  46         return b ? CHECKED : NOT_CHECKED;
  47     }
  48
  49 }