jdk/src/share/classes/javax/swing/Scrollable.java
author malenkov
Wed, 30 Apr 2014 19:28:05 +0400
changeset 24544 c0133e7c7162
parent 5506 202f599c92aa
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
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1997, 2003, 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: 2
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: 2
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: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
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 java.awt.Dimension;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.awt.Rectangle;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * An interface that provides information to a scrolling container
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * like JScrollPane.  A complex component that's likely to be used
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * as a viewing a JScrollPane viewport (or other scrolling container)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * should implement this interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * @see JViewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @see JScrollPane
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @see JScrollBar
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * @author Hans Muller
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
public interface Scrollable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
{
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     * Returns the preferred size of the viewport for a view component.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     * For example, the preferred size of a <code>JList</code> component
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * is the size required to accommodate all of the cells in its list.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * However, the value of <code>preferredScrollableViewportSize</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * is the size required for <code>JList.getVisibleRowCount</code> rows.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * A component without any properties that would affect the viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * size should just return <code>getPreferredSize</code> here.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * @return the preferredSize of a <code>JViewport</code> whose view
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     *    is this <code>Scrollable</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * @see JViewport#getPreferredSize
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    Dimension getPreferredScrollableViewportSize();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * Components that display logical rows or columns should compute
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * the scroll increment that will completely expose one new row
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * or column, depending on the value of orientation.  Ideally,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * components should handle a partially exposed row or column by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * returning the distance required to completely expose the item.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * Scrolling containers, like JScrollPane, will use this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * each time the user requests a unit scroll.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * @param visibleRect The view area visible within the viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * @param orientation Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * @param direction Less than zero to scroll up/left, greater than zero for down/right.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * @return The "unit" increment for scrolling in the specified direction.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     *         This value should always be positive.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * @see JScrollBar#setUnitIncrement
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * Components that display logical rows or columns should compute
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * the scroll increment that will completely expose one block
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * of rows or columns, depending on the value of orientation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * Scrolling containers, like JScrollPane, will use this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * each time the user requests a block scroll.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     * @param visibleRect The view area visible within the viewport
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * @param orientation Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * @param direction Less than zero to scroll up/left, greater than zero for down/right.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * @return The "block" increment for scrolling in the specified direction.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     *         This value should always be positive.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * @see JScrollBar#setBlockIncrement
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     * Return true if a viewport should always force the width of this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * <code>Scrollable</code> to match the width of the viewport.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     * For example a normal
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * text view that supported line wrapping would return true here, since it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * would be undesirable for wrapped lines to disappear beyond the right
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * edge of the viewport.  Note that returning true for a Scrollable
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * whose ancestor is a JScrollPane effectively disables horizontal
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * scrolling.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * Scrolling containers, like JViewport, will use this method each
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * time they are validated.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     * @return True if a viewport should force the Scrollables width to match its own.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
    boolean getScrollableTracksViewportWidth();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     * Return true if a viewport should always force the height of this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     * Scrollable to match the height of the viewport.  For example a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * columnar text view that flowed text in left to right columns
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * could effectively disable vertical scrolling by returning
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * true here.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     * Scrolling containers, like JViewport, will use this method each
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     * time they are validated.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
     * @return True if a viewport should force the Scrollables height to match its own.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
    boolean getScrollableTracksViewportHeight();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
}