| /********************************************************************** |
| * Copyright (c) 2004, 2005 QNX Software Systems and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * QNX Software Systems - Initial API and implementation |
| ***********************************************************************/ |
| package org.eclipse.debug.internal.ui.views; |
| |
| import java.util.ArrayList; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.eclipse.core.runtime.IPath; |
| import org.eclipse.core.runtime.Path; |
| import org.eclipse.debug.core.DebugException; |
| import org.eclipse.debug.internal.ui.viewers.AsynchronousTreeViewer; |
| import org.eclipse.jface.viewers.TreePath; |
| import org.eclipse.jface.viewers.TreeSelection; |
| import org.eclipse.swt.widgets.TreeItem; |
| |
| /** |
| * The abstract superclass for mementos of the expanded and |
| * selected items in a tree viewer. |
| */ |
| public abstract class AbstractViewerState implements Cloneable { |
| |
| // paths to expanded elements |
| private List fSavedExpansion = null; |
| private IPath[] fSelection; |
| |
| public AbstractViewerState() { |
| } |
| |
| /** |
| * Constructs a memento for the given viewer. |
| */ |
| public AbstractViewerState(AsynchronousTreeViewer viewer) { |
| saveState(viewer); |
| } |
| |
| /** |
| * Saves the current state of the given viewer into |
| * this memento. |
| * |
| * @param viewer viewer of which to save the state |
| */ |
| public void saveState(AsynchronousTreeViewer viewer) { |
| List expanded = new ArrayList(); |
| fSavedExpansion = null; |
| TreeItem[] items = viewer.getTree().getItems(); |
| try { |
| for (int i = 0; i < items.length; i++) { |
| collectExpandedItems(items[i], expanded); |
| } |
| if (expanded.size() > 0) { |
| fSavedExpansion = expanded; |
| } |
| } catch (DebugException e) { |
| fSavedExpansion = null; |
| } |
| TreeItem[] selection = viewer.getTree().getSelection(); |
| fSelection = new IPath[selection.length]; |
| try { |
| for (int i = 0; i < selection.length; i++) { |
| fSelection[i] = encodeElement(selection[i]); |
| if (fSelection[i] == null) { |
| fSelection = null; |
| return; |
| } |
| } |
| } catch (DebugException e) { |
| fSelection = null; |
| } |
| } |
| |
| /** |
| * Collects paths to expanded children of the given element and returns |
| * whether any paths were expanded. |
| * |
| * @param item item to collect expanded paths for |
| * @param expanded list to add to |
| * @return whether any paths were found expanded |
| * @throws DebugException |
| */ |
| protected boolean collectExpandedItems(TreeItem item, List expanded) throws DebugException { |
| if (item.getExpanded()) { |
| boolean childExpanded = false; |
| TreeItem[] items = item.getItems(); |
| for (int i = 0; i < items.length; i++) { |
| childExpanded = collectExpandedItems(items[i], expanded) || childExpanded; |
| } |
| if (!childExpanded) { |
| IPath path = encodeElement(item); |
| expanded.add(path); |
| } |
| } else { |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Constructs a path representing the given tree item. The segments in the |
| * path denote parent items, and the last segment is the name of |
| * the given item. |
| * |
| * @param item tree item to encode |
| * @return path encoding the given item |
| * @throws DebugException if unable to generate a path |
| */ |
| protected abstract IPath encodeElement(TreeItem item) throws DebugException; |
| |
| /** |
| * Restores the state of the given viewer to this memento's |
| * saved state. |
| * |
| * @param viewer viewer to which state is restored |
| */ |
| public void restoreState(AsynchronousTreeViewer viewer) { |
| boolean expansionComplete = true; |
| if (fSavedExpansion != null && fSavedExpansion.size() > 0) { |
| for (int i = 0; i < fSavedExpansion.size(); i++) { |
| IPath path = (IPath) fSavedExpansion.get(i); |
| if (path != null) { |
| try { |
| TreePath treePath = decodePath(path, viewer); |
| if (treePath != null) { |
| viewer.expand(new TreeSelection(new TreePath[] { treePath })); |
| |
| if (treePath.getSegmentCount()-1 != path.segmentCount()) { |
| expansionComplete = false; |
| } |
| } else { |
| expansionComplete =false; |
| } |
| } catch (DebugException e) { |
| } |
| } |
| } |
| if (expansionComplete) { |
| fSavedExpansion = null; |
| } |
| } |
| |
| boolean selectionComplete = true; |
| if (fSelection != null && fSelection.length > 0) { |
| List selection = new ArrayList(fSelection.length); |
| for (int i = 0; i < fSelection.length; i++) { |
| IPath path = fSelection[i]; |
| TreePath obj; |
| try { |
| obj = decodePath(path, viewer); |
| if (obj != null && obj.getSegmentCount()-1 == path.segmentCount()) { |
| selection.add(obj); |
| } else { |
| selectionComplete = false; |
| } |
| } catch (DebugException e) { |
| } |
| } |
| if (selection.size() > 0) { |
| TreePath[] treePaths = (TreePath[]) selection.toArray(new TreePath[0]); |
| viewer.setSelection(new TreeSelection(treePaths)); |
| } |
| if (selectionComplete) { |
| fSelection = null; |
| } |
| } |
| } |
| |
| /** |
| * Returns an element in the given viewer that corresponds to the given |
| * path, or <code>null</code> if none. |
| * |
| * @param path encoded element path |
| * @param viewer viewer to search for the element in |
| * @return element represented by the path, or <code>null</code> if none |
| * @throws DebugException if unable to locate a variable |
| */ |
| protected abstract TreePath decodePath(IPath path, AsynchronousTreeViewer viewer) throws DebugException; |
| |
| /* (non-Javadoc) |
| * @see java.lang.Object#clone() |
| */ |
| public Object clone() { |
| AbstractViewerState clone = null; |
| try { |
| clone = (AbstractViewerState) this.getClass().newInstance(); |
| } catch (InstantiationException e) { |
| return null; |
| } catch (IllegalAccessException e) { |
| return null; |
| } |
| if (fSavedExpansion != null) { |
| clone.fSavedExpansion = new ArrayList(fSavedExpansion.size()); |
| Iterator iterator = fSavedExpansion.iterator(); |
| while (iterator.hasNext()) { |
| IPath path = (IPath) iterator.next(); |
| IPath clonePath = Path.fromPortableString(path.toPortableString()); |
| clone.fSavedExpansion.add(clonePath); |
| } |
| } |
| if (fSelection != null) { |
| clone.fSelection = new IPath[fSelection.length]; |
| for (int i = 0; i < fSelection.length; i++) { |
| clone.fSelection[i] = Path.fromPortableString(fSelection[i].toPortableString()); |
| } |
| } |
| return clone; |
| } |
| } |