Skip to main content
summaryrefslogtreecommitdiffstats
blob: ace9d7be24c7e9862b92685d1a0da167eb1d065a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/*******************************************************************************
 * Copyright (c) 2007 Pascal Essiembre.
 * 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:
 *    Pascal Essiembre - initial API and implementation
 ******************************************************************************/
package org.eclipse.babel.editor.tree.internal;

import java.util.Observable;
import java.util.Observer;

import org.eclipse.babel.core.message.tree.IKeyTreeNode;
import org.eclipse.babel.core.message.tree.TreeType;
import org.eclipse.babel.core.message.tree.internal.AbstractKeyTreeModel;
import org.eclipse.babel.core.message.tree.internal.IKeyTreeModelListener;
import org.eclipse.babel.core.message.tree.internal.KeyTreeNode;
import org.eclipse.babel.editor.IMessagesEditorChangeListener;
import org.eclipse.babel.editor.internal.MessagesEditor;
import org.eclipse.babel.editor.internal.MessagesEditorChangeAdapter;
import org.eclipse.babel.editor.internal.MessagesEditorMarkers;
import org.eclipse.babel.editor.tree.IKeyTreeContributor;
import org.eclipse.babel.editor.tree.actions.AddKeyAction;
import org.eclipse.babel.editor.tree.actions.DeleteKeyAction;
import org.eclipse.babel.editor.tree.actions.RenameKeyAction;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.MouseAdapter;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Tree;

/**
 * @author Pascal Essiembre
 * 
 */
public class KeyTreeContributor implements IKeyTreeContributor {

    private MessagesEditor editor;
    private AbstractKeyTreeModel treeModel;
    private TreeType treeType;

    /**
     * 
     */
    public KeyTreeContributor(final MessagesEditor editor) {
        super();
        this.editor = editor;
        this.treeModel = new AbstractKeyTreeModel(editor.getBundleGroup());
        this.treeType = TreeType.Tree;
    }

    /**
     * 
     */
    public void contribute(final TreeViewer treeViewer) {

        KeyTreeContentProvider contentProvider = new KeyTreeContentProvider(
                treeType);
        treeViewer.setContentProvider(contentProvider);
        ColumnViewerToolTipSupport.enableFor(treeViewer);
        treeViewer.setLabelProvider(new KeyTreeLabelProvider(editor, treeModel,
                contentProvider));
        if (treeViewer.getInput() == null)
            treeViewer.setUseHashlookup(true);

        ViewerFilter onlyUnusedAndMissingKeysFilter = new OnlyUnsuedAndMissingKey();
        ViewerFilter[] filters = { onlyUnusedAndMissingKeysFilter };
        treeViewer.setFilters(filters);

        // IKeyBindingService service = editor.getSite().getKeyBindingService();
        // service.setScopes(new
        // String[]{"org.eclilpse.babel.editor.editor.tree"});

        contributeActions(treeViewer);

        contributeKeySync(treeViewer);

        contributeModelChanges(treeViewer);

        contributeDoubleClick(treeViewer);

        contributeMarkers(treeViewer);

        // Set input model
        treeViewer.setInput(treeModel);
        treeViewer.expandAll();
    }

    private class OnlyUnsuedAndMissingKey extends ViewerFilter implements
            AbstractKeyTreeModel.IKeyTreeNodeLeafFilter {

        /*
         * (non-Javadoc)
         * 
         * @see
         * org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers
         * .Viewer, java.lang.Object, java.lang.Object)
         */
        public boolean select(Viewer viewer, Object parentElement,
                Object element) {
            if (editor.isShowOnlyUnusedAndMissingKeys() == IMessagesEditorChangeListener.SHOW_ALL
                    || !(element instanceof KeyTreeNode)) {
                // no filtering. the element is displayed by default.
                return true;
            }
            if (editor.getI18NPage() != null
                    && editor.getI18NPage().isKeyTreeVisible()) {
                return editor.getKeyTreeModel().isBranchFiltered(this,
                        (KeyTreeNode) element);
            } else {
                return isFilteredLeaf((KeyTreeNode) element);
            }
        }

        /**
         * @param node
         * @return true if this node should be in the filter. Does not navigate
         *         the tree of KeyTreeNode. false unless the node is a missing
         *         or unused key.
         */
        public boolean isFilteredLeaf(IKeyTreeNode node) {
            MessagesEditorMarkers markers = KeyTreeContributor.this.editor
                    .getMarkers();
            String key = node.getMessageKey();
            boolean missingOrUnused = markers.isMissingOrUnusedKey(key);
            if (!missingOrUnused) {
                return false;
            }
            switch (editor.isShowOnlyUnusedAndMissingKeys()) {
            case IMessagesEditorChangeListener.SHOW_ONLY_MISSING_AND_UNUSED:
                return missingOrUnused;
            case IMessagesEditorChangeListener.SHOW_ONLY_MISSING:
                return !markers.isUnusedKey(key, missingOrUnused);
            case IMessagesEditorChangeListener.SHOW_ONLY_UNUSED:
                return markers.isUnusedKey(key, missingOrUnused);
            default:
                return false;
            }
        }

    }

