Package: VElement

VElement

Coverage

1: /**
2: * Copyright (c) 2011-2013 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Eugen Neufeld - initial API and implementation
13: */
14: package org.eclipse.emf.ecp.view.spi.model;
15:
16: import org.eclipse.emf.common.util.EList;
17: import org.eclipse.emf.ecore.EObject;
18:
19: /**
20: * <!-- begin-user-doc -->
21: * A representation of the model object '<em><b>Renderable</b></em>'.
22: *
23: * @since 1.2
24: * @noimplement This interface is not intended to be implemented by clients.
25: * <!-- end-user-doc -->
26: *
27: * <p>
28: * The following features are supported:
29: * </p>
30: * <ul>
31: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#getName <em>Name</em>}</li>
32: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#getLabel <em>Label</em>}</li>
33: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#isVisible <em>Visible</em>}</li>
34: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#isEnabled <em>Enabled</em>}</li>
35: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#isReadonly <em>Readonly</em>}</li>
36: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#getDiagnostic <em>Diagnostic</em>}</li>
37: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#getAttachments <em>Attachments</em>}</li>
38: * <li>{@link org.eclipse.emf.ecp.view.spi.model.VElement#getUuid <em>Uuid</em>}</li>
39: * </ul>
40: *
41: * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement()
42: * @model abstract="true"
43: * @generated
44: */
45: public interface VElement extends EObject {
46:
47:         /**
48:          * Returns the value of the '<em><b>Name</b></em>' attribute.
49:          * <!-- begin-user-doc -->
50:          * <p>
51:          * If the meaning of the '<em>Name</em>' attribute isn't clear, there really should be more of a description here...
52:          * </p>
53:          * <!-- end-user-doc -->
54:          *
55:          * @return the value of the '<em>Name</em>' attribute.
56:          * @see #setName(String)
57:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Name()
58:          * @model
59:          * @generated
60:          */
61:         String getName();
62:
63:         /**
64:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#getName <em>Name</em>}' attribute.
65:          * <!-- begin-user-doc -->
66:          * <!-- end-user-doc -->
67:          *
68:          * @param value the new value of the '<em>Name</em>' attribute.
69:          * @see #getName()
70:          * @generated
71:          */
72:         void setName(String value);
73:
74:         /**
75:          * Returns the value of the '<em><b>Label</b></em>' attribute.
76:          * <!-- begin-user-doc -->
77:          * <p>
78:          * If the meaning of the '<em>Label</em>' attribute isn't clear, there really should be more of a description
79:          * here...
80:          * </p>
81:          *
82:          * @since 1.6
83:          * <!-- end-user-doc -->
84:          * @return the value of the '<em>Label</em>' attribute.
85:          * @see #setLabel(String)
86:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Label()
87:          * @model transient="true"
88:          * @generated
89:          */
90:         String getLabel();
91:
92:         /**
93:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#getLabel <em>Label</em>}' attribute.
94:          * <!-- begin-user-doc -->
95:          *
96:          * @since 1.6
97:          * <!-- end-user-doc -->
98:          * @param value the new value of the '<em>Label</em>' attribute.
99:          * @see #getLabel()
100:          * @generated
101:          */
102:         void setLabel(String value);
103:
104:         /**
105:          * Returns the value of the '<em><b>Visible</b></em>' attribute.
106:          * The default value is <code>"true"</code>.
107:          * <!-- begin-user-doc -->
108:          * <p>
109:          * If the meaning of the '<em>Visible</em>' attribute isn't clear, there really should be more of a description
110:          * here...
111:          * </p>
112:          * <!-- end-user-doc -->
113:          *
114:          * @return the value of the '<em>Visible</em>' attribute.
115:          * @see #setVisible(boolean)
116:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Visible()
117:          * @model default="true" transient="true"
118:          * @generated
119:          */
120:         boolean isVisible();
121:
122:         /**
123:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#isVisible <em>Visible</em>}' attribute.
124:          * <!-- begin-user-doc -->
125:          * <!-- end-user-doc -->
126:          *
127:          * @param value the new value of the '<em>Visible</em>' attribute.
128:          * @see #isVisible()
129:          * @generated
130:          */
131:         void setVisible(boolean value);
132:
133:         /**
134:          * Returns the value of the '<em><b>Enabled</b></em>' attribute.
135:          * The default value is <code>"true"</code>.
136:          * <!-- begin-user-doc -->
137:          * <p>
138:          * If the meaning of the '<em>Enabled</em>' attribute isn't clear, there really should be more of a description
139:          * here...
140:          * </p>
141:          * <!-- end-user-doc -->
142:          *
143:          * @return the value of the '<em>Enabled</em>' attribute.
144:          * @see #setEnabled(boolean)
145:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Enabled()
146:          * @model default="true" transient="true"
147:          * @generated
148:          */
149:         boolean isEnabled();
150:
151:         /**
152:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#isEnabled <em>Enabled</em>}' attribute.
153:          * <!-- begin-user-doc -->
154:          * <!-- end-user-doc -->
155:          *
156:          * @param value the new value of the '<em>Enabled</em>' attribute.
157:          * @see #isEnabled()
158:          * @generated
159:          */
160:         void setEnabled(boolean value);
161:
162:         /**
163:          * Returns the value of the '<em><b>Readonly</b></em>' attribute.
164:          * The default value is <code>"false"</code>.
165:          * <!-- begin-user-doc -->
166:          * <p>
167:          * If the meaning of the '<em>Readonly</em>' attribute isn't clear, there really should be more of a description
168:          * here...
169:          * </p>
170:          * <!-- end-user-doc -->
171:          *
172:          * @return the value of the '<em>Readonly</em>' attribute.
173:          * @see #setReadonly(boolean)
174:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Readonly()
175:          * @model default="false"
176:          * @generated
177:          */
178:         boolean isReadonly();
179:
180:         /**
181:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#isReadonly <em>Readonly</em>}'
182:          * attribute.
183:          * <!-- begin-user-doc -->
184:          * <!-- end-user-doc -->
185:          *
186:          * @param value the new value of the '<em>Readonly</em>' attribute.
187:          * @see #isReadonly()
188:          * @generated
189:          */
190:         void setReadonly(boolean value);
191:
192:         /**
193:          * Returns the value of the '<em><b>Diagnostic</b></em>' containment reference.
194:          * <!-- begin-user-doc -->
195:          * <p>
196:          * If the meaning of the '<em>Diagnostic</em>' containment reference isn't clear, there really should be more of a
197:          * description here...
198:          * </p>
199:          * <!-- end-user-doc -->
200:          *
201:          * @return the value of the '<em>Diagnostic</em>' containment reference.
202:          * @see #setDiagnostic(VDiagnostic)
203:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Diagnostic()
204:          * @model containment="true" transient="true"
205:          * @generated
206:          */
207:         VDiagnostic getDiagnostic();
208:
209:         /**
210:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#getDiagnostic <em>Diagnostic</em>}'
211:          * containment reference.
212:          * <!-- begin-user-doc -->
213:          * <!-- end-user-doc -->
214:          *
215:          * @param value the new value of the '<em>Diagnostic</em>' containment reference.
216:          * @see #getDiagnostic()
217:          * @generated
218:          */
219:         void setDiagnostic(VDiagnostic value);
220:
221:         /**
222:          * Returns the value of the '<em><b>Attachments</b></em>' containment reference list.
223:          * The list contents are of type {@link org.eclipse.emf.ecp.view.spi.model.VAttachment}.
224:          * <!-- begin-user-doc -->
225:          * <p>
226:          * If the meaning of the '<em>Attachments</em>' containment reference list isn't clear, there really should be more
227:          * of a description here...
228:          * </p>
229:          * <!-- end-user-doc -->
230:          *
231:          * @return the value of the '<em>Attachments</em>' containment reference list.
232:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Attachments()
233:          * @model containment="true"
234:          * @generated
235:          */
236:         EList<VAttachment> getAttachments();
237:
238:         /**
239:          * Returns the value of the '<em><b>Uuid</b></em>' attribute.
240:          * <!-- begin-user-doc -->
241:          * <p>
242:          * If the meaning of the '<em>Uuid</em>' attribute isn't clear,
243:          * there really should be more of a description here...
244:          * </p>
245:          *
246:          * @since 1.9
247:          * <!-- end-user-doc -->
248:          * @return the value of the '<em>Uuid</em>' attribute.
249:          * @see #setUuid(String)
250:          * @see org.eclipse.emf.ecp.view.spi.model.VViewPackage#getElement_Uuid()
251:          * @model transient="true"
252:          * @generated
253:          */
254:         String getUuid();
255:
256:         /**
257:          * Sets the value of the '{@link org.eclipse.emf.ecp.view.spi.model.VElement#getUuid <em>Uuid</em>}' attribute.
258:          * <!-- begin-user-doc -->
259:          *
260:          * @since 1.9
261:          * <!-- end-user-doc -->
262:          * @param value the new value of the '<em>Uuid</em>' attribute.
263:          * @see #getUuid()
264:          * @generated
265:          */
266:         void setUuid(String value);
267:
268:         /**
269:          * Returns true if this element and all parent elements are visible.
270:          *
271:          * @since 1.12
272:          * @return true if this element and all parent elements are visible
273:          */
274:         boolean isEffectivelyVisible();
275:
276:         /**
277:          * Returns true if this element and all parent elements are enabled.
278:          *
279:          * @since 1.12
280:          * @return true if this element and all parent elements are enabled
281:          */
282:         boolean isEffectivelyEnabled();
283:
284:         /**
285:          * Returns true if this element or any parent element is readonly.
286:          *
287:          * @since 1.12
288:          * @return true if this element or any parent element is readonly
289:          */
290:         boolean isEffectivelyReadonly();
291: } // Renderable