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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<TITLE>Elements of the User Interface (CDO Model Repository Documentation)</TITLE>
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Elements of the User Interface (CDO Model Repository Documentation)";
}
}
</SCRIPT>
<NOSCRIPT></NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- <div class="help_breadcrumbs"><a href="../Overview.html" title="CDO Model Repository Documentation">CDO Model Repository Documentation</a> > <a href="index.html" title="Category in CDO Model Repository Documentation">User's Guide</a></div> -->
<table border="0">
<tr>
<td width="100%"><h1>Elements of the User Interface</h1></td>
<td align="right" valign="middle" nowrap><a href="index.html" title="Backward to User's Guide"><img src="../../images/backward.png" border="0"></a> <a href="Doc02_ManagingRepositories.html" title="Forward to Managing Repositories"><img src="../../images/forward.png" border="0"></a></td>
</tr>
</table>
<p class="author">Author: Eike Stepper</p>
<p>
The CDO user interface consists of a number of CDO-specific views, editors, and preference pages,
as well as some integrations with existing Eclipse views. These user interface elements can be added to
and used in any Eclipse perspective, or more comprehensively in the <a href="Doc01_UserInterface.html#Doc_ExplorerPerspective" title="Chapter in CDO Model Repository Documentation">CDO Explorer</a>
perspective.
<p>
The following sections describe the various user interface elements and explain their purpose.
<p>
<b>Table of Contents</b> <p>
<table border="0">
<tr><td>1 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_ExplorerPerspective" title="Chapter in CDO Model Repository Documentation">CDO Explorer Perspective</a></td></tr>
<tr><td>2 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_RepositoriesView" title="Chapter in CDO Model Repository Documentation">CDO Repositories View</a></td></tr>
<tr><td>3 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_AdministrationView" title="Chapter in CDO Model Repository Documentation">CDO Administration View</a></td></tr>
<tr><td>4 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_CollaborationView" title="Chapter in CDO Model Repository Documentation">CDO Collaboration View</a></td></tr>
<tr><td>5 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_WatchListView" title="Chapter in CDO Model Repository Documentation">CDO Watch List View</a></td></tr>
<tr><td>6 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_TimeMachineView" title="Chapter in CDO Model Repository Documentation">CDO Time Machine View</a></td></tr>
<tr><td>7 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_SessionsView" title="Chapter in CDO Model Repository Documentation">CDO Sessions View</a></td></tr>
<tr><td>8 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_ServerBrowser" title="Chapter in CDO Model Repository Documentation">CDO Server Browser</a></td></tr>
<tr><td>9 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_CheckoutWizard" title="Chapter in CDO Model Repository Documentation">CDO Checkout Wizard</a></td></tr>
<tr><td>10 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_ModelEditor" title="Chapter in CDO Model Repository Documentation">CDO Model Editor</a></td></tr>
<tr><td>11 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_ProjectExplorerIntegration" title="Chapter in CDO Model Repository Documentation">Project Explorer Integration</a></td></tr>
<tr><td>12 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_PropertySheetIntegration" title="Chapter in CDO Model Repository Documentation">Property Sheet Integration</a></td></tr>
<tr><td>13 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_HistoryIntegration" title="Chapter in CDO Model Repository Documentation">History Integration</a></td></tr>
<tr><td>14 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_CompareIntegration" title="Chapter in CDO Model Repository Documentation">Compare Integration</a></td></tr>
<tr><td>15 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_FormsIntegration" title="Chapter in CDO Model Repository Documentation">Forms Integration</a></td></tr>
<tr><td>16 </td><td colspan="3"><a href="Doc01_UserInterface.html#Doc_PreferencePages" title="Chapter in CDO Model Repository Documentation">Preference Pages</a></td></tr>
</table>
</p>
<h2><a name="Doc_ExplorerPerspective"></a>1 CDO Explorer Perspective</h2>
<p>
The CDO Explorer perspective is a convenient selection of those views and shortcuts that are most
commonly used when working with CDO. It has the following default layout: <p align="center"><img src="explorer-perspective.png"></p>
<h2><a name="Doc_RepositoriesView"></a>2 CDO Repositories View</h2>
<p>
The CDO Repositories view displays the various repositories and connections that are configured for use in the
current workspace. It allows to create new repositories and connections, rename or delete existing ones,
manage the branches in them, and finally checking out from them: <p align="center"><img src="repositories-view.png"></p>
<p>
In contrast to sessions in the <a href="Doc01_UserInterface.html#Doc_SessionsView" title="Chapter in CDO Model Repository Documentation">CDO Sessions View</a> repositories and connections configured in the
CDO Repositories view are remembered across Eclipse restarts.<p><b>See Also:</b></p>
<ul>
<li><a href="Doc02_ManagingRepositories.html" title="Article in CDO Model Repository Documentation">Managing Repositories</a></li>
<li><a href="Doc04_CheckingOut.html" title="Article in CDO Model Repository Documentation">Checking Out from Repositories</a></li>
</ul>
<h2><a name="Doc_AdministrationView"></a>3 CDO Administration View</h2>
<p>
The CDO Administration view displays configured servers and lists their discovered repositories in real-time.
New servers can be added, existing ones can be removed. New repositories can be created in the servers and existing
ones can be deleted. If a repository supports security, i.e., authentication and authorization, an editor for the
various security concepts, such as users, groups, roles, and permissions can be opened on it:
<p align="center"><img src="administration-view.png"></p>
<h2><a name="Doc_CollaborationView"></a>4 CDO Collaboration View</h2>
<p>
The CDO Collaboration view displays the other users that are connected to the current repository, more
exactly their sessions. When double-clicking a user in this view a dialog pops up asking you for a short message
to send to the selected user. The targeted user needs to be subscribed to receiving messages. This view is a very
simple example of a custom chat protocol on top of the CDO protocol: <p align="center"><img src="collaboration-view.png"></p>
<p>
The details of remote message subscriptions and how to contribute custom message handlers is explained
in <a href="../../javadoc/org/eclipse/emf/cdo/session/remote/CDORemoteSessionManager.html" title="Interface in org.eclipse.emf.cdo.session.remote"><code>CDORemoteSessionManager</code></a>.
<h2><a name="Doc_WatchListView"></a>5 CDO Watch List View</h2>
<p>
The CDO Watch List view is a simple example of <a href="../../javadoc/org/eclipse/emf/cdo/view/CDOView.Options.html" title="Interface in org.eclipse.emf.cdo.view.CDOView"><code>change subscriptions</code></a>. Model objects can be dragged from anywhere
and dropped on the watch list view to create a table entry that shows the latest changes from any user to the
selected model object: <p align="center"><img src="watchlist-view.png"></p>
<h2><a name="Doc_TimeMachineView"></a>6 CDO Time Machine View</h2>
<p>
The CDO Time Machine view offers a slider control that can be used to look at models at different historical times.
The time slider is only enabled when a model or model object in a historical checkout is selected:
<p align="center"><img src="timemachine-view.png"></p>
<p>
The resource tree in the selected historical checkout as well as the contents of all editors opened on this checkout
changes in real-time while the slider control is dragged back and forth in time.<p><b>See Also:</b></p>
<ul>
<li><a href="Doc04_CheckingOut.html#Doc_HistoricalCheckouts" title="Chapter in CDO Model Repository Documentation">Online Historical Checkouts</a></li>
</ul>
<h2><a name="Doc_SessionsView"></a>7 CDO Sessions View</h2>
<p>
The CDO Sessions view provides a rather technical approach to working with the models in repositories and
is mostly superseded now by more convenient functionality of the <a href="Doc01_UserInterface.html#Doc_RepositoriesView" title="Chapter in CDO Model Repository Documentation">CDO Repositories view</a>
and the <a href="Doc01_UserInterface.html#Doc_ProjectExplorerIntegration" title="Chapter in CDO Model Repository Documentation">Project Explorer integration</a>. Nevertheless, it can still be used to
open sessions to remote repositories, open model views and transactions on sessions, browse the resource trees
of repositories, open model editors on selected resources, and more: <p align="center"><img src="sessions-view.png"></p>
<p>
Please note that sessions opened in the CDO Sessions view are <b>not</b> remembered across Eclipse restarts.
<h2><a name="Doc_ServerBrowser"></a>8 CDO Server Browser</h2>
<p>
The CDO Server Browser allows to introspect the internal data of <a href="Doc02_ManagingRepositories.html#Doc_LocalRepositories" title="Chapter in CDO Model Repository Documentation">local repositories</a> or
locally replicated repositories of <a href="Doc04_CheckingOut.html#Doc_OfflineCheckouts" title="Chapter in CDO Model Repository Documentation">offline checkouts</a>
in a web browser: <p align="center"><img src="server-browser.png"></p>
<p>
It is only meant to be used for test and debug purposes.
It is <b>not</b> meant to be a production tool that would scale to arbitrary repository sizes!
<h2><a name="Doc_CheckoutWizard"></a>9 CDO Checkout Wizard</h2>
<p>
CDO provides an Eclipse Import wizard to create checkouts from repositories without opening the
<a href="Doc01_UserInterface.html#Doc_RepositoriesView" title="Chapter in CDO Model Repository Documentation">CDO Repositories View</a>: <p align="center"><img src="import-wizard.png"></p>
<p><b>See Also:</b></p>
<ul>
<li><a href="Doc04_CheckingOut.html" title="Article in CDO Model Repository Documentation">Checking Out from Repositories</a></li>
</ul>
<h2><a name="Doc_ModelEditor"></a>10 CDO Model Editor</h2>
<p>
The CDO model editor is a generic editor for the model resources in a repository. It displays the contents of the resource
in an editable, structured tree and allows to modify the tree structure of the resource via the New Child, New Sibling,
or Delete context menu actions. Model elements can be moved or copied using drag and drop. Their attributes and references
can be edited in the <a href="Doc01_UserInterface.html#Doc_PropertySheetIntegration" title="Chapter in CDO Model Repository Documentation">Properties view</a>.
<p>
The CDO model editor is a generated EMF editor with some additional features such as real-time locking decoration and early conflict
detection: <p align="center"><img src="model-editor.png"></p>
<p>
Whether the CDO model editor actually supports editing the displayed model depends on whether the checkout of the model is
<a href="Doc04_CheckingOut.html#Doc_TransactionalCheckouts" title="Chapter in CDO Model Repository Documentation">transactional</a> or not.
<h2><a name="Doc_ProjectExplorerIntegration"></a>11 Project Explorer Integration</h2>
<p>
As of CDO 4.4 the preferred way to work with models in or from repositories is the Project Explorer integration.
This integration is centered around the concept of a <i>checkout</i>. Checkouts can be created in the <a href="Doc01_UserInterface.html#Doc_RepositoriesView" title="Chapter in CDO Model Repository Documentation">CDO Repositories View</a>
or in the Project Explorer view with the <a href="Doc01_UserInterface.html#Doc_CheckoutWizard" title="Chapter in CDO Model Repository Documentation">CDO Checkout wizard</a>. Once created, checkouts are displayed
in the Project Explorer like workspace projects and decorated with a small blue repository image. In contrast to
workspace projects the displayed checkouts have no physical representation in the workspace.
<p>
The folders, resources, and model elements of the checked-out repository are displayed under the checkout and can be
modified directly via drag and drop to move or copy them, or via double-click to open the <a href="Doc01_UserInterface.html#Doc_ModelEditor" title="Chapter in CDO Model Repository Documentation">CDO model editor</a>
on a resource or an EMF Forms dialog on a model element: <p align="center"><img src="project-explorer.png"></p>
<p>
The context menu offers various functions for checkouts, such as renaming, closing, or deleting them, showing them in
different views, switching them to different branches or branch points, comparing them with different branches or branch points,
and merging from different branches or branch points.
<p>
In contrast to sessions in the <a href="Doc01_UserInterface.html#Doc_SessionsView" title="Chapter in CDO Model Repository Documentation">CDO Sessions View</a> checkouts created in the
Project Explorer view are remembered across Eclipse restarts.<p><b>See Also:</b></p>
<ul>
<li><a href="Doc04_CheckingOut.html" title="Article in CDO Model Repository Documentation">Checking Out from Repositories</a></li>
<li><a href="Doc05_UsingCheckouts.html" title="Article in CDO Model Repository Documentation">Working with Checkouts</a></li>
</ul>
<h2><a name="Doc_PropertySheetIntegration"></a>12 Property Sheet Integration</h2>
<p>
CDO integrates with Eclipse's Properties view and provides various semantic and technical information about the
element selected in the current perspective: <p align="center"><img src="property-sheet.png"></p>
<p>
For model elements selected in editors of <a href="Doc04_CheckingOut.html#Doc_TransactionalCheckouts" title="Chapter in CDO Model Repository Documentation">transactional</a> checkouts the
property sheet integration supports the modification of the element's attribute and reference values.
<h2><a name="Doc_HistoryIntegration"></a>13 History Integration</h2>
<p>
CDO integrates with Eclipse's History view and displays the commit tree of the selected repository, branch, checkout, or
model element: <p align="center"><img src="history.png"></p>
<p>
If the History view does not react to selection changes activate the "Link with Editor and Selection" button
in the History view's toolbar.
<p>
The commit tree is updated in real-time when local transactions are committed but also when other users commit their changes
from other workstations.
<p>
If the repository that the current commit tree is based upon supports branching (see <a href="Doc03_UsingBranches.html" title="Article in CDO Model Repository Documentation">Working with Branches</a>) new branches
can be forked off of the selected commit directly in the History view.
<p>
New checkouts can also be created directly from the selected commit by opening the context menu and selecting the Checkout action
or the Checkout As action. See <a href="Doc01_UserInterface.html#Doc_CheckoutWizard" title="Chapter in CDO Model Repository Documentation">CDO Checkout Wizard</a> or <a href="Doc04_CheckingOut.html" title="Article in CDO Model Repository Documentation">Checking Out from Repositories</a> for details about the checkout process.
<h2><a name="Doc_CompareIntegration"></a>14 Compare Integration</h2>
<p>
CDO integrates with EMF Compare to provide efficient and scalable compare editors. Different branches
or different branch points can be compared with each other: <p align="center"><img src="compare.png"></p>
<p>
CDO also provides efficient and scalable merge editors. Different branches
or different branch points can be merged from each other: <p align="center"><img src="merge.png"></p>
<p>
Comparisons and merges are started either from the <a href="Doc01_UserInterface.html#Doc_HistoryIntegration" title="Chapter in CDO Model Repository Documentation">History view</a>, from the
context menus of <a href="Doc05_UsingCheckouts.html" title="Article in CDO Model Repository Documentation">checkouts</a>, or by dragging and dropping branches, branch points, or checkouts
onto other checkouts in the <a href="Doc01_UserInterface.html#Doc_ProjectExplorerIntegration" title="Chapter in CDO Model Repository Documentation">Project Explorer</a> while pressing the Shift key
(for comparisons) or the Ctrl key (for merges).<p><b>See Also:</b></p>
<ul>
<li><a href="http://www.eclipse.org/emf/compare/documentation/latest/user/user-guide.html" title="Article in CDO Model Repository Documentation">EMF Compare Guide</a></li>
<li><a href="Doc05_UsingCheckouts.html#Doc_ComparingCheckouts" title="Chapter in CDO Model Repository Documentation">Comparing Checkouts</a></li>
<li><a href="Doc08_TechnicalBackground.html#Doc_BackgroundCompare" title="Chapter in CDO Model Repository Documentation">Technical Background of the Compare Integration</a></li>
</ul>
<h2><a name="Doc_FormsIntegration"></a>15 Forms Integration</h2>
<p>
CDO integrates with EMF Forms to provide generic editing dialogs for the model
element that are displayed in the <a href="Doc01_UserInterface.html#Doc_ProjectExplorerIntegration" title="Chapter in CDO Model Repository Documentation">Project Explorer</a>: <p align="center"><img src="object-edit.png"></p>
<p><b>See Also:</b></p>
<ul>
<li><a href="http://www.eclipse.org/ecp/documentation.html" title="Article in CDO Model Repository Documentation">EMF Forms Guide</a></li>
<li><a href="Doc07_UsingModels.html#Doc_EditingModelElements" title="Chapter in CDO Model Repository Documentation">Editing Model Elements in a Dialog</a></li>
</ul>
<h2><a name="Doc_PreferencePages"></a>16 Preference Pages</h2>
<p>
The only setting that can currently be adjusted on the CDO Explorer preference page is the number of minutes
to keep a repository connected after it has been used the last time: <p align="center"><img src="preferences.png"></p>
<p align="right">
<a href="index.html" title="Backward to User's Guide"><img src="../../images/backward.png" border="0"></a> <a href="Doc02_ManagingRepositories.html" title="Forward to Managing Repositories"><img src="../../images/forward.png" border="0"></a></p>
<HR>
<i>Copyright (c) 2011, 2012, 2015 Eike Stepper (Berlin, Germany) and others.</i>
</BODY>
</HTML>
|
