| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class ScrollPaneLayout extends Object implements LayoutManager, ScrollPaneConstants, Serializable
The layout manager used by JScrollPane
.
JScrollPaneLayout
is
responsible for nine components: a viewport, two scrollbars,
a row header, a column header, and four "corner" components.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans
package.
Please see {@link java.beans.XMLEncoder}.
Nested Class Summary | |
---|---|
static class |
The UI resource version of ScrollPaneLayout . |
Field Summary | |
---|---|
protected JViewport |
colHead
The column header child. |
protected JScrollBar |
hsb
The scrollpane's horizontal scrollbar child. |
protected int |
hsbPolicy
The display policy for the horizontal scrollbar. |
protected Component |
lowerLeft
The component to display in the lower left corner. |
protected Component |
lowerRight
The component to display in the lower right corner. |
protected JViewport |
rowHead
The row header child. |
protected Component |
upperLeft
The component to display in the upper left corner. |
protected Component |
upperRight
The component to display in the upper right corner. |
protected JViewport |
viewport
The scrollpane's viewport child. |
protected JScrollBar |
vsb
The scrollpane's vertical scrollbar child. |
protected int |
vsbPolicy
The display policy for the vertical scrollbar. |
Constructor Summary | |
---|---|
|
Method Summary | |
---|---|
void |
Adds the specified component to the layout. |
protected Component |
addSingletonComponent(Component oldC, Component newC) Removes an existing component. |
JViewport |
Returns the JViewport object that is the column header.
|
Component |
Returns the Component at the specified corner.
|
JScrollBar |
Returns the JScrollBar object that handles horizontal scrolling.
|
int |
Returns the horizontal scrollbar-display policy. |
JViewport |
Returns the JViewport object that is the row header.
|
JScrollBar |
Returns the JScrollBar object that handles vertical scrolling.
|
int |
Returns the vertical scrollbar-display policy. |
JViewport |
Returns the JViewport object that displays the
scrollable contents.
|
Rectangle |
getViewportBorderBounds(JScrollPane scrollpane) Returns the bounds of the border around the specified scroll pane's viewport. |
void |
layoutContainer(Container parent) Lays out the scrollpane. |
Dimension |
minimumLayoutSize(Container parent) The minimum size of a ScrollPane is the size of the insets
plus minimum size of the viewport, plus the scrollpane's
viewportBorder insets, plus the minimum size
of the visible headers, plus the minimum size of the
scrollbars whose displayPolicy isn't NEVER.
|
Dimension |
preferredLayoutSize(Container parent) The preferred size of a ScrollPane is the size of the insets,
plus the preferred size of the viewport, plus the preferred size of
the visible headers, plus the preferred size of the scrollbars
that will appear given the current view and the current
scrollbar displayPolicies.
|
void |
Removes the specified component from the layout. |
void |
setHorizontalScrollBarPolicy(int x) Sets the horizontal scrollbar-display policy. |
void |
setVerticalScrollBarPolicy(int x) Sets the vertical scrollbar-display policy. |
void |
This method is invoked after the ScrollPaneLayout is set as the LayoutManager of a JScrollPane .
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected JViewport colHead
null
.
protected JScrollBar hsb
JScrollBar
.
protected int hsbPolicy
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
.
This field is obsolete, please use the JScrollPane
field instead.
protected Component lowerLeft
null
.
protected Component lowerRight
null
.
protected JViewport rowHead
null
.
protected Component upperLeft
null
.
protected Component upperRight
null
.
protected JViewport viewport
JViewport
.
protected JScrollBar vsb
JScrollBar
.
protected int vsbPolicy
ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
.
This field is obsolete, please use the JScrollPane
field instead.
Constructor Detail |
---|
public ScrollPaneLayout()
Method Detail |
---|
public void addLayoutComponent(String s, Component c)
s
- the component identifierc
- the the component to be addedprotected Component addSingletonComponent(Component oldC, Component newC)
This method returns newC
. If oldC
is
not equal to newC
and is non-null
,
it will be removed from its parent.
oldC
- the Component
to replacenewC
- the Component
to addnewC
public JViewport getColumnHeader()
JViewport
object that is the column header.
JViewport
object that is the column headerpublic Component getCorner(String key)
Component
at the specified corner.
key
- the String
specifying the cornerComponent
at the specified corner, as defined in
{@link ScrollPaneConstants}; if key
is not one of the
four corners, null
is returnedpublic JScrollBar getHorizontalScrollBar()
JScrollBar
object that handles horizontal scrolling.
JScrollBar
object that handles horizontal scrollingpublic int getHorizontalScrollBarPolicy()
public JViewport getRowHeader()
JViewport
object that is the row header.
JViewport
object that is the row headerpublic JScrollBar getVerticalScrollBar()
JScrollBar
object that handles vertical scrolling.
JScrollBar
object that handles vertical scrollingpublic int getVerticalScrollBarPolicy()
public JViewport getViewport()
JViewport
object that displays the
scrollable contents.
JViewport
object that displays the scrollable contentspublic Rectangle getViewportBorderBounds(JScrollPane scrollpane)
scrollpane
public void layoutContainer(Container parent)
displayPolicy
is ALWAYS, it's treated like the row header with respect to its
dimensions and is made visible.
null
viewportBorder
, then space is allocated for that.
parent
- the Container
to lay outpublic Dimension minimumLayoutSize(Container parent)
ScrollPane
is the size of the insets
plus minimum size of the viewport, plus the scrollpane's
viewportBorder insets, plus the minimum size
of the visible headers, plus the minimum size of the
scrollbars whose displayPolicy isn't NEVER.
parent
- the Container
that will be laid outDimension
object specifying the minimum sizepublic Dimension preferredLayoutSize(Container parent)
ScrollPane
is the size of the insets,
plus the preferred size of the viewport, plus the preferred size of
the visible headers, plus the preferred size of the scrollbars
that will appear given the current view and the current
scrollbar displayPolicies.
Note that the rowHeader is calculated as part of the preferred width and the colHeader is calculated as part of the preferred size.
parent
- the Container
that will be laid outDimension
object specifying the preferred size of the
viewport and any scrollbarspublic void removeLayoutComponent(Component c)
c
- the component to removepublic void setHorizontalScrollBarPolicy(int x)
JScrollPane
version
of this method. It only exists for backwards compatibility
with the Swing 1.0.2 (and earlier) versions of this class.
x
- an int giving the display policypublic void setVerticalScrollBarPolicy(int x)
JScrollPane
version
of this method. It only exists for backwards compatibility
with the Swing 1.0.2 (and earlier) versions of this class.
x
- an integer giving the display policypublic void syncWithScrollPane(JScrollPane sp)
JScrollPane
.
It initializes all of the internal fields that
are ordinarily set by addLayoutComponent
. For example:
ScrollPaneLayout mySPLayout = new ScrollPanelLayout() { public void layoutContainer(Container p) { super.layoutContainer(p); // do some extra work here ... } }; scrollpane.setLayout(mySPLayout):
sp
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |