← Back to branch summary

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

« back to all changes in this revision

Viewing changes to flamingo/src/main/java/org/pushingpixels/flamingo/api/common/popup/JPopupPanel.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:
flamingo/src/main/java/org/pushingpixels/flamingo/api/common/popup/JPopupPanel.java
 
1
/*
 
2
 * Copyright (c) 2005-2010 Flamingo 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 Flamingo 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.flamingo.api.common.popup;
 
31
 
 
32
import java.awt.Rectangle;
 
33
 
 
34
import javax.swing.JPanel;
 
35
import javax.swing.UIManager;
 
36
 
 
37
import org.pushingpixels.flamingo.internal.ui.common.popup.BasicPopupPanelUI;
 
38
import org.pushingpixels.flamingo.internal.ui.common.popup.PopupPanelUI;
 
39
 
 
40
/**
 
41
 * Base class for popup panels.
 
42
 * 
 
43
 * @author Kirill Grouchnikov
 
44
 * @see PopupPanelManager#addPopup(javax.swing.JComponent, javax.swing.Popup,
 
45
 *      JPopupPanel)
 
46
 */
 
47
public abstract class JPopupPanel extends JPanel {
 
48
        /**
 
49
         * @see #getUIClassID
 
50
         */
 
51
        public static final String uiClassID = "PopupPanelUI";
 
52
 
 
53
        /**
 
54
         * The customizer for this popup panel. Can be <code>null</code>.
 
55
         * 
 
56
         * @see #getCustomizer()
 
57
         * @see #setCustomizer(PopupPanelCustomizer)
 
58
         */
 
59
        protected PopupPanelCustomizer customizer;
 
60
 
 
61
        /**
 
62
         * Allows providing custom application logic for computing the screen bounds
 
63
         * of popup panels before they are shown on the screen.
 
64
         * 
 
65
         * @author Kirill Grouchnikov
 
66
         */
 
67
        public static interface PopupPanelCustomizer {
 
68
                /**
 
69
                 * Returns the requested screen bounds of the associated popup panel.
 
70
                 * 
 
71
                 * @return The requested screen bounds of the associated popup panel.
 
72
                 */
 
73
                public Rectangle getScreenBounds();
 
74
        }
 
75
 
 
76
        /**
 
77
         * Protected to prevent direct instantiation.
 
78
         */
 
79
        protected JPopupPanel() {
 
80
        }
 
81
 
 
82
        /*
 
83
         * (non-Javadoc)
 
84
         * 
 
85
         * @see javax.swing.JPanel#getUI()
 
86
         */
 
87
        @Override
 
88
        public PopupPanelUI getUI() {
 
89
                return (PopupPanelUI) ui;
 
90
        }
 
91
 
 
92
        /**
 
93
         * Sets the look and feel (L&F) object that renders this component.
 
94
         * 
 
95
         * @param ui
 
96
         *            the PopupGalleryUI L&F object
 
97
         */
 
98
        protected void setUI(PopupPanelUI ui) {
 
99
                super.setUI(ui);
 
100
        }
 
101
 
 
102
        /*
 
103
         * (non-Javadoc)
 
104
         * 
 
105
         * @see javax.swing.JPanel#getUIClassID()
 
106
         */
 
107
        @Override
 
108
        public String getUIClassID() {
 
109
                return uiClassID;
 
110
        }
 
111
 
 
112
        /*
 
113
         * (non-Javadoc)
 
114
         * 
 
115
         * @see javax.swing.JPanel#updateUI()
 
116
         */
 
117
        @Override
 
118
        public void updateUI() {
 
119
                if (UIManager.get(getUIClassID()) != null) {
 
120
                        setUI((PopupPanelUI) UIManager.getUI(this));
 
121
                } else {
 
122
                        setUI(BasicPopupPanelUI.createUI(this));
 
123
                }
 
124
        }
 
125
 
 
126
        /**
 
127
         * Sets the customizer for this popup panel.
 
128
         * 
 
129
         * @param customizer
 
130
         *            The customizer for this popup panel.
 
131
         * @see #getCustomizer()
 
132
         */
 
133
        public void setCustomizer(PopupPanelCustomizer customizer) {
 
134
                this.customizer = customizer;
 
135
        }
 
136
 
 
137
        /**
 
138
         * Returns the customizer of this popup panel. Can return <code>null</code>.
 
139
         * 
 
140
         * @return The customizer of this popup panel.
 
141
         * @see #setCustomizer(PopupPanelCustomizer)
 
142
         */
 
143
        public PopupPanelCustomizer getCustomizer() {
 
144
                return this.customizer;
 
145
        }
 
146
}