|
f@0
|
1 /*
|
|
f@0
|
2 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
|
|
f@0
|
3
|
|
f@0
|
4 Copyright (C) 2011 Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
|
|
f@0
|
5
|
|
f@0
|
6 This program is free software: you can redistribute it and/or modify
|
|
f@0
|
7 it under the terms of the GNU General Public License as published by
|
|
f@0
|
8 the Free Software Foundation, either version 3 of the License, or
|
|
f@0
|
9 (at your option) any later version.
|
|
f@0
|
10
|
|
f@0
|
11 This program is distributed in the hope that it will be useful,
|
|
f@0
|
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
f@0
|
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
f@0
|
14 GNU General Public License for more details.
|
|
f@0
|
15
|
|
f@0
|
16 You should have received a copy of the GNU General Public License
|
|
f@0
|
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
f@0
|
18 */
|
|
f@0
|
19 package uk.ac.qmul.eecs.ccmi.diagrammodel;
|
|
f@0
|
20
|
|
f@0
|
21 import java.util.EventObject;
|
|
f@0
|
22
|
|
f@0
|
23 /**
|
|
f@0
|
24 * An event that is triggered in the {@code DiagramModel} when an action
|
|
f@0
|
25 * happens that can involve all the tree nodes of the model's {@code DiagramTree}
|
|
f@0
|
26 * rather than only nodes or edges.
|
|
f@0
|
27 *
|
|
f@0
|
28 * Particularly such actions happens when the user set the notes for a tree node or when
|
|
f@0
|
29 * they bookmark a tree node.
|
|
f@0
|
30 *
|
|
f@0
|
31 */
|
|
f@0
|
32 @SuppressWarnings("serial")
|
|
f@0
|
33 public class DiagramTreeNodeEvent extends EventObject {
|
|
f@0
|
34 /**
|
|
f@0
|
35 * Creates a new event related to a change in a tree node on either notes or bookmarks.
|
|
f@0
|
36 * In order to get the status of the tree node before the change the old value is passed as
|
|
f@0
|
37 * parameter to this constructor.
|
|
f@0
|
38 * For {@code setNotes} this value is the notes before the change. For {@code removeBookmark} it
|
|
f@0
|
39 * will be the bookmark that has just been removed. Finally for {@code putBookmark()} the value is the
|
|
f@0
|
40 * new bookmark.
|
|
f@0
|
41 *
|
|
f@0
|
42 * @see uk.ac.qmul.eecs.ccmi.diagrammodel.TreeModel uk.ac.qmul.eecs.ccmi.diagrammodel.TreeModel
|
|
f@0
|
43 *
|
|
f@0
|
44 * @param treeNode the tree node where the action happened
|
|
f@0
|
45 * @param value the value that the tree node had before this action.
|
|
f@0
|
46 * @param source the source of the action
|
|
f@0
|
47 */
|
|
f@0
|
48 public DiagramTreeNodeEvent(DiagramTreeNode treeNode, String value, Object source){
|
|
f@0
|
49 super(source);
|
|
f@0
|
50 this.treeNode = treeNode;
|
|
f@0
|
51 this.value = value;
|
|
f@0
|
52 }
|
|
f@0
|
53
|
|
f@0
|
54 /**
|
|
f@0
|
55 * Returns the tree node on which a new note has been set or a bookmark has been added/removed.
|
|
f@0
|
56 *
|
|
f@0
|
57 * @return the tree node this event refers to.
|
|
f@0
|
58 */
|
|
f@0
|
59 public DiagramTreeNode getTreeNode() {
|
|
f@0
|
60 return treeNode;
|
|
f@0
|
61 }
|
|
f@0
|
62
|
|
f@0
|
63 /**
|
|
f@0
|
64 * Returns the old value before the action (the old notes for {@code setNotes()},
|
|
f@0
|
65 * and the bookmark key for {@code putBookmark() and removeBookmark()}.
|
|
f@0
|
66 *
|
|
f@0
|
67 * @return the old value before the action
|
|
f@0
|
68 */
|
|
f@0
|
69 public String getValue() {
|
|
f@0
|
70 return value;
|
|
f@0
|
71 }
|
|
f@0
|
72
|
|
f@0
|
73 private DiagramTreeNode treeNode;
|
|
f@0
|
74 private String value;
|
|
f@0
|
75 }
|
