com.alee.laf.scroll.layout

Class ScrollPaneLayout

java.lang.Object

javax.swing.ScrollPaneLayout

com.alee.laf.scroll.layout.ScrollPaneLayout

All Implemented Interfaces:

Mergeable, LayoutManager, Serializable, Cloneable, ScrollPaneConstants

Direct Known Subclasses:

ScrollPaneLayout.UIResource

public class ScrollPaneLayout
extends ScrollPaneLayout
implements Mergeable, Cloneable

Replacement for default Swing ScrollPaneLayout used within JScrollPane to layout components. It allows deeper customization of scroll bar placement and a few enhancements to default calculations. Note: The only reason why this layout is based on ScrollPaneLayout is because JScrollPane.setLayout(LayoutManager) method accepts only ScrollPaneLayout-based layouts and nothing else. Unfortunately there is no good workaround so it have been used as a base for this layout for the time being. All unserializable fields have been forcefully emptied and omitted for XStream in StyleManager.

Author:

Mikle Garin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScrollPaneLayout.UIResource The UI resource version of ScrollPaneLayout.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ScrollBarSettings	DEFAULT_SCROLL_BAR_SETTINGS Default ScrollBarSettings for vertical and horizontal scroll bars.
protected ScrollBarSettings	hpos ScrollBarSettings for horizontal scroll bar.
protected ScrollBarSettings	vpos ScrollBarSettings for vertical scroll bar.

Fields inherited from class javax.swing.ScrollPaneLayout

colHead, hsb, hsbPolicy, lowerLeft, lowerRight, rowHead, upperLeft, upperRight, viewport, vsb, vsbPolicy

Fields inherited from interface javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Constructor Summary

Constructors

Constructor and Description
ScrollPaneLayout()

Method Summary

Modifier and Type	Method and Description
void	addLayoutComponent(String s, Component c)
protected void	adjustForHSB(JScrollBar hsb, boolean needed, Rectangle view, Rectangle scroll, Insets viewInsets) Adjusts the Rectangle available based on if the horizontal scrollbar is needed (wantsHSB).
protected void	adjustForVSB(JScrollBar vsb, boolean needed, Rectangle view, Rectangle scroll, Insets viewInsets, boolean leftToRight) Adjusts the Rectangle available based on if the vertical scrollbar is needed (wantsVSB).
ScrollBarSettings	getHorizontalScrollBarPosition() Returns ScrollBarSettings for horizontal scroll bar.
ScrollBarSettings	getVerticalScrollBarPosition() Returns ScrollBarSettings for vertical scroll bar.
void	layoutContainer(Container container)
Dimension	minimumLayoutSize(Container container) The minimum size of a JScrollPane 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 ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER or ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER.
Dimension	preferredLayoutSize(Container container)
void	removeLayoutComponent(Component c)
void	setHorizontalScrollBarPosition(ScrollBarSettings position) Sets ScrollBarSettings for horizontal scroll bar.
void	setVerticalScrollBarPosition(ScrollBarSettings position) Sets ScrollBarSettings for vertical scroll bar.
void	syncWithScrollPane(JScrollPane scrollPane)

Methods inherited from class javax.swing.ScrollPaneLayout

addSingletonComponent, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorderBounds, setHorizontalScrollBarPolicy, setVerticalScrollBarPolicy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SCROLL_BAR_SETTINGS

protected static final ScrollBarSettings DEFAULT_SCROLL_BAR_SETTINGS

Default ScrollBarSettings for vertical and horizontal scroll bars.

vpos

protected ScrollBarSettings vpos

ScrollBarSettings for vertical scroll bar. These settings must always be specified otherwise you will have NullPointerException.

hpos

protected ScrollBarSettings hpos

ScrollBarSettings for horizontal scroll bar. These settings must always be specified otherwise you will have NullPointerException.

Constructor Detail

ScrollPaneLayout

public ScrollPaneLayout()

Method Detail

getVerticalScrollBarPosition

public ScrollBarSettings getVerticalScrollBarPosition()

Returns ScrollBarSettings for vertical scroll bar.

Returns:

ScrollBarSettings for vertical scroll bar

setVerticalScrollBarPosition

public void setVerticalScrollBarPosition(ScrollBarSettings position)

Sets ScrollBarSettings for vertical scroll bar.

Parameters:

position - ScrollBarSettings for vertical scroll bar

getHorizontalScrollBarPosition

public ScrollBarSettings getHorizontalScrollBarPosition()

Returns ScrollBarSettings for horizontal scroll bar.

Returns:

ScrollBarSettings for horizontal scroll bar

setHorizontalScrollBarPosition

public void setHorizontalScrollBarPosition(ScrollBarSettings position)

Sets ScrollBarSettings for horizontal scroll bar.

Parameters:

position - ScrollBarSettings for horizontal scroll bar

addLayoutComponent

public void addLayoutComponent(String s,
                               Component c)

Specified by:

addLayoutComponent in interface LayoutManager

Overrides:

addLayoutComponent in class ScrollPaneLayout

removeLayoutComponent

public void removeLayoutComponent(Component c)

Specified by:

removeLayoutComponent in interface LayoutManager

Overrides:

removeLayoutComponent in class ScrollPaneLayout

syncWithScrollPane

public void syncWithScrollPane(JScrollPane scrollPane)

Overrides:

syncWithScrollPane in class ScrollPaneLayout

layoutContainer

public void layoutContainer(Container container)

Specified by:

layoutContainer in interface LayoutManager

Overrides:

layoutContainer in class ScrollPaneLayout

adjustForVSB

protected void adjustForVSB(JScrollBar vsb,
                            boolean needed,
                            Rectangle view,
                            Rectangle scroll,
                            Insets viewInsets,
                            boolean leftToRight)

Adjusts the Rectangle available based on if the vertical scrollbar is needed (wantsVSB). The location of the vsb is updated in vsbR, and the viewport border insets (vpbInsets) are used to offset the vsb. This is only called when wantsVSB has changed, eg you shouldn't invoke adjustForVSB(true) twice.

Parameters:

vsb - vertical scroll bar

needed - whether or not vertical scroll bar is needed

view - space available for view

scroll - vertical scroll bar bounds

viewInsets - viewport border insets

leftToRight - component orientation

adjustForHSB

protected void adjustForHSB(JScrollBar hsb,
                            boolean needed,
                            Rectangle view,
                            Rectangle scroll,
                            Insets viewInsets)

Adjusts the Rectangle available based on if the horizontal scrollbar is needed (wantsHSB). The location of the hsb is updated in hsbR, and the viewport border insets (vpbInsets) are used to offset the hsb. This is only called when wantsHSB has changed, eg you shouldn't invoked adjustForHSB(true) twice.

Parameters:

hsb - horizontal scroll bar

needed - whether or not horizontal scroll bar is needed

view - space available for view

scroll - horizontal scroll bar bounds

viewInsets - viewport border insets

preferredLayoutSize

public Dimension preferredLayoutSize(Container container)

Specified by:

preferredLayoutSize in interface LayoutManager

Overrides:

preferredLayoutSize in class ScrollPaneLayout

minimumLayoutSize

public Dimension minimumLayoutSize(Container container)

The minimum size of a JScrollPane 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 ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER or ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER.

Specified by:

minimumLayoutSize in interface LayoutManager

Overrides:

minimumLayoutSize in class ScrollPaneLayout

Parameters:

container - the Container that will be laid out

Returns:

a Dimension object specifying the minimum size