View Javadoc

1   /**
2    * This program is free software: you can redistribute it and/or modify
3    * it under the terms of the GNU General Public License as published by
4    * the Free Software Foundation, version 3.
5    *
6    * This program is distributed in the hope that it will be useful,
7    * but WITHOUT ANY WARRANTY; without even the implied warranty of
8    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9    * GNU General Public License for more details.
10   *
11   * You should have received a copy of the GNU General Public License
12   * along with this program. If not, see <http://www.gnu.org/licenses/>.
13   */
14  
15  package net.curre.prefcount.gui.theme.skin;
16  
17  import java.awt.*;
18  
19  /**
20   * This is an interface to represent a prefcount skin,
21   * which represents a Substance skin from the
22   * <code>org.jvnet.substance.skin</code> package.
23   * <p/>
24   * Created date: Jun 13, 2007
25   *
26   * @author Yevgeny Nyden
27   */
28  public interface PrefSkin {
29  
30    /**
31     * Returns Substance skin class name if this theme/skin
32     * is a SubstanceLookAndFeel skin.
33     *
34     * @return Substance skin class name.
35     */
36    public String getSubstanceSkinClassName();
37  
38    /**
39     * Returns the skin resource key, which
40     * also the skin's unique identifier.
41     *
42     * @return the skin resource key and it's unique ID.
43     */
44    public String getNameResourceKey();
45  
46    /**
47     * Returns the main background color.
48     *
49     * @return the main background color.
50     */
51    public Color getMainBackgroundColor();
52  
53    /**
54     * Returns the board background paint.
55     *
56     * @return the board background paint.
57     */
58    public Paint getBoardBackgroundPaint();
59  
60    /**
61     * Returns the color for players names.
62     *
63     * @return the player names color.
64     */
65    public Color getPlayerNameColor();
66  
67    /**
68     * Returns the font for players names.
69     *
70     * @return the player names font.
71     */
72    public Font getPlayerNameFont();
73  
74    /**
75     * Returns the stroke for players names.
76     *
77     * @return the player names stroke.
78     */
79    public Stroke getPlayerNameStroke();
80  
81    /**
82     * Returns the color for players scores.
83     *
84     * @return the color for players scores.
85     */
86    public Color getPlayerScoreColor();
87  
88    /**
89     * Returns the font for players scores.
90     *
91     * @return the font for players scores.
92     */
93    public Font getPlayerScoreFont();
94  
95    /**
96     * Returns the stroke for players scores.
97     *
98     * @return the stroke for players scores.
99     */
100   public Stroke getPlayerScoreStroke();
101 
102   /**
103    * Returns the color for player (scores) totals.
104    *
105    * @return the color for player (scores) totals.
106    */
107   public Color getPlayerTotalsColor();
108 
109   /**
110    * Returns the font for player (scores) totals.
111    *
112    * @return the font for player (scores) totals.
113    */
114   public Font getPlayerTotalsFont();
115 
116   /**
117    * Returns the stroke for player (scores) totals.
118    *
119    * @return the stroke for player (scores) totals.
120    */
121   public Stroke getPlayerTotalsStroke();
122 
123   /**
124    * Returns the color for the board lines.
125    *
126    * @return the color for the board lines.
127    */
128   public Color getBoardLineColor();
129 
130   /**
131    * Returns the stroke for the board lines.
132    *
133    * @return the stroke for the board lines.
134    */
135   public Stroke getBoardLineStroke();
136 
137 }