    /**
     * Contributes markers.
     * 
     * @param treeViewer
     *            tree viewer
     */
    private void contributeMarkers(final TreeViewer treeViewer) {
        editor.getMarkers().addObserver(new Observer() {
            public void update(Observable o, Object arg) {
                Display.getDefault().asyncExec(new Runnable() {
                    public void run() {
                        treeViewer.refresh();
                    }
                });
            }
        });
        // editor.addChangeListener(new MessagesEditorChangeAdapter() {
        // public void editorDisposed() {
        // editor.getMarkers().clear();
        // }
        // });

        // final IMarkerListener markerListener = new IMarkerListener() {
        // public void markerAdded(IMarker marker) {
        // PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable () {
        // public void run() {
        // if (!PlatformUI.getWorkbench().getDisplay().isDisposed()) {
        // treeViewer.refresh(true);
        // }
        // }
        // });
        // }
        // public void markerRemoved(IMarker marker) {
        // PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable () {
        // public void run() {
        // if (!PlatformUI.getWorkbench().getDisplay().isDisposed()) {
        // treeViewer.refresh(true);
        // }
        // }
        // });
        // }
        // };
        // editor.getMarkerManager().addMarkerListener(markerListener);
        // editor.addChangeListener(new MessagesEditorChangeAdapter() {
        // public void editorDisposed() {
        // editor.getMarkerManager().removeMarkerListener(markerListener);
        // }
        // });
    }

    /**
     * Contributes double-click support, expanding/collapsing nodes.
     * 
     * @param treeViewer
     *            tree viewer
     */
    private void contributeDoubleClick(final TreeViewer treeViewer) {
        treeViewer.getTree().addMouseListener(new MouseAdapter() {
            public void mouseDoubleClick(MouseEvent event) {
                IStructuredSelection selection = (IStructuredSelection) treeViewer
                        .getSelection();
                Object element = selection.getFirstElement();
                if (treeViewer.isExpandable(element)) {
                    if (treeViewer.getExpandedState(element)) {
                        treeViewer.collapseToLevel(element, 1);
                    } else {
                        treeViewer.expandToLevel(element, 1);
                    }
                }
            }
        });
    }

    /**
     * Contributes key synchronization between editor and tree selected keys.
     * 
     * @param treeViewer
     *            tree viewer
     */
    private void contributeModelChanges(final TreeViewer treeViewer) {
        final IKeyTreeModelListener keyTreeListener = new IKeyTreeModelListener() {
            // TODO be smarter about refreshes.
            public void nodeAdded(KeyTreeNode node) {
                Display.getDefault().asyncExec(new Runnable() {
                    public void run() {
                        treeViewer.refresh(true);
                    }
                });
            };

            // public void nodeChanged(KeyTreeNode node) {
            // treeViewer.refresh(true);
            // };
            public void nodeRemoved(KeyTreeNode node) {
                Display.getDefault().asyncExec(new Runnable() {
                    public void run() {
                        treeViewer.refresh(true);
                    }
                });
            };
        };
        treeModel.addKeyTreeModelListener(keyTreeListener);
        editor.addChangeListener(new MessagesEditorChangeAdapter() {
            public void keyTreeModelChanged(AbstractKeyTreeModel oldModel,
                    AbstractKeyTreeModel newModel) {
                oldModel.removeKeyTreeModelListener(keyTreeListener);
                newModel.addKeyTreeModelListener(keyTreeListener);
                treeViewer.setInput(newModel);
                treeViewer.refresh();
            }

            public void showOnlyUnusedAndMissingChanged(int hideEverythingElse) {
                treeViewer.refresh();
            }
        });
    }

