~ubuntu-branches/debian/stretch/insubstantial/stretch

« back to all changes in this revision

Viewing changes to laf-plugin/src/main/java/org/pushingpixels/lafplugin/LafComponentPlugin.java

  • Committer: Package Import Robot
  • Author(s): Felix Natter
  • Date: 2016-01-18 20:58:45 UTC
  • Revision ID: package-import@ubuntu.com-20160118205845-crbmrkda61qsi5qa
Tags: upstream-7.3+dfsg2
ImportĀ upstreamĀ versionĀ 7.3+dfsg2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Copyright (c) 2005-2010 Laf-Plugin Kirill Grouchnikov and contributors. All Rights Reserved.
 
3
 *
 
4
 * Redistribution and use in source and binary forms, with or without 
 
5
 * modification, are permitted provided that the following conditions are met:
 
6
 * 
 
7
 *  o Redistributions of source code must retain the above copyright notice, 
 
8
 *    this list of conditions and the following disclaimer. 
 
9
 *     
 
10
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 
11
 *    this list of conditions and the following disclaimer in the documentation 
 
12
 *    and/or other materials provided with the distribution. 
 
13
 *     
 
14
 *  o Neither the name of Laf-Plugin Kirill Grouchnikov nor the names of 
 
15
 *    its contributors may be used to endorse or promote products derived 
 
16
 *    from this software without specific prior written permission. 
 
17
 *     
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 
19
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 
20
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 
21
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 
22
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 
23
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 
24
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 
25
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 
26
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 
27
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 
28
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
29
 */
 
30
package org.pushingpixels.lafplugin;
 
31
 
 
32
import javax.swing.plaf.metal.MetalTheme;
 
33
 
 
34
/**
 
35
 * Basic interface for look-and-feel plugins.
 
36
 * 
 
37
 * @author Kirill Grouchnikov
 
38
 * @author Erik Vickroy
 
39
 * @author Robert Beeger
 
40
 * @author Frederic Lavigne
 
41
 * @author Pattrick Gotthardt
 
42
 */
 
43
public interface LafComponentPlugin extends LafPlugin {
 
44
        /**
 
45
         * XML tag for look-and-feel plugins that specify component UI delegates.
 
46
         */
 
47
        public static final String COMPONENT_TAG_PLUGIN_CLASS = "component-plugin-class";
 
48
 
 
49
        /**
 
50
         * Initializes <code>this</code> plugin.
 
51
         */
 
52
        public void initialize();
 
53
 
 
54
        /**
 
55
         * Unitializes <code>this</code> plugin.
 
56
         */
 
57
        public void uninitialize();
 
58
 
 
59
        /**
 
60
         * Retrieves a collection of custom settings based on the specified theme.
 
61
         * The entries in the array should be pairwise, odd being symbolic name of a
 
62
         * setting, and even being the setting value.
 
63
         * 
 
64
         * @param themeInfo
 
65
         *            Theme information object. Can be {@link MetalTheme}, for
 
66
         *            instance or any other LAF-specific object.
 
67
         * @return Collection of custom settings based on the specified theme. The
 
68
         *         entries in the array should be pairwise, odd being symbolic name
 
69
         *         of a setting, and even being the setting value.
 
70
         */
 
71
        public Object[] getDefaults(Object themeInfo);
 
72
}