OpenJDK 27 · javax.swing.Scrollable · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Dimension	Returns: the preferredSize of a `JViewport` whose view is this `Scrollable` getPreferredScrollableViewportSize() Returns the preferred size of the viewport for a view component.
public int	Returns: The "block" increment for scrolling in the specified direction. This value should always be positive. getScrollableBlockIncrement(Rectangle The view area visible within the viewport visibleRect, int Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. orientation, int Less than zero to scroll up/left, greater than zero for down/right. direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation.
public boolean	Returns: True if a viewport should force the Scrollables height to match its own. getScrollableTracksViewportHeight() Return true if a viewport should always force the height of this Scrollable to match the height of the viewport.
public boolean	Returns: True if a viewport should force the Scrollables width to match its own. getScrollableTracksViewportWidth() Return true if a viewport should always force the width of this `Scrollable` to match the width of the viewport.
public int	Returns: The "unit" increment for scrolling in the specified direction. This value should always be positive. getScrollableUnitIncrement(Rectangle The view area visible within the viewport visibleRect, int Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. orientation, int Less than zero to scroll up/left, greater than zero for down/right. direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation.

Method Detail

getPreferredScrollableViewportSize back to summary

getPreferredScrollableViewportSize	back to summary
public Dimension getPreferredScrollableViewportSize() Returns the preferred size of the viewport for a view component. For example, the preferred size of a `JList` component is the size required to accommodate all of the cells in its list. However, the value of `preferredScrollableViewportSize` is the size required for `JList.getVisibleRowCount` rows. A component without any properties that would affect the viewport size should just return `getPreferredSize` here. Returns:Dimension the preferredSize of a `JViewport` whose view is this `Scrollable` See Also `JViewport#getPreferredSize`

public Dimension getPreferredScrollableViewportSize()

Returns the preferred size of the viewport for a view component. For example, the preferred size of a JList component is the size required to accommodate all of the cells in its list. However, the value of preferredScrollableViewportSize is the size required for JList.getVisibleRowCount rows. A component without any properties that would affect the viewport size should just return getPreferredSize here.

Returns:Dimension: the preferredSize of a JViewport whose view is this Scrollable
See Also: JViewport#getPreferredSize

getScrollableBlockIncrement back to summary

getScrollableBlockIncrement	back to summary
public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation. Scrolling containers, like JScrollPane, will use this method each time the user requests a block scroll. Parameters visibleRect:Rectangle The view area visible within the viewport orientation:int Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. direction:int Less than zero to scroll up/left, greater than zero for down/right. Returns:int The "block" increment for scrolling in the specified direction. This value should always be positive. See Also `JScrollBar#setBlockIncrement`

public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)

Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation.

Scrolling containers, like JScrollPane, will use this method each time the user requests a block scroll.

Parameters

visibleRect:Rectangle: The view area visible within the viewport
orientation:int: Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.
direction:int: Less than zero to scroll up/left, greater than zero for down/right.

Returns:int

The "block" increment for scrolling in the specified direction. This value should always be positive.

See Also

JScrollBar#setBlockIncrement

getScrollableTracksViewportHeight	back to summary
public boolean getScrollableTracksViewportHeight() Return true if a viewport should always force the height of this Scrollable to match the height of the viewport. For example a columnar text view that flowed text in left to right columns could effectively disable vertical scrolling by returning true here. Scrolling containers, like JViewport, will use this method each time they are validated. Returns:boolean True if a viewport should force the Scrollables height to match its own.

getScrollableTracksViewportHeight

back to summary

public boolean getScrollableTracksViewportHeight()

Return true if a viewport should always force the height of this Scrollable to match the height of the viewport. For example a columnar text view that flowed text in left to right columns could effectively disable vertical scrolling by returning true here.

Scrolling containers, like JViewport, will use this method each time they are validated.

Returns:boolean: True if a viewport should force the Scrollables height to match its own.

getScrollableTracksViewportWidth back to summary

getScrollableTracksViewportWidth	back to summary
public boolean getScrollableTracksViewportWidth() Return true if a viewport should always force the width of this `Scrollable` to match the width of the viewport. For example a normal text view that supported line wrapping would return true here, since it would be undesirable for wrapped lines to disappear beyond the right edge of the viewport. Note that returning true for a Scrollable whose ancestor is a JScrollPane effectively disables horizontal scrolling. Scrolling containers, like JViewport, will use this method each time they are validated. Returns:boolean True if a viewport should force the Scrollables width to match its own.

public boolean getScrollableTracksViewportWidth()

Return true if a viewport should always force the width of this Scrollable to match the width of the viewport. For example a normal text view that supported line wrapping would return true here, since it would be undesirable for wrapped lines to disappear beyond the right edge of the viewport. Note that returning true for a Scrollable whose ancestor is a JScrollPane effectively disables horizontal scrolling.

Scrolling containers, like JViewport, will use this method each time they are validated.

Returns:boolean: True if a viewport should force the Scrollables width to match its own.

getScrollableUnitIncrement back to summary

getScrollableUnitIncrement	back to summary
public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation. Ideally, components should handle a partially exposed row or column by returning the distance required to completely expose the item. Scrolling containers, like JScrollPane, will use this method each time the user requests a unit scroll. Parameters visibleRect:Rectangle The view area visible within the viewport orientation:int Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL. direction:int Less than zero to scroll up/left, greater than zero for down/right. Returns:int The "unit" increment for scrolling in the specified direction. This value should always be positive. See Also `JScrollBar#setUnitIncrement`

public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)

Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation. Ideally, components should handle a partially exposed row or column by returning the distance required to completely expose the item.

Scrolling containers, like JScrollPane, will use this method each time the user requests a unit scroll.

Parameters

visibleRect:Rectangle: The view area visible within the viewport
orientation:int: Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.
direction:int: Less than zero to scroll up/left, greater than zero for down/right.

Returns:int

The "unit" increment for scrolling in the specified direction. This value should always be positive.

See Also

JScrollBar#setUnitIncrement

public Interface Scrollable

Method Summary

Method Detail