Skip to content

Commit

Permalink
Refactor TreeStateHelper part 2
Browse files Browse the repository at this point in the history 
- Store the root expanded tree elements when the DrillDownAdapter sets the tree model input

- When we save the tree state and we have drilled into the DrillDownAdapter we can save these root elements
  • Loading branch information
@Phillipus
Phillipus committed Jan 24, 2025
1 parent bd8b535 commit 2bf6663
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 78 deletions.
11 changes: 0 additions & 11 deletions com.archimatetool.editor/src/com/archimatetool/editor/views/tree/TreeModelView.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,6 @@ public void doCreatePartControl(Composite parent) {
// Drill down
fDrillDownAdapter = new DrillDownAdapter(fTreeViewer);

// Set drill down to home when disposing parent (not when the tree is disposed as the content provider is null at that point)
parent.addDisposeListener(e -> {
setDrillDownHome();
});

// Listen to Double-click and press Return Action
fTreeViewer.addDoubleClickListener(new IDoubleClickListener() {
@Override
Expand Down Expand Up @@ -214,12 +209,6 @@ public void init(IViewSite site, IMemento memento) throws PartInitException {

@Override
public void saveState(IMemento memento) {
// saveState() is called periodically by Eclipse when auto-saving the workbench so only reset the drill-down when closing the Workbench.
// This period is set in org.eclipse.ui.internal.IPreferenceConstants#WORKBENCH_SAVE_INTERVAL and the default is 5 minutes.
if(PlatformUI.getWorkbench().isClosing()) {
setDrillDownHome();
}

// Save expanded tree state
TreeStateHelper.INSTANCE.saveStateToMemento(fTreeViewer, memento);
}
Expand Down
23 changes: 23 additions & 0 deletions com.archimatetool.editor/src/com/archimatetool/editor/views/tree/TreeModelViewer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ public class TreeModelViewer extends TreeViewer {
*/
private SearchFilter searchFilter;

/**
* Last root expanded tree elements, saved when DrillDownAdapter is used.
*/
private Object[] lastRootExpandedTreeElements;

/**
* Listener for theme font change
*/
Expand Down Expand Up @@ -197,6 +202,7 @@ public boolean canModify(Object element, String property) {

viewpointFilterProvider = null;
searchFilter = null;
lastRootExpandedTreeElements = null;
});
}

Expand Down Expand Up @@ -371,6 +377,15 @@ private String getAncestorFolderRenderText(IArchimateModelObject object) {
return null;
}

/**
* Get the last root expanded elements in case the DrillDownAdapter is active.
* Note that some of these elements might have been deleted when the tree was drilled into.
* Returns null if the DrillDownAdapter is at "home".
*/
Object[] getLastRootVisibleExpandedElements() {
return lastRootExpandedTreeElements;
}

// ========================= Model Providers =====================================

/**
Expand All @@ -380,6 +395,14 @@ private class ModelTreeViewerContentProvider implements ITreeContentProvider {

@Override
public void inputChanged(Viewer v, Object oldInput, Object newInput) {
// The DrillDownAdapter sets the new input when calling DrillDownAdapter#goInto().
// We save the current expanded elements in the root state so we can persist these when we save the expanded tree state
if(oldInput == IEditorModelManager.INSTANCE) { // Drilldown has moved out of "Home"
lastRootExpandedTreeElements = getVisibleExpandedElements();
}
else if(newInput == IEditorModelManager.INSTANCE) { // Drilldown is "Home"
lastRootExpandedTreeElements = null;
}
}

@Override
Expand Down
116 changes: 49 additions & 67 deletions com.archimatetool.editor/src/com/archimatetool/editor/views/tree/TreeStateHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,11 @@
package com.archimatetool.editor.views.tree;

import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.ui.IMemento;

import com.archimatetool.editor.model.IEditorModelManager;
Expand Down Expand Up @@ -41,93 +38,78 @@ public class TreeStateHelper {
private static final String MEMENTO_FILE = "file";
private static final String MEMENTO_ELEMENTS = "elements";

// Expanded tree elements
private List<Object> expandedElements;

// State has been restored from memento the first time the Tree is created
private boolean restoredFromMemento;
private IMemento memento;

private TreeStateHelper() {}

/**
* Set the Memento when the tree is first created.
* We store expanded elements now, as the tree has not yet been created.
* We will use the expanded elements later in restoreExpandedTreeElements.
* This is called from {@link TreeModelView#init(org.eclipse.ui.IViewSite, IMemento)}, but we only want to do this once.
* We will restore any expanded elements later in restoreExpandedTreeElements.
* This is called from {@link TreeModelView#init(org.eclipse.ui.IViewSite, IMemento)}.
*/
void setMemento(IMemento memento) {
if(restoredFromMemento || memento == null) {
return;
}

restoredFromMemento = true;

IMemento expandedMem = memento.getChild(MEMENTO_EXPANDED);
if(expandedMem != null) {
expandedElements = new ArrayList<>();

try {
for(IMemento elementMem : expandedMem.getChildren(MEMENTO_MODEL)) {
String filePath = elementMem.getString(MEMENTO_FILE);
String elements = elementMem.getString(MEMENTO_ELEMENTS);
if(filePath != null && elements != null) {
File file = new File(filePath);
for(IArchimateModel model : IEditorModelManager.INSTANCE.getModels()) {
// Get model from file
if(file.equals(model.getFile())) {
// Get object ID map
Map<String, EObject> objectMap = ArchimateModelUtils.getObjectIDMap(model);
// Get objects from IDs
for(String id : elements.split(ELEMENT_SEP_CHAR)) {
EObject object = objectMap.get(id);
if(object != null) {
expandedElements.add(object);
}
}
break;
}
}
}
}
}
// We don't want to fail at this point
catch(Exception ex) {
Logger.logError("Error restoring tree state", ex);
}
}
this.memento = memento;
}

/**
* Restore expanded elements on TreeView part creation.
* This is called from {@link TreeModelView#doCreatePartControl(org.eclipse.swt.widgets.Composite)
*/
void restoreExpandedTreeElements(TreeViewer viewer) {
// Store expanded tree elements if the TreeViewer is closed so they can be restored when it's re-opened
// We could restore from the memento but this is more efficient and the drill-down is reset when closing the Tree.
viewer.getTree().addDisposeListener(e -> {
expandedElements = new ArrayList<>();
for(Object element : viewer.getVisibleExpandedElements()) {
expandedElements.add(element);
}
});

if(expandedElements != null) {
for(Object element : expandedElements) {
viewer.expandToLevel(element, 1);
void restoreExpandedTreeElements(TreeModelViewer viewer) {
if(memento != null) {
IMemento expandedMem = memento.getChild(MEMENTO_EXPANDED);
if(expandedMem != null) {
try {
for(IMemento elementMem : expandedMem.getChildren(MEMENTO_MODEL)) {
String filePath = elementMem.getString(MEMENTO_FILE);
String elements = elementMem.getString(MEMENTO_ELEMENTS);
if(filePath != null && elements != null) {
File file = new File(filePath);
for(IArchimateModel model : IEditorModelManager.INSTANCE.getModels()) {
// Get model from file
if(file.equals(model.getFile())) {
// Get object ID map
Map<String, EObject> objectMap = ArchimateModelUtils.getObjectIDMap(model);
// Get objects from IDs
for(String id : elements.split(ELEMENT_SEP_CHAR)) {
EObject object = objectMap.get(id);
if(object != null) {
viewer.expandToLevel(object, 1);
}
}
break;
}
}
}
}
}
// We don't want to fail at this point
catch(Exception ex) {
Logger.logError("Error restoring tree state", ex);
}
}
expandedElements = null;

memento = null;
}
}

/**
* Save expanded state of tree elements to a memento.
* This is called from {@link TreeModelView#saveState(IMemento)}
*/
void saveStateToMemento(TreeViewer viewer, IMemento memento) {
void saveStateToMemento(TreeModelViewer viewer, IMemento memento) {
Map<File, String> map = new HashMap<>();

for(Object object : viewer.getVisibleExpandedElements()) {
if(object instanceof IArchimateModelObject modelObject) {
// Get expanded elements from either:
// (1) last saved expanded elements when drilldown was applied or
// (2) current expanded elements if not in drilldown
Object[] elements = viewer.getLastRootVisibleExpandedElements();
if(elements == null) {
elements = viewer.getVisibleExpandedElements();
}

for(Object object : elements) {
if(object instanceof IArchimateModelObject modelObject && modelObject.getArchimateModel() != null) { // Check it wasn't deleted
// Only store if model has been saved to file
File file = modelObject.getArchimateModel().getFile();
if(file != null) {
Expand Down

0 comments on commit 2bf6663

Please sign in to comment.