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
|
/*****************************************************************************
* Copyright (c) 2011, 2015 LIFL, CEA LIST, Christian W. Damus, 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:
* LIFL - Initial API and implementation
* Christian W. Damus - bug 469188
*
*****************************************************************************/
package org.eclipse.papyrus.infra.core.sashwindows.di;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Sash Model</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Root node of the model describing the sash windows, panels and pages.
* A SashModel can have several windows containing panels separated by sashes. Such panels can be folders
* containing pages.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.papyrus.infra.core.sashwindows.di.SashModel#getWindows <em>Windows</em>}</li>
* <li>{@link org.eclipse.papyrus.infra.core.sashwindows.di.SashModel#getCurrentSelection <em>Current Selection</em>}</li>
* <li>{@link org.eclipse.papyrus.infra.core.sashwindows.di.SashModel#isRestoreActivePage <em>Restore Active Page</em>}</li>
* </ul>
*
* @see org.eclipse.papyrus.infra.core.sashwindows.di.DiPackage#getSashModel()
* @model
* @generated
*/
public interface SashModel extends EObject {
/**
* Returns the value of the '<em><b>Windows</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.papyrus.infra.core.sashwindows.di.Window}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Windows</em>' containment reference list isn't clear, there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
*
* @return the value of the '<em>Windows</em>' containment reference list.
* @see org.eclipse.papyrus.infra.core.sashwindows.di.DiPackage#getSashModel_Windows()
* @model containment="true" ordered="false"
* @generated
*/
EList<Window> getWindows();
/**
* Returns the value of the '<em><b>Current Selection</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Current Selection</em>' reference isn't clear, there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
*
* @return the value of the '<em>Current Selection</em>' reference.
* @see #setCurrentSelection(TabFolder)
* @see org.eclipse.papyrus.infra.core.sashwindows.di.DiPackage#getSashModel_CurrentSelection()
* @model required="true" ordered="false"
* @generated
*/
TabFolder getCurrentSelection();
/**
* Sets the value of the '{@link org.eclipse.papyrus.infra.core.sashwindows.di.SashModel#getCurrentSelection <em>Current Selection</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @param value
* the new value of the '<em>Current Selection</em>' reference.
* @see #getCurrentSelection()
* @generated
*/
void setCurrentSelection(TabFolder value);
/**
* Returns the value of the '<em><b>Restore Active Page</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Restore Active Page</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
*
* @return the value of the '<em>Restore Active Page</em>' attribute.
* @see #setRestoreActivePage(boolean)
* @see org.eclipse.papyrus.infra.core.sashwindows.di.DiPackage#getSashModel_RestoreActivePage()
* @model dataType="org.eclipse.papyrus.infra.core.sashwindows.di.boolean" required="true" ordered="false"
* @generated
* @since 1.2
*/
boolean isRestoreActivePage();
/**
* Sets the value of the '{@link org.eclipse.papyrus.infra.core.sashwindows.di.SashModel#isRestoreActivePage <em>Restore Active Page</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @param value
* the new value of the '<em>Restore Active Page</em>' attribute.
* @see #isRestoreActivePage()
* @generated
* @since 1.2
*/
void setRestoreActivePage(boolean value);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
@Deprecated
void addPage(Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
void removePage(Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
void removePageAndEmptyFolder(Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model selectionRequired="true" selectionOrdered="false"
* @generated
*/
void setCurrentSelectionSilently(TabFolder selection);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model folderRequired="true" folderOrdered="false" pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
void addPage(TabFolder folder, Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model folderRequired="true" folderOrdered="false" pageRefRequired="true" pageRefOrdered="false"
* @generated
* @since 1.2
*/
void addPage(TabFolder folder, PageRef pageRef);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Lookup the pageRef identified by the pageIdentifier.
* Return the pageRef or null if not found.
* Lookup in the entire SashModel structure.
* <!-- end-model-doc -->
*
* @model required="true" ordered="false" pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
PageRef lookupPage(Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model srcParentFolderRequired="true" srcParentFolderOrdered="false" srcIndexDataType="org.eclipse.papyrus.infra.core.sashwindows.di.int" srcIndexRequired="true" srcIndexOrdered="false" targetParentFolderRequired="true" targetParentFolderOrdered="false"
* targetIndexDataType="org.eclipse.papyrus.infra.core.sashwindows.di.int" targetIndexRequired="true" targetIndexOrdered="false"
* @generated
*/
void movePage(TabFolder srcParentFolder, int srcIndex, TabFolder targetParentFolder, int targetIndex);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model folderToInsertRequired="true" folderToInsertOrdered="false" refFolderRequired="true" refFolderOrdered="false" refFolderSideDataType="org.eclipse.papyrus.infra.core.sashwindows.di.int" refFolderSideRequired="true" refFolderSideOrdered="false"
* @generated
*/
void insertFolder(TabFolder folderToInsert, TabFolder refFolder, int refFolderSide);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model srcParentFolderRequired="true" srcParentFolderOrdered="false" srcIndexDataType="org.eclipse.papyrus.infra.core.sashwindows.di.int" srcIndexRequired="true" srcIndexOrdered="false" targetParentFolderRequired="true" targetParentFolderOrdered="false"
* @generated
*/
void movePage(TabFolder srcParentFolder, int srcIndex, TabFolder targetParentFolder);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
*
* @model folderRequired="true" folderOrdered="false"
* @generated
*/
void removeEmptyFolder(TabFolder folder);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Remove all pages from the model. Only left one empty top level folder.
* <!-- end-model-doc -->
*
* @model
* @generated
*/
void removeAllPages();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Remove pages other than the one specified from the model. Intermediate folders are also removed.
* <!-- end-model-doc -->
*
* @model pageIdentifierDataType="org.eclipse.papyrus.infra.core.sashwindows.di.JavaObject" pageIdentifierRequired="true" pageIdentifierOrdered="false"
* @generated
*/
void removeOtherPages(Object pageIdentifier);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Get the first available window.
* <!-- end-model-doc -->
*
* @model required="true" ordered="false"
* @generated
*/
Window lookupFirstWindow();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Lookup the first available folder.
* <!-- end-model-doc -->
*
* @model required="true" ordered="false"
* @generated
*/
TabFolder lookupFirstFolder();
} // SashModel
|