    /**
     * Contributes key synchronization between editor and tree selected keys.
     * 
     * @param treeViewer
     *            tree viewer
     */
    private void contributeKeySync(final TreeViewer treeViewer) {
        // changes in tree selected key update the editor
        treeViewer.getTree().addSelectionListener(new SelectionAdapter() {
            public void widgetSelected(SelectionEvent e) {
                IStructuredSelection selection = (IStructuredSelection) treeViewer
                        .getSelection();
                if (selection != null && selection.getFirstElement() != null) {
                    KeyTreeNode node = (KeyTreeNode) selection
                            .getFirstElement();
                    System.out.println("viewer key/hash:"
                            + node.getMessageKey() + "/" + node.hashCode());
                    editor.setSelectedKey(node.getMessageKey());
                } else {
                    editor.setSelectedKey(null);
                }
            }
        });
        // changes in editor selected key updates the tree
        editor.addChangeListener(new MessagesEditorChangeAdapter() {
            public void selectedKeyChanged(String oldKey, String newKey) {
                ITreeContentProvider provider = (ITreeContentProvider) treeViewer
                        .getContentProvider();
                if (provider != null) { // alst workaround
                    KeyTreeNode node = findKeyTreeNode(provider,
                            provider.getElements(null), newKey);

                    // String[] test = newKey.split("\\.");
                    // treeViewer.setSelection(new StructuredSelection(test),
                    // true);

                    if (node != null) {
                        treeViewer.setSelection(new StructuredSelection(node),
                                true);
                        treeViewer.getTree().showSelection();
                    }
                }
            }
        });
    }

    /**
     * Contributes actions to the tree.
     * 
     * @param treeViewer
     *            tree viewer
     */
    private void contributeActions(final TreeViewer treeViewer) {
        Tree tree = treeViewer.getTree();

        // Add menu
        MenuManager menuManager = new MenuManager();
        Menu menu = menuManager.createContextMenu(tree);

        // Add
        final IAction addAction = new AddKeyAction(editor, treeViewer);
        menuManager.add(addAction);
        // Delete
        final IAction deleteAction = new DeleteKeyAction(editor, treeViewer);
        menuManager.add(deleteAction);
        // Rename
        final IAction renameAction = new RenameKeyAction(editor, treeViewer);
        menuManager.add(renameAction);

        menuManager.update(true);
        tree.setMenu(menu);

        // Bind actions to tree
        tree.addKeyListener(new KeyAdapter() {
            public void keyReleased(KeyEvent event) {
                if (event.character == SWT.DEL) {
                    deleteAction.run();
                } else if (event.keyCode == SWT.F2) {
                    renameAction.run();
                }
            }
        });
    }

    private KeyTreeNode findKeyTreeNode(ITreeContentProvider provider,
            Object[] nodes, String key) {
        for (int i = 0; i < nodes.length; i++) {
            KeyTreeNode node = (KeyTreeNode) nodes[i];
            if (node.getMessageKey().equals(key)) {
                return node;
            }
            node = findKeyTreeNode(provider, provider.getChildren(node), key);
            if (node != null) {
                return node;
            }
        }
        return null;
    }

    public IKeyTreeNode getKeyTreeNode(String key) {
        return getKeyTreeNode(key, null);
    }

    // TODO, think about a hashmap
    private IKeyTreeNode getKeyTreeNode(String key, IKeyTreeNode node) {
        if (node == null) {
            for (IKeyTreeNode ktn : treeModel.getRootNodes()) {
                String id = ktn.getMessageKey();
                if (key.equals(id)) {
                    return ktn;
                } else {
                    getKeyTreeNode(key, ktn);
                }
            }
        } else {
            for (IKeyTreeNode ktn : node.getChildren()) {
                String id = ktn.getMessageKey();
                if (key.equals(id)) {
                    return ktn;
                } else {
                    getKeyTreeNode(key, ktn);
                }
            }
        }
        return null;
    }

    public IKeyTreeNode[] getRootKeyItems() {
        return treeModel.getRootNodes();
    }

}

Back to the top