← Back to branch summary

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

« back to all changes in this revision

Viewing changes to substance/src/main/java/org/pushingpixels/substance/api/shaper/SubstanceButtonShaper.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:
substance/src/main/java/org/pushingpixels/substance/api/shaper/SubstanceButtonShaper.java
 
1
/*
 
2
 * Copyright (c) 2005-2010 Substance Kirill Grouchnikov. 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 Substance 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.substance.api.shaper;
 
31
 
 
32
import java.awt.*;
 
33
 
 
34
import javax.swing.AbstractButton;
 
35
import javax.swing.border.Border;
 
36
 
 
37
import org.pushingpixels.substance.api.trait.SubstanceTrait;
 
38
 
 
39
/**
 
40
 * Button shaper interface for <b>Substance</b> look and feel. This class is
 
41
 * part of officially supported API.
 
42
 * 
 
43
 * @author Kirill Grouchnikov
 
44
 */
 
45
public interface SubstanceButtonShaper extends SubstanceTrait {
 
46
        /*
 
47
         * (non-Javadoc)
 
48
         * 
 
49
         * @see org.pushingpixels.substance.utils.SubstanceTrait#getDisplayName()
 
50
         */
 
51
        @Override
 
52
    public String getDisplayName();
 
53
 
 
54
        /**
 
55
         * Returns the outline path for the specified button.
 
56
         * 
 
57
         * @param button
 
58
         *            A button.
 
59
         * @param insets
 
60
         *            Button insets.
 
61
         * @param width
 
62
         *            Button width.
 
63
         * @param height
 
64
         *            Button height.
 
65
         * @param isInner
 
66
         *            Indication whether the returned outline is used for the inner
 
67
         *            contour.
 
68
         * @return The outline path for the specified button.
 
69
         */
 
70
        public Shape getButtonOutline(AbstractButton button, Insets insets,
 
71
                        int width, int height, boolean isInner);
 
72
 
 
73
        /**
 
74
         * Returns the border for the specified button.
 
75
         * 
 
76
         * @param button
 
77
         *            A button.
 
78
         * @return The border for the specified button.
 
79
         */
 
80
        public Border getButtonBorder(AbstractButton button);
 
81
 
 
82
        /**
 
83
         * Returns the preferred size for the specified button.
 
84
         * 
 
85
         * @param button
 
86
         *            A button.
 
87
         * @param uiPreferredSize
 
88
         *            Preferred size of the button under the regular conditions
 
89
         *            (plain rectangular button).
 
90
         * @return The preferred size for the specified button.
 
91
         */
 
92
        public Dimension getPreferredSize(AbstractButton button,
 
93
                        Dimension uiPreferredSize);
 
94
 
 
95
        /**
 
96
         * Returns the boolean indication whether the shaper should maintain button
 
97
         * proportions on the resize. This may be relevant for vector-based shapers
 
98
         * (such as animals / other objects).
 
99
         * 
 
100
         * @return <code>true</code> if <code>this</code> shaper should maintain
 
101
         *         button proportions on the resize, <code>false</code> otherwise.
 
102
         * 
 
103
         */
 
104
        public boolean isProportionate();
 
105
}