org.eclipse.egit.ui/src/org/eclipse/egit/ui/internal/FilteredCheckboxTree.java

   1 /*******************************************************************************
   2  * Copyright (c) 2010 Red Hat, Inc.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *    Chris Aniszczyk <caniszczyk@gmail.com> - initial implementation
  10  *******************************************************************************/
  11 package org.eclipse.egit.ui.internal;
  12
  13 import org.eclipse.core.runtime.jobs.IJobChangeEvent;
  14 import org.eclipse.core.runtime.jobs.JobChangeAdapter;
  15 import org.eclipse.jface.viewers.TreeViewer;
  16 import org.eclipse.swt.SWT;
  17 import org.eclipse.swt.widgets.Composite;
  18 import org.eclipse.swt.widgets.Text;
  19 import org.eclipse.swt.widgets.Tree;
  20 import org.eclipse.ui.dialogs.FilteredTree;
  21 import org.eclipse.ui.dialogs.PatternFilter;
  22 import org.eclipse.ui.forms.widgets.FormToolkit;
  23 import org.eclipse.ui.progress.WorkbenchJob;
  24
  25 /**
  26  * A FilteredCheckboxTree implementation to be used internally in EGit code.  This tree stores
  27  * all the tree elements internally, and keeps the check state in sync.  This way, even if an
  28  * element is filtered, the caller can get and set the checked state.
  29  */
  30 public class FilteredCheckboxTree extends FilteredTree {
  31
  32         private static final long FILTER_DELAY = 400;
  33
  34         FormToolkit fToolkit;
  35         CachedCheckboxTreeViewer checkboxViewer;
  36
  37         /**
  38          * Constructor that creates a tree with preset style bits and a CachedContainerCheckedTreeViewer for the tree.
  39          *
  40          * @param parent parent composite
  41          * @param toolkit optional toolkit to create UI elements with, required if the tree is being created in a form editor
  42          */
  43         public FilteredCheckboxTree(Composite parent, FormToolkit toolkit) {
  44                 this(parent, toolkit, SWT.NONE);
  45         }
  46
  47         /**
  48          * Constructor that creates a tree with preset style bits and a CachedContainerCheckedTreeViewer for the tree.
  49          *
  50          * @param parent parent composite
  51          * @param toolkit optional toolkit to create UI elements with, required if the tree is being created in a form editor
  52          * @param treeStyle
  53          */
  54         public FilteredCheckboxTree(Composite parent, FormToolkit toolkit, int treeStyle) {
  55                 this(parent, toolkit, treeStyle, new PatternFilter());
  56         }
  57
  58         /**
  59          * Constructor that creates a tree with preset style bits and a CachedContainerCheckedTreeViewer for the tree.
  60          *
  61          * @param parent parent composite
  62          * @param toolkit optional toolkit to create UI elements with, required if the tree is being created in a form editor
  63          * @param treeStyle
  64          * @param filter pattern filter to use in the filter control
  65          */
  66         public FilteredCheckboxTree(Composite parent, FormToolkit toolkit, int treeStyle, PatternFilter filter) {
  67                 super(parent, treeStyle, filter);
  68                 fToolkit = toolkit;
  69                 init(treeStyle, filter);
  70         }
  71
  72         /* (non-Javadoc)
  73          * @see org.eclipse.ui.dialogs.FilteredTree#doCreateTreeViewer(org.eclipse.swt.widgets.Composite, int)
  74          */
  75         protected TreeViewer doCreateTreeViewer(Composite parent, int style) {
  76                 int treeStyle = style | SWT.CHECK | SWT.MULTI | SWT.V_SCROLL | SWT.H_SCROLL | SWT.BORDER;
  77                 Tree tree = null;
  78                 if (fToolkit != null) {
  79                         tree = fToolkit.createTree(parent, treeStyle);
  80                 } else {
  81                         tree = new Tree(parent, treeStyle);
  82                 }
  83
  84                 checkboxViewer = new CachedCheckboxTreeViewer(tree);
  85                 return checkboxViewer;
  86         }
  87
  88         /*
  89          * Overridden to hook a listener on the job and set the deferred content provider
  90          * to synchronous mode before a filter is done.
  91          * @see org.eclipse.ui.dialogs.FilteredTree#doCreateRefreshJob()
  92          */
  93         protected WorkbenchJob doCreateRefreshJob() {
  94                 WorkbenchJob filterJob = super.doCreateRefreshJob();
  95                 filterJob.addJobChangeListener(new JobChangeAdapter() {
  96                         public void done(IJobChangeEvent event) {
  97                                 if (event.getResult().isOK()) {
  98                                         getDisplay().asyncExec(new Runnable() {
  99                                                 public void run() {
 100                                                         if (checkboxViewer.getTree().isDisposed())
 101                                                                 return;
 102                                                         checkboxViewer.restoreLeafCheckState();
 103                                                 }
 104                                         });
 105                                 }
 106                         }
 107                 });
 108                 return filterJob;
 109         }
 110
 111         /* (non-Javadoc)
 112          * @see org.eclipse.ui.dialogs.FilteredTree#doCreateFilterText(org.eclipse.swt.widgets.Composite)
 113          */
 114         protected Text doCreateFilterText(Composite parent) {
 115                 // Overridden so the text gets create using the toolkit if we have one
 116                 Text parentText = super.doCreateFilterText(parent);
 117                 if (fToolkit != null) {
 118                         int style = parentText.getStyle();
 119                         parentText.dispose();
 120                         return fToolkit.createText(parent, null, style);
 121                 }
 122                 return parentText;
 123         }
 124
 125         /**
 126          * @return The checkbox treeviewer
 127          */
 128         public CachedCheckboxTreeViewer getCheckboxTreeViewer() {
 129                 return checkboxViewer;
 130         }
 131
 132         /**
 133          * Overrides org.eclipse.ui.dialogs.FilteredTree#getRefreshJobDelay() in
 134          * Eclipse 3.5 and newer. No effect in eclipse 3.4
 135          *
 136          * @return refresh delay
 137          */
 138         //      TODO: remove this javadoc when support for 3.4 is dropped
 139         protected long getRefreshJobDelay() {
 140                 return FILTER_DELAY;
 141         }
 142 }