jdk/src/share/classes/javax/swing/JScrollPane.java
author malenkov
Wed, 30 Apr 2014 19:28:05 +0400
changeset 24544 c0133e7c7162
parent 22574 7f8ce0c8c20a
child 25201 4adc75e0c4e5
permissions -rw-r--r--
8041917: unexcepted behavior of LineBorder while using Boolean variable true Reviewed-by: alexsch, serb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 21982
diff changeset
     2
 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4261
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4261
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4261
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4261
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4261
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.swing;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.swing.plaf.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import javax.swing.border.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import javax.swing.event.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import javax.accessibility.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
import java.awt.Component;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
import java.awt.ComponentOrientation;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
import java.awt.Rectangle;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
import java.awt.Insets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
import java.awt.LayoutManager;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
import java.awt.Point;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
import java.io.ObjectOutputStream;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
import java.io.IOException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
466
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
    43
import java.beans.PropertyChangeEvent;
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
    44
import java.beans.PropertyChangeListener;
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
    45
import java.beans.Transient;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * Provides a scrollable view of a lightweight component.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * A <code>JScrollPane</code> manages a viewport, optional
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * vertical and horizontal scroll bars, and optional row and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * column heading viewports.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * You can find task-oriented documentation of <code>JScrollPane</code> in
20455
f6f9a0c2796b 8020688: Broken links in documentation at http://docs.oracle.com/javase/6/docs/api/index.
mcherkas
parents: 20451
diff changeset
    53
 *  <a href="http://docs.oracle.com/javase/tutorial/uiswing/components/scrollpane.html">How to Use Scroll Panes</a>,
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * a section in <em>The Java Tutorial</em>.  Note that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * <code>JScrollPane</code> does not support heavyweight components.
21982
fd6e5fe509df 8029264: [doclint] more doclint and tidy cleanup
yan
parents: 20458
diff changeset
    56
 *
20451
4cedf4e1560a 8025409: Fix javadoc comments errors and warning reported by doclint report
cl
parents: 20157
diff changeset
    57
 * <TABLE STYLE="FLOAT:RIGHT" BORDER="0" SUMMARY="layout">
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 *    <TR>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 *    <TD ALIGN="CENTER">
20451
4cedf4e1560a 8025409: Fix javadoc comments errors and warning reported by doclint report
cl
parents: 20157
diff changeset
    60
 *      <P STYLE="TEXT-ALIGN:CENTER"><IMG SRC="doc-files/JScrollPane-1.gif"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 *      alt="The following text describes this image."
