eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/preference/wizard/CheckBoxTreeComposite.java

   1 /**
   2  * Copyright (C) 2018 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 package eu.etaxonomy.taxeditor.preference.wizard;
  10
  11 import org.eclipse.jface.resource.JFaceResources;
  12 import org.eclipse.jface.viewers.AbstractTreeViewer;
  13 import org.eclipse.jface.viewers.CheckboxTreeViewer;
  14 import org.eclipse.jface.viewers.IBaseLabelProvider;
  15 import org.eclipse.jface.viewers.ITreeContentProvider;
  16 import org.eclipse.jface.viewers.ITreeSelection;
  17 import org.eclipse.swt.SWT;
  18 import org.eclipse.swt.events.SelectionEvent;
  19 import org.eclipse.swt.events.SelectionListener;
  20 import org.eclipse.swt.graphics.Font;
  21 import org.eclipse.swt.layout.GridData;
  22 import org.eclipse.swt.layout.GridLayout;
  23 import org.eclipse.swt.widgets.Button;
  24 import org.eclipse.swt.widgets.Composite;
  25 import org.eclipse.swt.widgets.Tree;
  26 import org.eclipse.swt.widgets.TreeItem;
  27 import org.eclipse.swt.widgets.Widget;
  28
  29 import eu.etaxonomy.taxeditor.model.ImageResources;
  30
  31 /**
  32  * @author pplitzner
  33  * @since Oct 26, 2018
  34  *
  35  */
  36 public class CheckBoxTreeComposite extends Composite implements SelectionListener {
  37
  38     private static final Font FONT_DEFAULT = JFaceResources.getFontRegistry().get(JFaceResources.DEFAULT_FONT);
  39     private static final Font FONT_ITALIC = JFaceResources.getFontRegistry().getItalic(JFaceResources.DEFAULT_FONT);
  40     private static final Font FONT_BOLD = JFaceResources.getFontRegistry().getBold(JFaceResources.DEFAULT_FONT);
  41     private CheckboxTreeViewer viewer;
  42     private Button btnCollapse;
  43     private Button btnExpand;
  44     private Button btnSelectAllChildren;
  45
  46     public CheckBoxTreeComposite(Composite parent, ITreeContentProvider contentProvider, IBaseLabelProvider labelProvider, int style) {
  47         super(parent, style);
  48         Composite composite = new Composite(parent, SWT.NULL);
  49         composite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
  50
  51         composite.setLayout(new GridLayout());
  52
  53         Composite toolbar = new Composite(composite, SWT.NONE);
  54         toolbar.setLayoutData(new GridData(SWT.RIGHT, SWT.CENTER, true, false, 1, 1));
  55         toolbar.setLayout(new GridLayout(4, false));
  56
  57         btnCollapse = new Button(toolbar, SWT.NONE);
  58         btnCollapse.addSelectionListener(this);
  59         btnCollapse.setImage(ImageResources.getImage(ImageResources.COLLAPSE_ALL));
  60         btnCollapse.setToolTipText("Collapse All");
  61
  62         btnExpand = new Button(toolbar, SWT.NONE);
  63         btnExpand.addSelectionListener(this);
  64         btnExpand.setImage(ImageResources.getImage(ImageResources.EXPAND));
  65         btnExpand.setToolTipText("Expand Selected Node");
  66
  67         btnSelectAllChildren = new Button(toolbar, SWT.NONE);
  68         btnSelectAllChildren.addSelectionListener(this);
  69         btnSelectAllChildren.setImage(ImageResources.getImage(ImageResources.HIERARCHICAL));
  70         btnSelectAllChildren.setToolTipText("Toggle Selection on all children");
  71
  72         Tree tree = new Tree(composite, SWT.BORDER | SWT.CHECK);
  73         tree.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
  74         tree.addListener(SWT.Selection, event -> {
  75             if (event.detail == SWT.CHECK) {
  76                 TreeItem item = (TreeItem) event.item;
  77                 updateItem(item);
  78             }
  79         });
  80         viewer = new CheckboxTreeViewer(tree);
  81         viewer.setContentProvider(contentProvider);
  82         viewer.setLabelProvider(labelProvider);
  83     }
  84
  85
  86     private void updateItem(TreeItem treeItem){
  87         TreeItem parentItem = treeItem.getParentItem();
  88         if(parentItem!=null){
  89             updateItem(parentItem);
  90         }
  91         updateChildItems(treeItem);
  92     }
  93
  94     private CheckState updateChildItems(TreeItem treeItem){
  95         CheckState checkState = CheckState.NONE;
  96         TreeItem[] children = treeItem.getItems();
  97         if(children.length==0){
  98             return treeItem.getChecked()?CheckState.CHECKED:CheckState.NONE;
  99         }
 100         int checkedCount = 0;
 101         for (TreeItem child : children) {
 102             CheckState childState = updateChildItems(child);
 103             if(childState.equals(CheckState.CHECKED)) {
 104                 checkedCount++;
 105             }
 106             else if(childState.equals(CheckState.GRAYED)){
 107                 treeItem.setFont(FONT_ITALIC);
 108                 return CheckState.GRAYED;
 109             }
 110         }
 111         if(checkedCount==children.length){
 112             //all children are checked
 113             checkState = CheckState.CHECKED;
 114             treeItem.setFont(FONT_BOLD);
 115         }
 116         else if(checkedCount>0){
 117             //some children are checked
 118             checkState = CheckState.GRAYED;
 119             treeItem.setFont(FONT_ITALIC);
 120         }
 121         else{
 122             //no children are checked
 123             treeItem.setFont(FONT_DEFAULT);
 124             if(treeItem.getChecked()){
 125                 //no children but item itself is checked
 126                 checkState = CheckState.CHECKED;
 127             }
 128             else{
 129                 //neither children nor item itself is checked
 130                 checkState = CheckState.NONE;
 131             }
 132         }
 133         return checkState;
 134     }
 135
 136     public CheckboxTreeViewer getViewer() {
 137         return viewer;
 138     }
 139
 140     /**
 141      * Checks the tree items corresponding to the given elements.<br>
 142      * @param elements
 143      */
 144     public void setCheckedElements(Object[] elements) {
 145         viewer.setCheckedElements(elements);
 146         for (Object element: elements) {
 147             viewer.reveal(element);
 148         }
 149         TreeItem[] rootItems = viewer.getTree().getItems();
 150         for (TreeItem rootItem : rootItems) {
 151             updateItem(rootItem);
 152         }
 153     }
 154
 155     @Override
 156     public void widgetSelected(SelectionEvent e) {
 157         ITreeSelection structuredSelection = viewer.getStructuredSelection();
 158         Object firstElement = structuredSelection.getFirstElement();
 159         if(e.widget == btnCollapse){
 160             viewer.collapseAll();
 161         }
 162         else if(e.widget == btnExpand){
 163             viewer.expandToLevel(firstElement, AbstractTreeViewer.ALL_LEVELS);
 164         }
 165         else if(e.widget == btnSelectAllChildren){
 166             Widget item = viewer.testFindItem(firstElement);
 167             boolean checked = false;
 168             Object[] checkedElements = viewer.getCheckedElements();
 169             for (Object checkedElement : checkedElements) {
 170                 if(checkedElement.equals(firstElement)){
 171                     checked = true;
 172                     break;
 173                 }
 174             }
 175             if(item!=null){
 176                 viewer.expandToLevel(firstElement, AbstractTreeViewer.ALL_LEVELS);
 177                 viewer.setSubtreeChecked(firstElement, !checked);
 178                 TreeItem[] rootItems = viewer.getTree().getItems();
 179                 for (TreeItem rootItem : rootItems) {
 180                     updateItem(rootItem);
 181                 }
 182             }
 183         }
 184     }
 185
 186     @Override
 187     public void widgetDefaultSelected(SelectionEvent e) {
 188     }
 189
 190     private enum CheckState{
 191         CHECKED,
 192         GRAYED,
 193         NONE
 194     }
 195
 196 }