bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/CheckedState.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui;\r
  13 \r
  14 import java.util.EnumSet;\r
  15 \r
  16 /**\r
  17  * Describes the checked state of a NodeContext in the browsing framework.\r
  18  * Commonly in a viewer (for example SWT/JFace) viewed items can have have a\r
  19  * check-box attached to them telling, e.g. are they selected or not.\r
  20  * \r
  21  * @author Tuukka Lehtonen\r
  22  * \r
  23  * @see BuiltinKeys#IS_CHECKED\r
  24  */\r
  25 public enum CheckedState {\r
  26 \r
  27     /**\r
  28      * Node is checked.\r
  29      */\r
  30     CHECKED,\r
  31 \r
  32     /**\r
  33      * Node is "grayed", e.g. indirectly selected.\r
  34      */\r
  35     GRAYED,\r
  36 \r
  37     /**\r
  38      * Node is not checked.\r
  39      */\r
  40     NOT_CHECKED\r
  41     ;\r
  42 \r
  43     public static final EnumSet<CheckedState> CHECKED_STATES = EnumSet.of(CHECKED, GRAYED);\r
  44 \r
  45     public static CheckedState of(boolean b) {\r
  46         return b ? CHECKED : NOT_CHECKED;\r
  47     }\r
  48 \r
  49 }\r