1 /*
2 * Copyright (c) 2003-2008 by Cosylab d. d.
3 *
4 * This file is part of CosyBeans-Common.
5 *
6 * CosyBeans-Common is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * CosyBeans-Common is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with CosyBeans-Common. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 package com.cosylab.gui.components.ledder;
21 import java.awt.Color;
22
23 /**
24 * Interface representing the led model. This interface provides minimum
25 * requirements neccessary to uniquely define the model of leds. In this
26 * definition the model is immutable, although this is not a requirement.
27 * Implementations should provide methods for modifying the contents during
28 * runtime and fire appropriate events.
29 *
30 * @author <a href="mailto:ales.pucelj@cosylab.com">Ales Pucelj</a>
31 * @version $id$
32 */
33 public interface BitDescriptor {
34
35 /**
36 * Returns description for the led at specified index or null if
37 * such led does not exist.
38 *
39 * @param index int
40 * @return String
41 */
42 String getDescription(int index);
43
44 /**
45 * Returns color for the led at specified index or null if
46 * such led does not exist. This is the color that will be displayed when
47 * the led indicates ON state.
48 * @param index int
49 * @return Color
50 */
51 Color getColorWhenOn(int index);
52
53 /**
54 * Returns color for the led at specified index or null if such led does not
55 * exist. This is the color that will be displayed when the led indicates
56 * OFF state.
57 *
58 * @param index int
59 * @return Color
60 */
61 Color getColorWhenOff(int index);
62 }