Source code: jm/gui/cpn/Images.java
1 /*
2 * Images.java 0.0.1 8th July 2001
3 *
4 * Copyright (C) 2001 Adam Kirby
5 *
6 * <This Java Class is part of the jMusic API version 1.4, February 2003.>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16 *
17 * See the GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 */
23
24 package jm.gui.cpn;
25
26 import java.awt.Image;
27
28 /**
29 * Interface with methods for returning Images representing notes, rests and
30 * other stave elements for use with a CPN {@link Stave}.
31 *
32 * This abstraction is mainly used to allow different implementations from
33 * loading the Images in different ways. For instance, the {@link
34 * ToolkitImages} implementation is suitable for applications, while the {@link
35 * AppletImages} implementation is suitable for use in applets.
36 *
37 * @see Stave
38 * @see ToolkitImages
39 * @see AppletImages
40 *
41 * @author Adam Kirby
42 * @version 0.0.1, 8th July 2001
43 */
44 public interface Images {
45
46 /**
47 * Returns an Image representing a treble clef.
48 */
49 public Image getTrebleClef();
50
51 /**
52 * Returns an Image representing a bass clef.
53 */
54 public Image getBassClef();
55
56 /**
57 * Returns an Image representing a semibreve.
58 */
59 public Image getSemibreve();
60
61 /**
62 * Returns an Image representing a minim with stem raised.
63 */
64 public Image getMinimUp();
65
66 /**
67 * Returns an Image representing a minim with stem lowered.
68 */
69 public Image getMinimDown();
70
71 /**
72 * Returns an Image representing a crotchet with stem raised.
73 */
74 public Image getCrotchetUp();
75
76 /**
77 * Returns an Image representing a crotchet with stem lowered.
78 */
79 public Image getCrotchetDown();
80
81 /**
82 * Returns an Image representing a quaver with stem raised.
83 */
84 public Image getQuaverUp();
85
86 /**
87 * Returns an Image representing a quaver with stem lowered.
88 */
89 public Image getQuaverDown();
90
91 /**
92 * Returns an Image representing a semiquaver with stem raised.
93 */
94 public Image getSemiquaverUp();
95
96 /**
97 * Returns an Image representing a semiquaver with stem lowered.
98 */
99 public Image getSemiquaverDown();
100
101 /**
102 * Returns an Image representing a semibreve rest.
103 */
104 public Image getSemibreveRest();
105
106 /**
107 * Returns an Image representing a minim rest.
108 */
109 public Image getMinimRest();
110
111 /**
112 * Returns an Image representing a crotchet rest.
113 */
114 public Image getCrotchetRest();
115
116 /**
117 * Returns an Image representing a quaver rest.
118 */
119 public Image getQuaverRest();
120
121 /**
122 * Returns an Image representing a semiquaver rest.
123 */
124 public Image getSemiquaverRest();
125
126 /**
127 * Returns an Image representing the dot symbol used to indicate the
128 * duration of the preceeding symbol should be about half as long again.
129 */
130 public Image getDot();
131
132 /**
133 * Returns an Image representing a sharp symbol.
134 */
135 public Image getSharp();
136
137 /**
138 * Returns an Image representing a flat symbol.
139 */
140 public Image getFlat();
141
142 /**
143 * Returns an Image representing a natural symbol.
144 */
145 public Image getNatural();
146
147 /**
148 * Returns an Image representing the digit '1' used in time signatures.
149 */
150 public Image getOne();
151
152 /**
153 * Returns an Image representing the digit '2' used in time signatures.
154 */
155 public Image getTwo();
156
157 /**
158 * Returns an Image representing the digit '3' used in time signatures.
159 */
160 public Image getThree();
161
162 /**
163 * Returns an Image representing the digit '4' used in time signatures.
164 */
165 public Image getFour();
166
167 /**
168 * Returns an Image representing the digit '5' used in time signatures.
169 */
170 public Image getFive();
171
172 /**
173 * Returns an Image representing the digit '6' used in time signatures.
174 */
175 public Image getSix();
176
177 /**
178 * Returns an Image representing the digit '7' used in time signatures.
179 */
180 public Image getSeven();
181
182 /**
183 * Returns an Image representing the digit '8' used in time signatures.
184 */
185 public Image getEight();
186
187 /**
188 * Returns an Image representing the digit '9' used in time signatures.
189 */
190 public Image getNine();
191
192 /**
193 * Returns an Image representing a symbol unique to JMusic which indicates
194 * that the selected symbol/note/rest should be deleted.
195 */
196 public Image getDelete();
197
198 /**
199 * Returns an Image representing a tie used with notes that have stems
200 * lowered.
201 */
202 public Image getTieOver();
203
204 /**
205 * Returns an Image representing a tie used with notes that have stems
206 * raised.
207 */
208 public Image getTieUnder();
209
210 }