Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: bf3df515c5f4a22b3df87c50815aceb0d00962bd (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
/**
 * Copyright (c) 2014 CEA LIST.
 *  
 * 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:
 *  CEA LIST - Initial API and implementation
 */
package org.eclipse.papyrus.dd.dg;

import java.awt.Color;

import org.eclipse.emf.common.util.EList;

/**
 * <!-- begin-user-doc --> A representation of the model object '
 * <em><b>Root Canvas</b></em>'. <!-- end-user-doc -->
 * 
 * <!-- begin-model-doc --> RootCanvas is a kind of canvas that represents the
 * root of containment for all graphical elements that render together. <!--
 * end-model-doc -->
 * 
 * <p>
 * The following features are supported:
 * <ul>
 * <li>{@link org.eclipse.papyrus.dd.dg.RootCanvas#getBackgroundColor <em>
 * Background Color</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.dg.RootCanvas#getDefinitions <em>
 * Definitions</em>}</li>
 * <li>{@link org.eclipse.papyrus.dd.dg.RootCanvas#getStyleSheet <em>Style Sheet
 * </em>}</li>
 * </ul>
 * </p>
 * 
 * @see org.eclipse.papyrus.dd.dg.DGPackage#getRootCanvas()
 * @model
 * @generated
 */
public interface RootCanvas extends Canvas {
	/**
	 * Returns the value of the '<em><b>Background Color</b></em>' attribute.
	 * <!-- begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> An
	 * optional paint for the background of the canvas. <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Background Color</em>' attribute.
	 * @see #isSetBackgroundColor()
	 * @see #unsetBackgroundColor()
	 * @see #setBackgroundColor(Color)
	 * @see org.eclipse.papyrus.dd.dg.DGPackage#getRootCanvas_BackgroundColor()
	 * @model unsettable="true" dataType="org.eclipse.papyrus.dd.dc.Color"
	 *        ordered="false"
	 * @generated
	 */
	Color getBackgroundColor();

	/**
	 * Sets the value of the '
	 * {@link org.eclipse.papyrus.dd.dg.RootCanvas#getBackgroundColor
	 * <em>Background Color</em>}' attribute. <!-- begin-user-doc --> <!--
	 * end-user-doc -->
	 * 
	 * @param value
	 *            the new value of the '<em>Background Color</em>' attribute.
	 * @see #isSetBackgroundColor()
	 * @see #unsetBackgroundColor()
	 * @see #getBackgroundColor()
	 * @generated
	 */
	void setBackgroundColor(Color value);

	/**
	 * Unsets the value of the '
	 * {@link org.eclipse.papyrus.dd.dg.RootCanvas#getBackgroundColor
	 * <em>Background Color</em>}' attribute. <!-- begin-user-doc --> <!--
	 * end-user-doc -->
	 * 
	 * @see #isSetBackgroundColor()
	 * @see #getBackgroundColor()
	 * @see #setBackgroundColor(Color)
	 * @generated
	 */
	void unsetBackgroundColor();

	/**
	 * Returns whether the value of the '
	 * {@link org.eclipse.papyrus.dd.dg.RootCanvas#getBackgroundColor
	 * <em>Background Color</em>}' attribute is set. <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * 
	 * @return whether the value of the '<em>Background Color</em>' attribute is
	 *         set.
	 * @see #unsetBackgroundColor()
	 * @see #getBackgroundColor()
	 * @see #setBackgroundColor(Color)
	 * @generated
	 */
	boolean isSetBackgroundColor();

	/**
	 * Returns the value of the '<em><b>Definitions</b></em>' containment
	 * reference. <!-- begin-user-doc --> <!-- end-user-doc --> <!--
	 * begin-model-doc --> An optional definitions element to hold objects
	 * commonly referenced by the canvas. <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Definitions</em>' containment reference.
	 * @see #setDefinitions(Definitions)
	 * @see org.eclipse.papyrus.dd.dg.DGPackage#getRootCanvas_Definitions()
	 * @model containment="true"
	 * @generated
	 */
	Definitions getDefinitions();

	/**
	 * Sets the value of the '
	 * {@link org.eclipse.papyrus.dd.dg.RootCanvas#getDefinitions
	 * <em>Definitions</em>}' containment reference. <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * 
	 * @param value
	 *            the new value of the '<em>Definitions</em>' containment
	 *            reference.
	 * @see #getDefinitions()
	 * @generated
	 */
	void setDefinitions(Definitions value);

	/**
	 * Returns the value of the '<em><b>Style Sheet</b></em>' reference list.
	 * The list contents are of type
	 * {@link org.eclipse.papyrus.dd.dg.StyleSheet}. <!-- begin-user-doc -->
	 * <!-- end-user-doc --> <!-- begin-model-doc --> A list of external style
	 * sheets that are imported by the canvas. <!-- end-model-doc -->
	 * 
	 * @return the value of the '<em>Style Sheet</em>' reference list.
	 * @see org.eclipse.papyrus.dd.dg.DGPackage#getRootCanvas_StyleSheet()
	 * @model
	 * @generated
	 */
	EList<StyleSheet> getStyleSheet();

} // RootCanvas

Back to the top