20451
4cedf4e1560a 8025409: Fix javadoc comments errors and warning reported by doclint report
cl
parents: 20157
diff changeset
    62
 *      WIDTH="256" HEIGHT="248" STYLE="FLOAT:BOTTOM; BORDER:0px">
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 *    </TD>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 *    </TR>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * </TABLE>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * The <code>JViewport</code> provides a window,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 * or &quot;viewport&quot; onto a data
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 * source -- for example, a text file. That data source is the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 * &quot;scrollable client&quot; (aka data model) displayed by the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
 * <code>JViewport</code> view.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
 * A <code>JScrollPane</code> basically consists of <code>JScrollBar</code>s,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
 * a <code>JViewport</code>, and the wiring between them,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
 * as shown in the diagram at right.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
 * In addition to the scroll bars and viewport,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
 * a <code>JScrollPane</code> can have a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
 * column header and a row header. Each of these is a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
 * <code>JViewport</code> object that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
 * you specify with <code>setRowHeaderView</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
 * and <code>setColumnHeaderView</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
 * The column header viewport automatically scrolls left and right, tracking
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
 * the left-right scrolling of the main viewport.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
 * (It never scrolls vertically, however.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
 * The row header acts in a similar fashion.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
 * Where two scroll bars meet, the row header meets the column header,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
 * or a scroll bar meets one of the headers, both components stop short
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
 * of the corner, leaving a rectangular space which is, by default, empty.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
 * These spaces can potentially exist in any number of the four corners.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
 * In the previous diagram, the top right space is present and identified
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
 * by the label "corner component".
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
 * Any number of these empty spaces can be replaced by using the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
 * <code>setCorner</code> method to add a component to a particular corner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
 * (Note: The same component cannot be added to multiple corners.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
 * This is useful if there's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
 * some extra decoration or function you'd like to add to the scroll pane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
 * The size of each corner component is entirely determined by the size of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
 * headers and/or scroll bars that surround it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
 * A corner component will only be visible if there is an empty space in that
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
 * corner for it to exist in. For example, consider a component set into the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
 * top right corner of a scroll pane with a column header. If the scroll pane's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
 * vertical scrollbar is not present, perhaps because the view component hasn't
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
 * grown large enough to require it, then the corner component will not be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
 * shown (since there is no empty space in that corner created by the meeting
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
 * of the header and vertical scroll bar). Forcing the scroll bar to always be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
 * shown, using
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
 * <code>setVerticalScrollBarPolicy(VERTICAL_SCROLLBAR_ALWAYS)</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
 * will ensure that the space for the corner component always exists.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
 * To add a border around the main viewport,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
 * you can use <code>setViewportBorder</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
 * (Of course, you can also add a border around the whole scroll pane using
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
 * <code>setBorder</code>.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
 * A common operation to want to do is to set the background color that will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
 * be used if the main viewport view is smaller than the viewport, or is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
 * not opaque. This can be accomplished by setting the background color
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
 * of the viewport, via <code>scrollPane.getViewport().setBackground()</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
 * The reason for setting the color of the viewport and not the scrollpane
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
 * is that by default <code>JViewport</code> is opaque
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
 * which, among other things, means it will completely fill
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
 * in its background using its background color.  Therefore when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
 * <code>JScrollPane</code> draws its background the viewport will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
 * usually draw over it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
 * By default <code>JScrollPane</code> uses <code>ScrollPaneLayout</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
 * to handle the layout of its child Components. <code>ScrollPaneLayout</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
 * determines the size to make the viewport view in one of two ways:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
 * <ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
 *   <li>If the view implements <code>Scrollable</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
 *       a combination of <code>getPreferredScrollableViewportSize</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
 *       <code>getScrollableTracksViewportWidth</code> and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
 *       <code>getScrollableTracksViewportHeight</code>is used, otherwise
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
 *   <li><code>getPreferredSize</code> is used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
 * </ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
 * <strong>Warning:</strong> Swing is not thread safe. For more
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
 * information see <a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
 * href="package-summary.html#threading">Swing's Threading
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
 * Policy</a>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
 * <strong>Warning:</strong>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
 * Serialized objects of this class will not be compatible with
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
 * future Swing releases. The current serialization support is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
 * appropriate for short term storage or RMI between applications running
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
 * the same version of Swing.  As of 1.4, support for long term storage
20458
f2423fb3fd19 8025840: Fix all the doclint warnings about trademark
cl
parents: 20455
diff changeset
   149
 * of all JavaBeans&trade;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
 * has been added to the <code>java.beans</code> package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
 * Please see {@link java.beans.XMLEncoder}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
 * @see JScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
 * @see JViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
 * @see ScrollPaneLayout
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
 * @see Scrollable
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
 * @see Component#getPreferredSize
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
 * @see #setViewportView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
 * @see #setRowHeaderView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
 * @see #setColumnHeaderView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
 * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
 * @see #setViewportBorder
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
 * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
 *     attribute: isContainer true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
 *     attribute: containerDelegate getViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
 *   description: A specialized container that manages a viewport, optional scrollbars and headers
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
 * @author Hans Muller
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
 */
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 21982
diff changeset
   171
@SuppressWarnings("serial") // Same-version serialization only
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
public class JScrollPane extends JComponent implements ScrollPaneConstants, Accessible
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
{
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
    private Border viewportBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   175
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   177
     * @see #getUIClassID
90ce3da70b43 Initial load
duke
parents:
diff changeset
   178
     * @see #readObject
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   180
    private static final String uiClassID = "ScrollPaneUI";
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
90ce3da70b43 Initial load
duke
parents:
diff changeset
   182
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
     * The display policy for the vertical scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
     * The default is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
     * <code>ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
     * @see #setVerticalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   188
    protected int verticalScrollBarPolicy = VERTICAL_SCROLLBAR_AS_NEEDED;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
     * The display policy for the horizontal scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
     * The default is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
     * <code>ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   195
     * @see #setHorizontalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
    protected int horizontalScrollBarPolicy = HORIZONTAL_SCROLLBAR_AS_NEEDED;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   198
90ce3da70b43 Initial load
duke
parents:
diff changeset
   199
90ce3da70b43 Initial load
duke
parents:
diff changeset
   200
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   201
     * The scrollpane's viewport child.  Default is an empty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   202
     * <code>JViewport</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   203
     * @see #setViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   204
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   205
    protected JViewport viewport;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   206
90ce3da70b43 Initial load
duke
parents:
diff changeset
   207
90ce3da70b43 Initial load
duke
parents:
diff changeset
   208
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   209
     * The scrollpane's vertical scrollbar child.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   210
     * Default is a <code>JScrollBar</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   211
     * @see #setVerticalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   212
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   213
    protected JScrollBar verticalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   214
90ce3da70b43 Initial load
duke
parents:
diff changeset
   215
90ce3da70b43 Initial load
duke
parents:
diff changeset
   216
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   217
     * The scrollpane's horizontal scrollbar child.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   218
     * Default is a <code>JScrollBar</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   219
     * @see #setHorizontalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   220
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   221
    protected JScrollBar horizontalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   222
90ce3da70b43 Initial load
duke
parents:
diff changeset
   223
90ce3da70b43 Initial load
duke
parents:
diff changeset
   224
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   225
     * The row header child.  Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   226
     * @see #setRowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
   227
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   228
    protected JViewport rowHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   229
90ce3da70b43 Initial load
duke
parents:
diff changeset
   230
90ce3da70b43 Initial load
duke
parents:
diff changeset
   231
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   232
     * The column header child.  Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   233
     * @see #setColumnHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
   234
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   235
    protected JViewport columnHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   236
90ce3da70b43 Initial load
duke
parents:
diff changeset
   237
90ce3da70b43 Initial load
duke
parents:
diff changeset
   238
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   239
     * The component to display in the lower left corner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   240
     * Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   241
     * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
   242
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   243
    protected Component lowerLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   244
90ce3da70b43 Initial load
duke
parents:
diff changeset
   245
90ce3da70b43 Initial load
duke
parents:
diff changeset
   246
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   247
     * The component to display in the lower right corner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   248
     * Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   249
     * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
   250
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   251
    protected Component lowerRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   252
90ce3da70b43 Initial load
duke
parents:
diff changeset
   253
90ce3da70b43 Initial load
duke
parents:
diff changeset
   254
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   255
     * The component to display in the upper left corner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   256
     * Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   257
     * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
   258
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   259
    protected Component upperLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   260
90ce3da70b43 Initial load
duke
parents:
diff changeset
   261
90ce3da70b43 Initial load
duke
parents:
diff changeset
   262
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   263
     * The component to display in the upper right corner.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   264
     * Default is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   265
     * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
   266
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   267
    protected Component upperRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   268
90ce3da70b43 Initial load
duke
parents:
diff changeset
   269
    /*
90ce3da70b43 Initial load
duke
parents:
diff changeset
   270
     * State flag for mouse wheel scrolling
90ce3da70b43 Initial load
duke
parents:
diff changeset
   271
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   272
    private boolean wheelScrollState = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   273
90ce3da70b43 Initial load
duke
parents:
diff changeset
   274
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   275
     * Creates a <code>JScrollPane</code> that displays the view
90ce3da70b43 Initial load
duke
parents:
diff changeset
   276
     * component in a viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   277
     * whose view position can be controlled with a pair of scrollbars.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   278
     * The scrollbar policies specify when the scrollbars are displayed,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   279
     * For example, if <code>vsbPolicy</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   280
     * <code>VERTICAL_SCROLLBAR_AS_NEEDED</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   281
     * then the vertical scrollbar only appears if the view doesn't fit
90ce3da70b43 Initial load
duke
parents:
diff changeset
   282
     * vertically. The available policy settings are listed at
90ce3da70b43 Initial load
duke
parents:
diff changeset
   283
     * {@link #setVerticalScrollBarPolicy} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   284
     * {@link #setHorizontalScrollBarPolicy}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   285
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   286
     * @see #setViewportView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   287
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   288
     * @param view the component to display in the scrollpanes viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   289
     * @param vsbPolicy an integer that specifies the vertical
90ce3da70b43 Initial load
duke
parents:
diff changeset
   290
     *          scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   291
     * @param hsbPolicy an integer that specifies the horizontal
90ce3da70b43 Initial load
duke
parents:
diff changeset
   292
     *          scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   293
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   294
    public JScrollPane(Component view, int vsbPolicy, int hsbPolicy)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   295
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   296
        setLayout(new ScrollPaneLayout.UIResource());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   297
        setVerticalScrollBarPolicy(vsbPolicy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   298
        setHorizontalScrollBarPolicy(hsbPolicy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   299
        setViewport(createViewport());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   300
        setVerticalScrollBar(createVerticalScrollBar());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   301
        setHorizontalScrollBar(createHorizontalScrollBar());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   302
        if (view != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   303
            setViewportView(view);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   304
        }
2658
43e06bc950ec 6591875: Nimbus Swing Look and Feel
peterz
parents: 466
diff changeset
   305
        setUIProperty("opaque",true);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   306
        updateUI();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   307
90ce3da70b43 Initial load
duke
parents:
diff changeset
   308
        if (!this.getComponentOrientation().isLeftToRight()) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   309
            viewport.setViewPosition(new Point(Integer.MAX_VALUE, 0));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   310
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   311
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   312
90ce3da70b43 Initial load
duke
parents:
diff changeset
   313
90ce3da70b43 Initial load
duke
parents:
diff changeset
   314
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   315
     * Creates a <code>JScrollPane</code> that displays the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   316
     * contents of the specified
90ce3da70b43 Initial load
duke
parents:
diff changeset
   317
     * component, where both horizontal and vertical scrollbars appear
90ce3da70b43 Initial load
duke
parents:
diff changeset
   318
     * whenever the component's contents are larger than the view.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   319
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   320
     * @see #setViewportView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   321
     * @param view the component to display in the scrollpane's viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   322
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   323
    public JScrollPane(Component view) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   324
        this(view, VERTICAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_AS_NEEDED);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   325
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   326
90ce3da70b43 Initial load
duke
parents:
diff changeset
   327
90ce3da70b43 Initial load
duke
parents:
diff changeset
   328
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   329
     * Creates an empty (no viewport view) <code>JScrollPane</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   330
     * with specified
90ce3da70b43 Initial load
duke
parents:
diff changeset
   331
     * scrollbar policies. The available policy settings are listed at
90ce3da70b43 Initial load
duke
parents:
diff changeset
   332
     * {@link #setVerticalScrollBarPolicy} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   333
     * {@link #setHorizontalScrollBarPolicy}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   334
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   335
     * @see #setViewportView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   336
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   337
     * @param vsbPolicy an integer that specifies the vertical
90ce3da70b43 Initial load
duke
parents:
diff changeset
   338
     *          scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   339
     * @param hsbPolicy an integer that specifies the horizontal
90ce3da70b43 Initial load
duke
parents:
diff changeset
   340
     *          scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   341
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   342
    public JScrollPane(int vsbPolicy, int hsbPolicy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   343
        this(null, vsbPolicy, hsbPolicy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   344
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   345
90ce3da70b43 Initial load
duke
parents:
diff changeset
   346
90ce3da70b43 Initial load
duke
parents:
diff changeset
   347
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   348
     * Creates an empty (no viewport view) <code>JScrollPane</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   349
     * where both horizontal and vertical scrollbars appear when needed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   350
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   351
    public JScrollPane() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   352
        this(null, VERTICAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_AS_NEEDED);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   353
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   354
90ce3da70b43 Initial load
duke
parents:
diff changeset
   355
90ce3da70b43 Initial load
duke
parents:
diff changeset
   356
    /**
20157
cafca01a8e28 8025230: [cleanup] some more javadoc formatting fixes for swing
yan
parents: 5506
diff changeset
   357
     * Returns the look and feel (L&amp;F) object that renders this component.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   358
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   359
     * @return the <code>ScrollPaneUI</code> object that renders this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   360
     *                          component
90ce3da70b43 Initial load
duke
parents:
diff changeset
   361
     * @see #setUI
90ce3da70b43 Initial load
duke
parents:
diff changeset
   362
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   363
     *        bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   364
     *       hidden: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   365
     *    attribute: visualUpdate true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   366
     *  description: The UI object that implements the Component's LookAndFeel.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   367
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   368
    public ScrollPaneUI getUI() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   369
        return (ScrollPaneUI)ui;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   370
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   371
90ce3da70b43 Initial load
duke
parents:
diff changeset
   372
90ce3da70b43 Initial load
duke
parents:
diff changeset
   373
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   374
     * Sets the <code>ScrollPaneUI</code> object that provides the
20157
cafca01a8e28 8025230: [cleanup] some more javadoc formatting fixes for swing
yan
parents: 5506
diff changeset
   375
     * look and feel (L&amp;F) for this component.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   376
     *
20157
cafca01a8e28 8025230: [cleanup] some more javadoc formatting fixes for swing
yan
parents: 5506
diff changeset
   377
     * @param ui the <code>ScrollPaneUI</code> L&amp;F object
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   378
     * @see #getUI
90ce3da70b43 Initial load
duke
parents:
diff changeset
   379
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   380
    public void setUI(ScrollPaneUI ui) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   381
        super.setUI(ui);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   382
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   383
90ce3da70b43 Initial load
duke
parents:
diff changeset
   384
90ce3da70b43 Initial load
duke
parents:
diff changeset
   385
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   386
     * Replaces the current <code>ScrollPaneUI</code> object with a version
90ce3da70b43 Initial load
duke
parents:
diff changeset
   387
     * from the current default look and feel.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   388
     * To be called when the default look and feel changes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   389
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   390
     * @see JComponent#updateUI
90ce3da70b43 Initial load
duke
parents:
diff changeset
   391
     * @see UIManager#getUI
90ce3da70b43 Initial load
duke
parents:
diff changeset
   392
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   393
    public void updateUI() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   394
        setUI((ScrollPaneUI)UIManager.getUI(this));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   395
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   396
90ce3da70b43 Initial load
duke
parents:
diff changeset
   397
90ce3da70b43 Initial load
duke
parents:
diff changeset
   398
    /**
20157
cafca01a8e28 8025230: [cleanup] some more javadoc formatting fixes for swing
yan
parents: 5506
diff changeset
   399
     * Returns the suffix used to construct the name of the L&amp;F class used to
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   400
     * render this component.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   401
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   402
     * @return the string "ScrollPaneUI"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   403
     * @see JComponent#getUIClassID
90ce3da70b43 Initial load
duke
parents:
diff changeset
   404
     * @see UIDefaults#getUI
90ce3da70b43 Initial load
duke
parents:
diff changeset
   405
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   406
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   407
     *    hidden: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   408
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   409
    public String getUIClassID() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   410
        return uiClassID;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   411
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   412
90ce3da70b43 Initial load
duke
parents:
diff changeset
   413
90ce3da70b43 Initial load
duke
parents:
diff changeset
   414
90ce3da70b43 Initial load
duke
parents:
diff changeset
   415
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   416
     * Sets the layout manager for this <code>JScrollPane</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   417
     * This method overrides <code>setLayout</code> in
90ce3da70b43 Initial load
duke
parents:
diff changeset
   418
     * <code>java.awt.Container</code> to ensure that only
90ce3da70b43 Initial load
duke
parents:
diff changeset
   419
     * <code>LayoutManager</code>s which
90ce3da70b43 Initial load
duke
parents:
diff changeset
   420
     * are subclasses of <code>ScrollPaneLayout</code> can be used in a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   421
     * <code>JScrollPane</code>. If <code>layout</code> is non-null, this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   422
     * will invoke <code>syncWithScrollPane</code> on it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   423
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   424
     * @param layout the specified layout manager
90ce3da70b43 Initial load
duke
parents:
diff changeset
   425
     * @exception ClassCastException if layout is not a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   426
     *                  <code>ScrollPaneLayout</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   427
     * @see java.awt.Container#getLayout
90ce3da70b43 Initial load
duke
parents:
diff changeset
   428
     * @see java.awt.Container#setLayout
90ce3da70b43 Initial load
duke
parents:
diff changeset
   429
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   430
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   431
     *    hidden: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   432
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   433
    public void setLayout(LayoutManager layout) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   434
        if (layout instanceof ScrollPaneLayout) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   435
            super.setLayout(layout);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   436
            ((ScrollPaneLayout)layout).syncWithScrollPane(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   437
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   438
        else if (layout == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   439
            super.setLayout(layout);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   440
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   441
        else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   442
            String s = "layout of JScrollPane must be a ScrollPaneLayout";
90ce3da70b43 Initial load
duke
parents:
diff changeset
   443
            throw new ClassCastException(s);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   444
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   445
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   446
90ce3da70b43 Initial load
duke
parents:
diff changeset
   447
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   448
     * Overridden to return true so that any calls to <code>revalidate</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   449
     * on any descendants of this <code>JScrollPane</code> will cause the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   450
     * entire tree beginning with this <code>JScrollPane</code> to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   451
     * validated.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   452
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   453
     * @return true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   454
     * @see java.awt.Container#validate
90ce3da70b43 Initial load
duke
parents:
diff changeset
   455
     * @see JComponent#revalidate
90ce3da70b43 Initial load
duke
parents:
diff changeset
   456
     * @see JComponent#isValidateRoot
4261
126dc6fe0d7b 6852592: invalidate() must be smarter
anthony
parents: 2658
diff changeset
   457
     * @see java.awt.Container#isValidateRoot
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   458
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   459
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   460
     *    hidden: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   461
     */
4261
126dc6fe0d7b 6852592: invalidate() must be smarter
anthony
parents: 2658
diff changeset
   462
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   463
    public boolean isValidateRoot() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   464
        return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   465
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   466
90ce3da70b43 Initial load
duke
parents:
diff changeset
   467
90ce3da70b43 Initial load
duke
parents:
diff changeset
   468
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   469
     * Returns the vertical scroll bar policy value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   470
     * @return the <code>verticalScrollBarPolicy</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   471
     * @see #setVerticalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   472
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   473
    public int getVerticalScrollBarPolicy() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   474
        return verticalScrollBarPolicy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   475
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   476
90ce3da70b43 Initial load
duke
parents:
diff changeset
   477
90ce3da70b43 Initial load
duke
parents:
diff changeset
   478
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   479
     * Determines when the vertical scrollbar appears in the scrollpane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   480
     * Legal values are:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   481
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   482
     * <li><code>ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   483
     * <li><code>ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   484
     * <li><code>ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   485
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   486
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   487
     * @param policy one of the three values listed above
90ce3da70b43 Initial load
duke
parents:
diff changeset
   488
     * @exception IllegalArgumentException if <code>policy</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   489
     *                          is not one of the legal values shown above
90ce3da70b43 Initial load
duke
parents:
diff changeset
   490
     * @see #getVerticalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   491
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   492
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   493
     *   preferred: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   494
     *       bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   495
     * description: The scrollpane vertical scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   496
     *        enum: VERTICAL_SCROLLBAR_AS_NEEDED ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
90ce3da70b43 Initial load
duke
parents:
diff changeset
   497
     *              VERTICAL_SCROLLBAR_NEVER ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER
90ce3da70b43 Initial load
duke
parents:
diff changeset
   498
     *              VERTICAL_SCROLLBAR_ALWAYS ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS
90ce3da70b43 Initial load
duke
parents:
diff changeset
   499
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   500
    public void setVerticalScrollBarPolicy(int policy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   501
        switch (policy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   502
        case VERTICAL_SCROLLBAR_AS_NEEDED:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   503
        case VERTICAL_SCROLLBAR_NEVER:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   504
        case VERTICAL_SCROLLBAR_ALWAYS:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   505
                break;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   506
        default:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   507
            throw new IllegalArgumentException("invalid verticalScrollBarPolicy");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   508
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   509
        int old = verticalScrollBarPolicy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   510
        verticalScrollBarPolicy = policy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   511
        firePropertyChange("verticalScrollBarPolicy", old, policy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   512
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   513
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   514
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   515
90ce3da70b43 Initial load
duke
parents:
diff changeset
   516
90ce3da70b43 Initial load
duke
parents:
diff changeset
   517
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   518
     * Returns the horizontal scroll bar policy value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   519
     * @return the <code>horizontalScrollBarPolicy</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   520
     * @see #setHorizontalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   521
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   522
    public int getHorizontalScrollBarPolicy() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   523
        return horizontalScrollBarPolicy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   524
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   525
90ce3da70b43 Initial load
duke
parents:
diff changeset
   526
90ce3da70b43 Initial load
duke
parents:
diff changeset
   527
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   528
     * Determines when the horizontal scrollbar appears in the scrollpane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   529
     * The options are:<ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   530
     * <li><code>ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   531
     * <li><code>ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   532
     * <li><code>ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   533
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   534
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   535
     * @param policy one of the three values listed above
90ce3da70b43 Initial load
duke
parents:
diff changeset
   536
     * @exception IllegalArgumentException if <code>policy</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   537
     *                          is not one of the legal values shown above
90ce3da70b43 Initial load
duke
parents:
diff changeset
   538
     * @see #getHorizontalScrollBarPolicy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   539
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   540
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   541
     *   preferred: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   542
     *       bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   543
     * description: The scrollpane scrollbar policy
90ce3da70b43 Initial load
duke
parents:
diff changeset
   544
     *        enum: HORIZONTAL_SCROLLBAR_AS_NEEDED ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
90ce3da70b43 Initial load
duke
parents:
diff changeset
   545
     *              HORIZONTAL_SCROLLBAR_NEVER ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
90ce3da70b43 Initial load
duke
parents:
diff changeset
   546
     *              HORIZONTAL_SCROLLBAR_ALWAYS ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS
90ce3da70b43 Initial load
duke
parents:
diff changeset
   547
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   548
    public void setHorizontalScrollBarPolicy(int policy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   549
        switch (policy) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   550
        case HORIZONTAL_SCROLLBAR_AS_NEEDED:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   551
        case HORIZONTAL_SCROLLBAR_NEVER:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   552
        case HORIZONTAL_SCROLLBAR_ALWAYS:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   553
                break;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   554
        default:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   555
            throw new IllegalArgumentException("invalid horizontalScrollBarPolicy");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   556
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   557
        int old = horizontalScrollBarPolicy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   558
        horizontalScrollBarPolicy = policy;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   559
        firePropertyChange("horizontalScrollBarPolicy", old, policy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   560
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   561
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   562
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   563
90ce3da70b43 Initial load
duke
parents:
diff changeset
   564
90ce3da70b43 Initial load
duke
parents:
diff changeset
   565
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   566
     * Returns the <code>Border</code> object that surrounds the viewport.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   567
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   568
     * @return the <code>viewportBorder</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   569
     * @see #setViewportBorder
90ce3da70b43 Initial load
duke
parents:
diff changeset
   570
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   571
    public Border getViewportBorder() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   572
        return viewportBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   573
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   574
90ce3da70b43 Initial load
duke
parents:
diff changeset
   575
90ce3da70b43 Initial load
duke
parents:
diff changeset
   576
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   577
     * Adds a border around the viewport.  Note that the border isn't
90ce3da70b43 Initial load
duke
parents:
diff changeset
   578
     * set on the viewport directly, <code>JViewport</code> doesn't support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   579
     * the <code>JComponent</code> border property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   580
     * Similarly setting the <code>JScrollPane</code>s
90ce3da70b43 Initial load
duke
parents:
diff changeset
   581
     * viewport doesn't affect the <code>viewportBorder</code> property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   582
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   583
     * The default value of this property is computed by the look
90ce3da70b43 Initial load
duke
parents:
diff changeset
   584
     * and feel implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   585
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   586
     * @param viewportBorder the border to be added
90ce3da70b43 Initial load
duke
parents:
diff changeset
   587
     * @see #getViewportBorder
90ce3da70b43 Initial load
duke
parents:
diff changeset
   588
     * @see #setViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   589
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   590
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   591
     *   preferred: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   592
     *       bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   593
     * description: The border around the viewport.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   594
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   595
    public void setViewportBorder(Border viewportBorder) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   596
        Border oldValue = this.viewportBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   597
        this.viewportBorder = viewportBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   598
        firePropertyChange("viewportBorder", oldValue, viewportBorder);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   599
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   600
90ce3da70b43 Initial load
duke
parents:
diff changeset
   601
90ce3da70b43 Initial load
duke
parents:
diff changeset
   602
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   603
     * Returns the bounds of the viewport's border.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   604
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   605
     * @return a <code>Rectangle</code> object specifying the viewport border
90ce3da70b43 Initial load
duke
parents:
diff changeset
   606
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   607
    public Rectangle getViewportBorderBounds()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   608
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   609
        Rectangle borderR = new Rectangle(getSize());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   610
90ce3da70b43 Initial load
duke
parents:
diff changeset
   611
        Insets insets = getInsets();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   612
        borderR.x = insets.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   613
        borderR.y = insets.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   614
        borderR.width -= insets.left + insets.right;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   615
        borderR.height -= insets.top + insets.bottom;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   616
90ce3da70b43 Initial load
duke
parents:
diff changeset
   617
        boolean leftToRight = SwingUtilities.isLeftToRight(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   618
90ce3da70b43 Initial load
duke
parents:
diff changeset
   619
        /* If there's a visible column header remove the space it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   620
         * needs from the top of borderR.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   621
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   622
90ce3da70b43 Initial load
duke
parents:
diff changeset
   623
        JViewport colHead = getColumnHeader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   624
        if ((colHead != null) && (colHead.isVisible())) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   625
            int colHeadHeight = colHead.getHeight();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   626
            borderR.y += colHeadHeight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   627
            borderR.height -= colHeadHeight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   628
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   629
90ce3da70b43 Initial load
duke
parents:
diff changeset
   630
        /* If there's a visible row header remove the space it needs
90ce3da70b43 Initial load
duke
parents:
diff changeset
   631
         * from the left of borderR.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   632
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   633
90ce3da70b43 Initial load
duke
parents:
diff changeset
   634
        JViewport rowHead = getRowHeader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   635
        if ((rowHead != null) && (rowHead.isVisible())) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   636
            int rowHeadWidth = rowHead.getWidth();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   637
            if ( leftToRight ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   638
                borderR.x += rowHeadWidth;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   639
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   640
            borderR.width -= rowHeadWidth;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   641
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   642
90ce3da70b43 Initial load
duke
parents:
diff changeset
   643
        /* If there's a visible vertical scrollbar remove the space it needs
90ce3da70b43 Initial load
duke
parents:
diff changeset
   644
         * from the width of borderR.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   645
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   646
        JScrollBar vsb = getVerticalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   647
        if ((vsb != null) && (vsb.isVisible())) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   648
            int vsbWidth = vsb.getWidth();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   649
            if ( !leftToRight ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   650
                borderR.x += vsbWidth;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   651
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   652
            borderR.width -= vsbWidth;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   653
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   654
90ce3da70b43 Initial load
duke
parents:
diff changeset
   655
        /* If there's a visible horizontal scrollbar remove the space it needs
90ce3da70b43 Initial load
duke
parents:
diff changeset
   656
         * from the height of borderR.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   657
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   658
        JScrollBar hsb = getHorizontalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   659
        if ((hsb != null) && (hsb.isVisible())) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   660
            borderR.height -= hsb.getHeight();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   661
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   662
90ce3da70b43 Initial load
duke
parents:
diff changeset
   663
        return borderR;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   664
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   665
90ce3da70b43 Initial load
duke
parents:
diff changeset
   666
90ce3da70b43 Initial load
duke
parents:
diff changeset
   667
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   668
     * By default <code>JScrollPane</code> creates scrollbars
90ce3da70b43 Initial load
duke
parents:
diff changeset
   669
     * that are instances
90ce3da70b43 Initial load
duke
parents:
diff changeset
   670
     * of this class.  <code>Scrollbar</code> overrides the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   671
     * <code>getUnitIncrement</code> and <code>getBlockIncrement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   672
     * methods so that, if the viewport's view is a <code>Scrollable</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   673
     * the view is asked to compute these values. Unless
90ce3da70b43 Initial load
duke
parents:
diff changeset
   674
     * the unit/block increment have been explicitly set.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   675
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   676
     * <strong>Warning:</strong>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   677
     * Serialized objects of this class will not be compatible with
90ce3da70b43 Initial load
duke
parents:
diff changeset
   678
     * future Swing releases. The current serialization support is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   679
     * appropriate for short term storage or RMI between applications running
90ce3da70b43 Initial load
duke
parents:
diff changeset
   680
     * the same version of Swing.  As of 1.4, support for long term storage
20458
f2423fb3fd19 8025840: Fix all the doclint warnings about trademark
cl
parents: 20455
diff changeset
   681
     * of all JavaBeans&trade;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   682
     * has been added to the <code>java.beans</code> package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   683
     * Please see {@link java.beans.XMLEncoder}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   684
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   685
     * @see Scrollable
90ce3da70b43 Initial load
duke
parents:
diff changeset
   686
     * @see JScrollPane#createVerticalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   687
     * @see JScrollPane#createHorizontalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   688
     */
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 21982
diff changeset
   689
    @SuppressWarnings("serial") // Same-version serialization only
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   690
    protected class ScrollBar extends JScrollBar implements UIResource
90ce3da70b43 Initial load
duke
parents:
diff changeset
   691
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   692
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   693
         * Set to true when the unit increment has been explicitly set.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   694
         * If this is false the viewport's view is obtained and if it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   695
         * is an instance of <code>Scrollable</code> the unit increment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   696
         * from it is used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   697
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   698
        private boolean unitIncrementSet;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   699
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   700
         * Set to true when the block increment has been explicitly set.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   701
         * If this is false the viewport's view is obtained and if it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   702
         * is an instance of <code>Scrollable</code> the block increment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   703
         * from it is used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   704
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   705
        private boolean blockIncrementSet;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   706
90ce3da70b43 Initial load
duke
parents:
diff changeset
   707
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   708
         * Creates a scrollbar with the specified orientation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   709
         * The options are:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   710
         * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   711
         * <li><code>ScrollPaneConstants.VERTICAL</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   712
         * <li><code>ScrollPaneConstants.HORIZONTAL</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   713
         * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   714
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   715
         * @param orientation  an integer specifying one of the legal
90ce3da70b43 Initial load
duke
parents:
diff changeset
   716
         *      orientation values shown above
90ce3da70b43 Initial load
duke
parents:
diff changeset
   717
         * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   718
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   719
        public ScrollBar(int orientation) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   720
            super(orientation);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   721
            this.putClientProperty("JScrollBar.fastWheelScrolling",
90ce3da70b43 Initial load
duke
parents:
diff changeset
   722
                                   Boolean.TRUE);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   723
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   724
90ce3da70b43 Initial load
duke
parents:
diff changeset
   725
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   726
         * Messages super to set the value, and resets the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   727
         * <code>unitIncrementSet</code> instance variable to true.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   728
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   729
         * @param unitIncrement the new unit increment value, in pixels
90ce3da70b43 Initial load
duke
parents:
diff changeset
   730
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   731
        public void setUnitIncrement(int unitIncrement) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   732
            unitIncrementSet = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   733
            this.putClientProperty("JScrollBar.fastWheelScrolling", null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   734
            super.setUnitIncrement(unitIncrement);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   735
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   736
90ce3da70b43 Initial load
duke
parents:
diff changeset
   737
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   738
         * Computes the unit increment for scrolling if the viewport's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   739
         * view is a <code>Scrollable</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   740
         * Otherwise return <code>super.getUnitIncrement</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   741
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   742
         * @param direction less than zero to scroll up/left,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   743
         *      greater than zero for down/right
90ce3da70b43 Initial load
duke
parents:
diff changeset
   744
         * @return an integer, in pixels, containing the unit increment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   745
         * @see Scrollable#getScrollableUnitIncrement
90ce3da70b43 Initial load
duke
parents:
diff changeset
   746
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   747
        public int getUnitIncrement(int direction) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   748
            JViewport vp = getViewport();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   749
            if (!unitIncrementSet && (vp != null) &&
90ce3da70b43 Initial load
duke
parents:
diff changeset
   750
                (vp.getView() instanceof Scrollable)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   751
                Scrollable view = (Scrollable)(vp.getView());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   752
                Rectangle vr = vp.getViewRect();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   753
                return view.getScrollableUnitIncrement(vr, getOrientation(), direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   754
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   755
            else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   756
                return super.getUnitIncrement(direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   757
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   758
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   759
90ce3da70b43 Initial load
duke
parents:
diff changeset
   760
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   761
         * Messages super to set the value, and resets the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   762
         * <code>blockIncrementSet</code> instance variable to true.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   763
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   764
         * @param blockIncrement the new block increment value, in pixels
90ce3da70b43 Initial load
duke
parents:
diff changeset
   765
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   766
        public void setBlockIncrement(int blockIncrement) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   767
            blockIncrementSet = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   768
            this.putClientProperty("JScrollBar.fastWheelScrolling", null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   769
            super.setBlockIncrement(blockIncrement);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   770
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   771
90ce3da70b43 Initial load
duke
parents:
diff changeset
   772
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   773
         * Computes the block increment for scrolling if the viewport's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   774
         * view is a <code>Scrollable</code> object.  Otherwise
90ce3da70b43 Initial load
duke
parents:
diff changeset
   775
         * the <code>blockIncrement</code> equals the viewport's width
90ce3da70b43 Initial load
duke
parents:
diff changeset
   776
         * or height.  If there's no viewport return
90ce3da70b43 Initial load
duke
parents:
diff changeset
   777
         * <code>super.getBlockIncrement</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   778
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   779
         * @param direction less than zero to scroll up/left,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   780
         *      greater than zero for down/right
90ce3da70b43 Initial load
duke
parents:
diff changeset
   781
         * @return an integer, in pixels, containing the block increment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   782
         * @see Scrollable#getScrollableBlockIncrement
90ce3da70b43 Initial load
duke
parents:
diff changeset
   783
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   784
        public int getBlockIncrement(int direction) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   785
            JViewport vp = getViewport();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   786
            if (blockIncrementSet || vp == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   787
                return super.getBlockIncrement(direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   788
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   789
            else if (vp.getView() instanceof Scrollable) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   790
                Scrollable view = (Scrollable)(vp.getView());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   791
                Rectangle vr = vp.getViewRect();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   792
                return view.getScrollableBlockIncrement(vr, getOrientation(), direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   793
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   794
            else if (getOrientation() == VERTICAL) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   795
                return vp.getExtentSize().height;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   796
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   797
            else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   798
                return vp.getExtentSize().width;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   799
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   800
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   801
90ce3da70b43 Initial load
duke
parents:
diff changeset
   802
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   803
90ce3da70b43 Initial load
duke
parents:
diff changeset
   804
90ce3da70b43 Initial load
duke
parents:
diff changeset
   805
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   806
     * Returns a <code>JScrollPane.ScrollBar</code> by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   807
     * Subclasses may override this method to force <code>ScrollPaneUI</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   808
     * implementations to use a <code>JScrollBar</code> subclass.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   809
     * Used by <code>ScrollPaneUI</code> implementations to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   810
     * create the horizontal scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   811
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   812
     * @return a <code>JScrollBar</code> with a horizontal orientation
90ce3da70b43 Initial load
duke
parents:
diff changeset
   813
     * @see JScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   814
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   815
    public JScrollBar createHorizontalScrollBar() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   816
        return new ScrollBar(JScrollBar.HORIZONTAL);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   817
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   818
90ce3da70b43 Initial load
duke
parents:
diff changeset
   819
90ce3da70b43 Initial load
duke
parents:
diff changeset
   820
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   821
     * Returns the horizontal scroll bar that controls the viewport's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   822
     * horizontal view position.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   823
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   824
     * @return the <code>horizontalScrollBar</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   825
     * @see #setHorizontalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   826
     */
466
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
   827
    @Transient
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   828
    public JScrollBar getHorizontalScrollBar() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   829
        return horizontalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   830
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   831
90ce3da70b43 Initial load
duke
parents:
diff changeset
   832
90ce3da70b43 Initial load
duke
parents:
diff changeset
   833
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   834
     * Adds the scrollbar that controls the viewport's horizontal view
90ce3da70b43 Initial load
duke
parents:
diff changeset
   835
     * position to the scrollpane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   836
     * This is usually unnecessary, as <code>JScrollPane</code> creates
90ce3da70b43 Initial load
duke
parents:
diff changeset
   837
     * horizontal and vertical scrollbars by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   838
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   839
     * @param horizontalScrollBar the horizontal scrollbar to be added
90ce3da70b43 Initial load
duke
parents:
diff changeset
   840
     * @see #createHorizontalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   841
     * @see #getHorizontalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   842
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   843
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   844
     *        expert: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   845
     *         bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   846
     *   description: The horizontal scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   847
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   848
    public void setHorizontalScrollBar(JScrollBar horizontalScrollBar) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   849
        JScrollBar old = getHorizontalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   850
        this.horizontalScrollBar = horizontalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   851
        if (horizontalScrollBar != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   852
            add(horizontalScrollBar, HORIZONTAL_SCROLLBAR);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   853
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   854
        else if (old != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   855
            remove(old);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   856
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   857
        firePropertyChange("horizontalScrollBar", old, horizontalScrollBar);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   858
90ce3da70b43 Initial load
duke
parents:
diff changeset
   859
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   860
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   861
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   862
90ce3da70b43 Initial load
duke
parents:
diff changeset
   863
90ce3da70b43 Initial load
duke
parents:
diff changeset
   864
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   865
     * Returns a <code>JScrollPane.ScrollBar</code> by default.  Subclasses
90ce3da70b43 Initial load
duke
parents:
diff changeset
   866
     * may override this method to force <code>ScrollPaneUI</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   867
     * implementations to use a <code>JScrollBar</code> subclass.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   868
     * Used by <code>ScrollPaneUI</code> implementations to create the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   869
     * vertical scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   870
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   871
     * @return a <code>JScrollBar</code> with a vertical orientation
90ce3da70b43 Initial load
duke
parents:
diff changeset
   872
     * @see JScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   873
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   874
    public JScrollBar createVerticalScrollBar() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   875
        return new ScrollBar(JScrollBar.VERTICAL);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   876
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   877
90ce3da70b43 Initial load
duke
parents:
diff changeset
   878
90ce3da70b43 Initial load
duke
parents:
diff changeset
   879
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   880
     * Returns the vertical scroll bar that controls the viewports
90ce3da70b43 Initial load
duke
parents:
diff changeset
   881
     * vertical view position.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   882
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   883
     * @return the <code>verticalScrollBar</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   884
     * @see #setVerticalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   885
     */
466
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
   886
    @Transient
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   887
    public JScrollBar getVerticalScrollBar() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   888
        return verticalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   889
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   890
90ce3da70b43 Initial load
duke
parents:
diff changeset
   891
90ce3da70b43 Initial load
duke
parents:
diff changeset
   892
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   893
     * Adds the scrollbar that controls the viewports vertical view position
90ce3da70b43 Initial load
duke
parents:
diff changeset
   894
     * to the scrollpane.  This is usually unnecessary,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   895
     * as <code>JScrollPane</code> creates vertical and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   896
     * horizontal scrollbars by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   897
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   898
     * @param verticalScrollBar the new vertical scrollbar to be added
90ce3da70b43 Initial load
duke
parents:
diff changeset
   899
     * @see #createVerticalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   900
     * @see #getVerticalScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   901
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   902
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   903
     *        expert: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   904
     *         bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   905
     *   description: The vertical scrollbar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   906
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   907
    public void setVerticalScrollBar(JScrollBar verticalScrollBar) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   908
        JScrollBar old = getVerticalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   909
        this.verticalScrollBar = verticalScrollBar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   910
        add(verticalScrollBar, VERTICAL_SCROLLBAR);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   911
        firePropertyChange("verticalScrollBar", old, verticalScrollBar);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   912
90ce3da70b43 Initial load
duke
parents:
diff changeset
   913
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   914
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   915
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   916
90ce3da70b43 Initial load
duke
parents:
diff changeset
   917
90ce3da70b43 Initial load
duke
parents:
diff changeset
   918
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   919
     * Returns a new <code>JViewport</code> by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   920
     * Used to create the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   921
     * viewport (as needed) in <code>setViewportView</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   922
     * <code>setRowHeaderView</code>, and <code>setColumnHeaderView</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   923
     * Subclasses may override this method to return a subclass of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   924
     * <code>JViewport</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   925
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   926
     * @return a new <code>JViewport</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   927
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   928
    protected JViewport createViewport() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   929
        return new JViewport();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   930
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   931
90ce3da70b43 Initial load
duke
parents:
diff changeset
   932
90ce3da70b43 Initial load
duke
parents:
diff changeset
   933
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   934
     * Returns the current <code>JViewport</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   935
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   936
     * @see #setViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   937
     * @return the <code>viewport</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
   938
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   939
    public JViewport getViewport() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   940
        return viewport;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   941
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   942
90ce3da70b43 Initial load
duke
parents:
diff changeset
   943
90ce3da70b43 Initial load
duke
parents:
diff changeset
   944
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   945
     * Removes the old viewport (if there is one); forces the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   946
     * viewPosition of the new viewport to be in the +x,+y quadrant;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   947
     * syncs up the row and column headers (if there are any) with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   948
     * new viewport; and finally syncs the scrollbars and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   949
     * headers with the new viewport.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   950
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   951
     * Most applications will find it more convenient to use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   952
     * <code>setViewportView</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   953
     * to add a viewport and a view to the scrollpane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   954
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   955
     * @param viewport the new viewport to be used; if viewport is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   956
     *          <code>null</code>, the old viewport is still removed
90ce3da70b43 Initial load
duke
parents:
diff changeset
   957
     *          and the new viewport is set to <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   958
     * @see #createViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   959
     * @see #getViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
   960
     * @see #setViewportView
90ce3da70b43 Initial load
duke
parents:
diff changeset
   961
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   962
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
   963
     *       expert: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   964
     *        bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   965
     *    attribute: visualUpdate true
90ce3da70b43 Initial load
duke
parents:
diff changeset
   966
     *  description: The viewport child for this scrollpane
90ce3da70b43 Initial load
duke
parents:
diff changeset
   967
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   968
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   969
    public void setViewport(JViewport viewport) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   970
        JViewport old = getViewport();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   971
        this.viewport = viewport;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   972
        if (viewport != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   973
            add(viewport, VIEWPORT);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   974
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   975
        else if (old != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   976
            remove(old);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   977
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   978
        firePropertyChange("viewport", old, viewport);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   979
90ce3da70b43 Initial load
duke
parents:
diff changeset
   980
        if (accessibleContext != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   981
            ((AccessibleJScrollPane)accessibleContext).resetViewPort();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   982
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   983
90ce3da70b43 Initial load
duke
parents:
diff changeset
   984
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   985
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   986
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   987
90ce3da70b43 Initial load
duke
parents:
diff changeset
   988
90ce3da70b43 Initial load
duke
parents:
diff changeset
   989
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   990
     * Creates a viewport if necessary and then sets its view.  Applications
90ce3da70b43 Initial load
duke
parents:
diff changeset
   991
     * that don't provide the view directly to the <code>JScrollPane</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   992
     * constructor
90ce3da70b43 Initial load
duke
parents:
diff changeset
   993
     * should use this method to specify the scrollable child that's going
90ce3da70b43 Initial load
duke
parents:
diff changeset
   994
     * to be displayed in the scrollpane. For example:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   995
     * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   996
     * JScrollPane scrollpane = new JScrollPane();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   997
     * scrollpane.setViewportView(myBigComponentToScroll);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   998
     * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   999
     * Applications should not add children directly to the scrollpane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1000
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1001
     * @param view the component to add to the viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1002
     * @see #setViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1003
     * @see JViewport#setView
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1004
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1005
    public void setViewportView(Component view) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1006
        if (getViewport() == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1007
            setViewport(createViewport());
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1008
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1009
        getViewport().setView(view);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1010
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1011
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1012
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1013
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1014
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1015
     * Returns the row header.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1016
     * @return the <code>rowHeader</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1017
     * @see #setRowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1018
     */
466
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
  1019
    @Transient
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1020
    public JViewport getRowHeader() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1021
        return rowHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1022
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1023
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1024
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1025
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1026
     * Removes the old rowHeader, if it exists; if the new rowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1027
     * isn't <code>null</code>, syncs the y coordinate of its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1028
     * viewPosition with
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1029
     * the viewport (if there is one) and then adds it to the scroll pane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1030
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1031
     * Most applications will find it more convenient to use
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1032
     * <code>setRowHeaderView</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1033
     * to add a row header component and its viewport to the scroll pane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1034
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1035
     * @param rowHeader the new row header to be used; if <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1036
     *          the old row header is still removed and the new rowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1037
     *          is set to <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1038
     * @see #getRowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1039
     * @see #setRowHeaderView
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1040
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1041
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1042
     *        bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1043
     *       expert: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1044
     *  description: The row header child for this scrollpane
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1045
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1046
    public void setRowHeader(JViewport rowHeader) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1047
        JViewport old = getRowHeader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1048
        this.rowHeader = rowHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1049
        if (rowHeader != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1050
            add(rowHeader, ROW_HEADER);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1051
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1052
        else if (old != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1053
            remove(old);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1054
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1055
        firePropertyChange("rowHeader", old, rowHeader);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1056
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1057
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1058
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1059
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1060
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1061
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1062
     * Creates a row-header viewport if necessary, sets
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1063
     * its view and then adds the row-header viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1064
     * to the scrollpane.  For example:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1065
     * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1066
     * JScrollPane scrollpane = new JScrollPane();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1067
     * scrollpane.setViewportView(myBigComponentToScroll);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1068
     * scrollpane.setRowHeaderView(myBigComponentsRowHeader);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1069
     * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1070
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1071
     * @see #setRowHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1072
     * @see JViewport#setView
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1073
     * @param view the component to display as the row header
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1074
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1075
    public void setRowHeaderView(Component view) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1076
        if (getRowHeader() == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1077
            setRowHeader(createViewport());
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1078
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1079
        getRowHeader().setView(view);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1080
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1081
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1082
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1083
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1084
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1085
     * Returns the column header.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1086
     * @return the <code>columnHeader</code> property
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1087
     * @see #setColumnHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1088
     */
466
6acd5ec503a8 4935607: RFE: LTP: Should be possible to set the TRANSIENT attribute of propertiies to FALSE
malenkov
parents: 2
diff changeset
  1089
    @Transient
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1090
    public JViewport getColumnHeader() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1091
        return columnHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1092
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1093
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1094
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1095
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1096
     * Removes the old columnHeader, if it exists; if the new columnHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1097
     * isn't <code>null</code>, syncs the x coordinate of its viewPosition
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1098
     * with the viewport (if there is one) and then adds it to the scroll pane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1099
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1100
     * Most applications will find it more convenient to use
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1101
     * <code>setColumnHeaderView</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1102
     * to add a column header component and its viewport to the scroll pane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1103
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1104
     * @see #getColumnHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1105
     * @see #setColumnHeaderView
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1106
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1107
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1108
     *        bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1109
     *  description: The column header child for this scrollpane
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1110
     *    attribute: visualUpdate true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1111
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1112
    public void setColumnHeader(JViewport columnHeader) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1113
        JViewport old = getColumnHeader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1114
        this.columnHeader = columnHeader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1115
        if (columnHeader != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1116
            add(columnHeader, COLUMN_HEADER);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1117
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1118
        else if (old != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1119
            remove(old);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1120
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1121
        firePropertyChange("columnHeader", old, columnHeader);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1122
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1123
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1124
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1125
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1126
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1127
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1128
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1129
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1130
     * Creates a column-header viewport if necessary, sets
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1131
     * its view, and then adds the column-header viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1132
     * to the scrollpane.  For example:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1133
     * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1134
     * JScrollPane scrollpane = new JScrollPane();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1135
     * scrollpane.setViewportView(myBigComponentToScroll);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1136
     * scrollpane.setColumnHeaderView(myBigComponentsColumnHeader);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1137
     * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1138
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1139
     * @see #setColumnHeader
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1140
     * @see JViewport#setView
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1141
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1142
     * @param view the component to display as the column header
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1143
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1144
    public void setColumnHeaderView(Component view) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1145
        if (getColumnHeader() == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1146
            setColumnHeader(createViewport());
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1147
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1148
        getColumnHeader().setView(view);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1149
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1150
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1151
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1152
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1153
     * Returns the component at the specified corner. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1154
     * <code>key</code> value specifying the corner is one of:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1155
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1156
     * <li>ScrollPaneConstants.LOWER_LEFT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1157
     * <li>ScrollPaneConstants.LOWER_RIGHT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1158
     * <li>ScrollPaneConstants.UPPER_LEFT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1159
     * <li>ScrollPaneConstants.UPPER_RIGHT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1160
     * <li>ScrollPaneConstants.LOWER_LEADING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1161
     * <li>ScrollPaneConstants.LOWER_TRAILING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1162
     * <li>ScrollPaneConstants.UPPER_LEADING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1163
     * <li>ScrollPaneConstants.UPPER_TRAILING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1164
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1165
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1166
     * @param key one of the values as shown above
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1167
     * @return the corner component (which may be <code>null</code>)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1168
     *         identified by the given key, or <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1169
     *         if the key is invalid
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1170
     * @see #setCorner
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1171
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1172
    public Component getCorner(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1173
        boolean isLeftToRight = getComponentOrientation().isLeftToRight();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1174
        if (key.equals(LOWER_LEADING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1175
            key = isLeftToRight ? LOWER_LEFT_CORNER : LOWER_RIGHT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1176
        } else if (key.equals(LOWER_TRAILING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1177
            key = isLeftToRight ? LOWER_RIGHT_CORNER : LOWER_LEFT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1178
        } else if (key.equals(UPPER_LEADING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1179
            key = isLeftToRight ? UPPER_LEFT_CORNER : UPPER_RIGHT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1180
        } else if (key.equals(UPPER_TRAILING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1181
            key = isLeftToRight ? UPPER_RIGHT_CORNER : UPPER_LEFT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1182
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1183
        if (key.equals(LOWER_LEFT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1184
            return lowerLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1185
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1186
        else if (key.equals(LOWER_RIGHT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1187
            return lowerRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1188
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1189
        else if (key.equals(UPPER_LEFT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1190
            return upperLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1191
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1192
        else if (key.equals(UPPER_RIGHT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1193
            return upperRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1194
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1195
        else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1196
            return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1197
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1198
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1199
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1200
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1201
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1202
     * Adds a child that will appear in one of the scroll panes
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1203
     * corners, if there's room.   For example with both scrollbars
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1204
     * showing (on the right and bottom edges of the scrollpane)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1205
     * the lower left corner component will be shown in the space
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1206
     * between ends of the two scrollbars. Legal values for
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1207
     * the <b>key</b> are:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1208
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1209
     * <li>ScrollPaneConstants.LOWER_LEFT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1210
     * <li>ScrollPaneConstants.LOWER_RIGHT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1211
     * <li>ScrollPaneConstants.UPPER_LEFT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1212
     * <li>ScrollPaneConstants.UPPER_RIGHT_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1213
     * <li>ScrollPaneConstants.LOWER_LEADING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1214
     * <li>ScrollPaneConstants.LOWER_TRAILING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1215
     * <li>ScrollPaneConstants.UPPER_LEADING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1216
     * <li>ScrollPaneConstants.UPPER_TRAILING_CORNER
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1217
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1218
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1219
     * Although "corner" doesn't match any beans property
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1220
     * signature, <code>PropertyChange</code> events are generated with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1221
     * property name set to the corner key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1222
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1223
     * @param key identifies which corner the component will appear in
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1224
     * @param corner one of the following components:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1225
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1226
     * <li>lowerLeft
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1227
     * <li>lowerRight
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1228
     * <li>upperLeft
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1229
     * <li>upperRight
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1230
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1231
     * @exception IllegalArgumentException if corner key is invalid
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1232
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1233
    public void setCorner(String key, Component corner)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1234
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1235
        Component old;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1236
        boolean isLeftToRight = getComponentOrientation().isLeftToRight();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1237
        if (key.equals(LOWER_LEADING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1238
            key = isLeftToRight ? LOWER_LEFT_CORNER : LOWER_RIGHT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1239
        } else if (key.equals(LOWER_TRAILING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1240
            key = isLeftToRight ? LOWER_RIGHT_CORNER : LOWER_LEFT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1241
        } else if (key.equals(UPPER_LEADING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1242
            key = isLeftToRight ? UPPER_LEFT_CORNER : UPPER_RIGHT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1243
        } else if (key.equals(UPPER_TRAILING_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1244
            key = isLeftToRight ? UPPER_RIGHT_CORNER : UPPER_LEFT_CORNER;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1245
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1246
        if (key.equals(LOWER_LEFT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1247
            old = lowerLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1248
            lowerLeft = corner;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1249
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1250
        else if (key.equals(LOWER_RIGHT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1251
            old = lowerRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1252
            lowerRight = corner;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1253
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1254
        else if (key.equals(UPPER_LEFT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1255
            old = upperLeft;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1256
            upperLeft = corner;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1257
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1258
        else if (key.equals(UPPER_RIGHT_CORNER)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1259
            old = upperRight;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1260
            upperRight = corner;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1261
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1262
        else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1263
            throw new IllegalArgumentException("invalid corner key");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1264
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1265
        if (old != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1266
            remove(old);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1267
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1268
        if (corner != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1269
            add(corner, key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1270
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1271
        firePropertyChange(key, old, corner);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1272
        revalidate();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1273
        repaint();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1274
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1275
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1276
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1277
     * Sets the orientation for the vertical and horizontal
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1278
     * scrollbars as determined by the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1279
     * <code>ComponentOrientation</code> argument.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1280
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1281
     * @param  co one of the following values:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1282
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1283
     * <li>java.awt.ComponentOrientation.LEFT_TO_RIGHT
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1284
     * <li>java.awt.ComponentOrientation.RIGHT_TO_LEFT
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1285
     * <li>java.awt.ComponentOrientation.UNKNOWN
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1286
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1287
     * @see java.awt.ComponentOrientation
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1288
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1289
    public void setComponentOrientation( ComponentOrientation co ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1290
        super.setComponentOrientation( co );
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1291
        if( verticalScrollBar != null )
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1292
            verticalScrollBar.setComponentOrientation( co );
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1293
        if( horizontalScrollBar != null )
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1294
            horizontalScrollBar.setComponentOrientation( co );
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1295
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1296
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1297
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1298
     * Indicates whether or not scrolling will take place in response to the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1299
     * mouse wheel.  Wheel scrolling is enabled by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1300
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1301
     * @see #setWheelScrollingEnabled
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1302
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1303
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1304
     *       bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1305
     * description: Flag for enabling/disabling mouse wheel scrolling
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1306
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1307
    public boolean isWheelScrollingEnabled() {return wheelScrollState;}
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1308
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1309
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1310
     * Enables/disables scrolling in response to movement of the mouse wheel.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1311
     * Wheel scrolling is enabled by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1312
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1313
     * @param handleWheel   <code>true</code> if scrolling should be done
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1314
     *                      automatically for a MouseWheelEvent,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1315
     *                      <code>false</code> otherwise.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1316
     * @see #isWheelScrollingEnabled
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1317
     * @see java.awt.event.MouseWheelEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1318
     * @see java.awt.event.MouseWheelListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1319
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1320
     * @beaninfo
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1321
     *       bound: true
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1322
     * description: Flag for enabling/disabling mouse wheel scrolling
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1323
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1324
    public void setWheelScrollingEnabled(boolean handleWheel) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1325
        boolean old = wheelScrollState;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1326
        wheelScrollState = handleWheel;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1327
        firePropertyChange("wheelScrollingEnabled", old, handleWheel);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1328
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1329
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1330
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1331
     * See <code>readObject</code> and <code>writeObject</code> in
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1332
     * <code>JComponent</code> for more
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1333
     * information about serialization in Swing.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1334
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1335
    private void writeObject(ObjectOutputStream s) throws IOException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1336
        s.defaultWriteObject();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1337
        if (getUIClassID().equals(uiClassID)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1338
            byte count = JComponent.getWriteObjCounter(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1339
            JComponent.setWriteObjCounter(this, --count);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1340
            if (count == 0 && ui != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1341
                ui.installUI(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1342
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1343
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1344
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1345
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1346
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1347
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1348
     * Returns a string representation of this <code>JScrollPane</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1349
     * This method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1350
     * is intended to be used only for debugging purposes, and the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1351
     * content and format of the returned string may vary between
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1352
     * implementations. The returned string may be empty but may not
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1353
     * be <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1354
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1355
     * @return  a string representation of this <code>JScrollPane</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1356
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1357
    protected String paramString() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1358
        String viewportBorderString = (viewportBorder != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1359
                                       viewportBorder.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1360
        String viewportString = (viewport != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1361
                                 viewport.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1362
        String verticalScrollBarPolicyString;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1363
        if (verticalScrollBarPolicy == VERTICAL_SCROLLBAR_AS_NEEDED) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1364
            verticalScrollBarPolicyString = "VERTICAL_SCROLLBAR_AS_NEEDED";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1365
        } else if (verticalScrollBarPolicy == VERTICAL_SCROLLBAR_NEVER) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1366
            verticalScrollBarPolicyString = "VERTICAL_SCROLLBAR_NEVER";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1367
        } else if (verticalScrollBarPolicy == VERTICAL_SCROLLBAR_ALWAYS) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1368
            verticalScrollBarPolicyString = "VERTICAL_SCROLLBAR_ALWAYS";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1369
        } else verticalScrollBarPolicyString = "";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1370
        String horizontalScrollBarPolicyString;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1371
        if (horizontalScrollBarPolicy == HORIZONTAL_SCROLLBAR_AS_NEEDED) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1372
            horizontalScrollBarPolicyString = "HORIZONTAL_SCROLLBAR_AS_NEEDED";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1373
        } else if (horizontalScrollBarPolicy == HORIZONTAL_SCROLLBAR_NEVER) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1374
            horizontalScrollBarPolicyString = "HORIZONTAL_SCROLLBAR_NEVER";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1375
        } else if (horizontalScrollBarPolicy == HORIZONTAL_SCROLLBAR_ALWAYS) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1376
            horizontalScrollBarPolicyString = "HORIZONTAL_SCROLLBAR_ALWAYS";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1377
        } else horizontalScrollBarPolicyString = "";
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1378
        String horizontalScrollBarString = (horizontalScrollBar != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1379
                                            horizontalScrollBar.toString()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1380
                                            : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1381
        String verticalScrollBarString = (verticalScrollBar != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1382
                                          verticalScrollBar.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1383
        String columnHeaderString = (columnHeader != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1384
                                     columnHeader.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1385
        String rowHeaderString = (rowHeader != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1386
                                  rowHeader.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1387
        String lowerLeftString = (lowerLeft != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1388
                                  lowerLeft.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1389
        String lowerRightString = (lowerRight != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1390
                                  lowerRight.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1391
        String upperLeftString = (upperLeft != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1392
                                  upperLeft.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1393
        String upperRightString = (upperRight != null ?
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1394
                                  upperRight.toString() : "");
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1395
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1396
        return super.paramString() +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1397
        ",columnHeader=" + columnHeaderString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1398
        ",horizontalScrollBar=" + horizontalScrollBarString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1399
        ",horizontalScrollBarPolicy=" + horizontalScrollBarPolicyString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1400
        ",lowerLeft=" + lowerLeftString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1401
        ",lowerRight=" + lowerRightString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1402
        ",rowHeader=" + rowHeaderString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1403
        ",upperLeft=" + upperLeftString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1404
        ",upperRight=" + upperRightString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1405
        ",verticalScrollBar=" + verticalScrollBarString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1406
        ",verticalScrollBarPolicy=" + verticalScrollBarPolicyString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1407
        ",viewport=" + viewportString +
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1408
        ",viewportBorder=" + viewportBorderString;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1409
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1410
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1411
/////////////////
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1412
// Accessibility support
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1413
////////////////
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1414
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1415
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1416
     * Gets the AccessibleContext associated with this JScrollPane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1417
     * For scroll panes, the AccessibleContext takes the form of an
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1418
     * AccessibleJScrollPane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1419
     * A new AccessibleJScrollPane instance is created if necessary.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1420
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1421
     * @return an AccessibleJScrollPane that serves as the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1422
     *         AccessibleContext of this JScrollPane
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1423
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1424
    public AccessibleContext getAccessibleContext() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1425
        if (accessibleContext == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1426
            accessibleContext = new AccessibleJScrollPane();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1427
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1428
        return accessibleContext;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1429
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1430
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1431
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1432
     * This class implements accessibility support for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1433
     * <code>JScrollPane</code> class.  It provides an implementation of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1434
     * Java Accessibility API appropriate to scroll pane user-interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1435
     * elements.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1436
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1437
     * <strong>Warning:</strong>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1438
     * Serialized objects of this class will not be compatible with
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1439
     * future Swing releases. The current serialization support is
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1440
     * appropriate for short term storage or RMI between applications running
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1441
     * the same version of Swing.  As of 1.4, support for long term storage
20458
f2423fb3fd19 8025840: Fix all the doclint warnings about trademark
cl
parents: 20455
diff changeset
  1442
     * of all JavaBeans&trade;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1443
     * has been added to the <code>java.beans</code> package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1444
     * Please see {@link java.beans.XMLEncoder}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1445
     */
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 21982
diff changeset
  1446
    @SuppressWarnings("serial") // Same-version serialization only
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1447
    protected class AccessibleJScrollPane extends AccessibleJComponent
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1448
        implements ChangeListener, PropertyChangeListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1449
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1450
        protected JViewport viewPort = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1451
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1452
        /*
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1453
         * Resets the viewport ChangeListener and PropertyChangeListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1454
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1455
        public void resetViewPort() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1456
            if (viewPort != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1457
                viewPort.removeChangeListener(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1458
                viewPort.removePropertyChangeListener(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1459
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1460
            viewPort = JScrollPane.this.getViewport();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1461
            if (viewPort != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1462
                viewPort.addChangeListener(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1463
                viewPort.addPropertyChangeListener(this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1464
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1465
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1466
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1467
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1468
         * AccessibleJScrollPane constructor
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1469
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1470
        public AccessibleJScrollPane() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1471
            super();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1472
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1473
            resetViewPort();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1474
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1475
            // initialize the AccessibleRelationSets for the JScrollPane
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1476
            // and JScrollBar(s)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1477
            JScrollBar scrollBar = getHorizontalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1478
            if (scrollBar != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1479
                setScrollBarRelations(scrollBar);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1480
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1481
            scrollBar = getVerticalScrollBar();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1482
            if (scrollBar != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1483
                setScrollBarRelations(scrollBar);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1484
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1485
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1486
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1487
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1488
         * Get the role of this object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1489
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1490
         * @return an instance of AccessibleRole describing the role of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1491
         * object
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1492
         * @see AccessibleRole
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1493
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1494
        public AccessibleRole getAccessibleRole() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1495
            return AccessibleRole.SCROLL_PANE;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1496
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1497
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1498
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1499
         * Invoked when the target of the listener has changed its state.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1500
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1501
         * @param e  a <code>ChangeEvent</code> object. Must not be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1502
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1503
         * @throws NullPointerException if the parameter is null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1504
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1505
        public void stateChanged(ChangeEvent e) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1506
            if (e == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1507
                throw new NullPointerException();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1508
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1509
            firePropertyChange(ACCESSIBLE_VISIBLE_DATA_PROPERTY,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1510
                               Boolean.valueOf(false),
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1511
                               Boolean.valueOf(true));
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1512
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1513
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1514
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1515
         * This method gets called when a bound property is changed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1516
         * @param e A <code>PropertyChangeEvent</code> object describing
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1517
         * the event source and the property that has changed. Must not be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1518
         *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1519
         * @throws NullPointerException if the parameter is null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1520
         * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1521
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1522
        public void propertyChange(PropertyChangeEvent e) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1523
            String propertyName = e.getPropertyName();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1524
            if (propertyName == "horizontalScrollBar" ||
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1525
                propertyName == "verticalScrollBar") {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1526
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1527
                if (e.getNewValue() instanceof JScrollBar) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1528
                    setScrollBarRelations((JScrollBar)e.getNewValue());
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1529
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1530
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1531
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1532
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1533
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1534
        /*
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1535
         * Sets the CONTROLLER_FOR and CONTROLLED_BY AccessibleRelations for
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1536
         * the JScrollPane and JScrollBar. JScrollBar must not be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1537
         */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1538
        void setScrollBarRelations(JScrollBar scrollBar) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1539
            /*
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1540
             * The JScrollBar is a CONTROLLER_FOR the JScrollPane.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1541
             * The JScrollPane is CONTROLLED_BY the JScrollBar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1542
             */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1543
            AccessibleRelation controlledBy =
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1544
                new AccessibleRelation(AccessibleRelation.CONTROLLED_BY,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1545
                                       scrollBar);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1546
            AccessibleRelation controllerFor =
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1547
                new AccessibleRelation(AccessibleRelation.CONTROLLER_FOR,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1548
                                       JScrollPane.this);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1549
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1550
            // set the relation set for the scroll bar
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1551
            AccessibleContext ac = scrollBar.getAccessibleContext();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1552
            ac.getAccessibleRelationSet().add(controllerFor);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1553
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1554
            // set the relation set for the scroll pane
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1555
            getAccessibleRelationSet().add(controlledBy);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1556
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1557
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1558
}