summaryrefslogtreecommitdiff
path: root/javax/swing/plaf/basic/BasicRootPaneUI.java
blob: 28e3b67c1a5488c23284ab94792e817acedfbc92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/* BasicRootPaneUI.java --
   Copyright (C) 2002, 2004  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing.plaf.basic;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

import javax.swing.JComponent;
import javax.swing.JRootPane;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.RootPaneUI;

public class BasicRootPaneUI extends RootPaneUI
  implements PropertyChangeListener
{
  public static ComponentUI createUI(JComponent x) 
  {
    return new BasicRootPaneUI();
  }

  public void installUI(JComponent c)
  {
    super.installUI(c);
    if (c instanceof JRootPane)
      {
        JRootPane rp = (JRootPane) c;
        installDefaults(rp);
        installComponents(rp);
        installListeners(rp);
        installKeyboardActions(rp);
      }
  }

  /**
   * Installs the look and feel defaults for JRootPane.
   *
   * @param rp the root pane to install the defaults to
   */
  protected void installDefaults(JRootPane rp)
  {
    // TODO: What to do here, if anything? (might be a hook method)
  }

  /**
   * Installs additional look and feel components to the root pane.
   *
   * @param rp the root pane to install the components to
   */
  protected void installComponents(JRootPane rp)
  {
    // All components are initialized in the JRootPane constructor, and since
    // the createXXXPane methods are protected, I see no reasonable way,
    // and no need to initialize them here. This method is here anyway
    // for compatibility and to provide the necessary hooks to subclasses.
  }

  /**
   * Installs any look and feel specific listeners on the root pane.
   *
   * @param rp the root pane to install the listeners to
   */
  protected void installListeners(JRootPane rp)
  {
    rp.addPropertyChangeListener(this);
  }

  /**
   * Installs look and feel keyboard actions on the root pane.
   *
   * @param rp the root pane to install the keyboard actions to
   */
  protected void installKeyboardActions(JRootPane rp)
  {
    // We currently do not install any keyboard actions here.
    // This method is here anyway for compatibility and to provide
    // the necessary hooks to subclasses.
  }

  public void propertyChange(PropertyChangeEvent event)
  {
    // TODO: Implement this properly.
  }

  /**
   * Uninstalls this UI from the root pane. This calls
   * {@link #uninstallDefaults}, {@link #uninstallComponents},
   * {@link #uninstallListeners}, {@link #uninstallKeyboardActions}
   * in this order.
   *
   * @param c the root pane to uninstall the UI from
   */
  public void uninstallUI(JComponent c)
  {
    super.uninstallUI(c);
    if (c instanceof JRootPane)
      {
        JRootPane rp = (JRootPane) c;
        uninstallDefaults(rp);
        uninstallComponents(rp);
        uninstallListeners(rp);
        uninstallKeyboardActions(rp);
      }
  }

  /**
   * Uninstalls the look and feel defaults that have been installed in
   * {@link #installDefaults}.
   *
   * @param rp the root pane to uninstall the defaults from
   */
  protected void uninstallDefaults(JRootPane rp)
  {
    // We do nothing here.
  }

  /**
   * Uninstalls look and feel components from the root pane.
   *
   * @param rp the root pane to uninstall the components from
   */
  protected void uninstallComponents(JRootPane rp)
  {
    // We do nothing here.
  }

  /**
   * Uninstalls any look and feel specific listeners from the root pane.
   *
   * @param rp the root pane to uninstall the listeners from
   */
  protected void uninstallListeners(JRootPane rp)
  {
    rp.removePropertyChangeListener(this);
  }

  /**
   * Uninstalls look and feel keyboard actions from the root pane.
   *
   * @param rp the root pane to uninstall the keyboard actions from
   */
  protected void uninstallKeyboardActions(JRootPane rp)
  {
    // We do nothing here.
  }
}