blob: 562c0286067615d1a37d6d9db5bd7653f1935919 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2002-2003 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25package javax.swing.plaf.synth;
26
27import java.awt.*;
28import java.util.*;
29import javax.swing.plaf.*;
30import javax.swing.*;
31
32/**
33 * Factory used for obtaining <code>SynthStyle</code>s. Each of the
34 * Synth <code>ComponentUI</code>s will call into the current
35 * <code>SynthStyleFactory</code> to obtain a <code>SynthStyle</code>
36 * for each of the distinct regions they have.
37 * <p>
38 * The following example creates a custom <code>SynthStyleFactory</code>
39 * that returns a different style based on the <code>Region</code>:
40 * <pre>
41 * class MyStyleFactory extends SynthStyleFactory {
42 * public SynthStyle getStyle(JComponent c, Region id) {
43 * if (id == Region.BUTTON) {
44 * return buttonStyle;
45 * }
46 * else if (id == Region.TREE) {
47 * return treeStyle;
48 * }
49 * return defaultStyle;
50 * }
51 * }
52 * SynthLookAndFeel laf = new SynthLookAndFeel();
53 * UIManager.setLookAndFeel(laf);
54 * SynthLookAndFeel.setStyleFactory(new MyStyleFactory());
55 * </pre>
56 *
57 * @see SynthStyleFactory
58 * @see SynthStyle
59 *
60 * @since 1.5
61 * @author Scott Violet
62 */
63public abstract class SynthStyleFactory {
64 /**
65 * Creates a <code>SynthStyleFactory</code>.
66 */
67 public SynthStyleFactory() {
68 }
69
70 /**
71 * Returns the style for the specified Component.
72 *
73 * @param c Component asking for
74 * @param id Region identifier
75 * @return SynthStyle for region.
76 */
77 public abstract SynthStyle getStyle(JComponent c, Region id);
78}