com.alee.laf.scroll.WebScrollPaneBar Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
package com.alee.laf.scroll;

import com.alee.api.annotations.NotNull;

import javax.swing.*;
import javax.swing.plaf.UIResource;
import java.awt.*;
import java.lang.ref.WeakReference;

/**
 * By default {@code WebScrollPane} creates scrollbars that are instances of this class. {@code WebScrollPaneBar} overrides the
 * {@code getUnitIncrement} and {@code getBlockIncrement} methods so that, if the viewport's view is a {@code Scrollable}, the view is
 * asked to compute these values. Unless the unit/block increment have been explicitly set.
 *
 * @author Mikle Garin
 * @see javax.swing.Scrollable
 * @see com.alee.laf.scroll.WebScrollPane#createVerticalScrollBar
 * @see com.alee.laf.scroll.WebScrollPane#createHorizontalScrollBar
 */
public class WebScrollPaneBar extends WebScrollBar implements UIResource
{
    /**
     * Enclosing scroll pane reference.
     */
    @NotNull
    private final transient WeakReference scrollPane;

    /**
     * Set to true when the unit increment has been explicitly set.
     * If this is false the viewport's view is obtained and if it is an instance of {@code Scrollable} the unit increment from it is used.
     */
    private boolean unitIncrementSet;

    /**
     * Set to true when the block increment has been explicitly set.
     * If this is false the viewport's view is obtained and if it is an instance of {@code Scrollable} the block increment from it is used.
     */
    private boolean blockIncrementSet;

    /**
     * Creates a scrollbar with the specified orientation.
     * The options are:
     * 
     * {@code ScrollPaneConstants.VERTICAL}
     * 
{@code ScrollPaneConstants.HORIZONTAL}
     * 
     *
     * @param scrollPane  scrollpane this bar will be attached to
     * @param orientation an integer specifying one of the legal orientation values shown above
     */
    public WebScrollPaneBar ( @NotNull final JScrollPane scrollPane, final int orientation )
    {
        super ( orientation );
        this.scrollPane = new WeakReference ( scrollPane );
        putClientProperty ( "JScrollBar.fastWheelScrolling", Boolean.TRUE );
    }

    /**
     * Returns {@link JScrollPane} that uses this {@link WebScrollPaneBar}.
     *
     * @return {@link JScrollPane} that uses this {@link WebScrollPaneBar}
     */
    @NotNull
    protected JScrollPane getScrollPane ()
    {
        final JScrollPane scrollPane = this.scrollPane.get ();
        if ( scrollPane == null )
        {
            throw new RuntimeException ( "JScrollPane is not available anymore" );
        }
        return scrollPane;
    }

    /**
     * Messages super to set the value, and resets the {@code unitIncrementSet} instance variable to true.
     *
     * @param unitIncrement the new unit increment value, in pixels
     */
    @Override
    public void setUnitIncrement ( final int unitIncrement )
    {
        unitIncrementSet = true;
        this.putClientProperty ( "JScrollBar.fastWheelScrolling", null );
        super.setUnitIncrement ( unitIncrement );
    }

    /**
     * Computes the unit increment for scrolling if the viewport's view is a {@code Scrollable} object.
     * Otherwise return {@code super.getUnitIncrement}.
     *
     * @param direction less than zero to scroll up/left, greater than zero for down/right
     * @return an integer, in pixels, containing the unit increment
     * @see javax.swing.Scrollable#getScrollableUnitIncrement
     */
    @Override
    public int getUnitIncrement ( final int direction )
    {
        final int unitIncrement;
        final JViewport vp = getScrollPane ().getViewport ();
        if ( !unitIncrementSet && vp != null && vp.getView () instanceof Scrollable )
        {
            final Scrollable view = ( Scrollable ) vp.getView ();
            final Rectangle vr = vp.getViewRect ();
            unitIncrement = view.getScrollableUnitIncrement ( vr, getOrientation (), direction );
        }
        else
        {
            unitIncrement = super.getUnitIncrement ( direction );
        }
        return unitIncrement;
    }

    /**
     * Messages super to set the value, and resets the {@code blockIncrementSet} instance variable to true.
     *
     * @param blockIncrement the new block increment value, in pixels
     */
    @Override
    public void setBlockIncrement ( final int blockIncrement )
    {
        blockIncrementSet = true;
        this.putClientProperty ( "JScrollBar.fastWheelScrolling", null );
        super.setBlockIncrement ( blockIncrement );
    }

    /**
     * Computes the block increment for scrolling if the viewport's view is a {@code Scrollable} object.
     * Otherwise the {@code blockIncrement} equals the viewport's width or height.
     * If there's no viewport return {@code super.getBlockIncrement}.
     *
     * @param direction less than zero to scroll up/left, greater than zero for down/right
     * @return an integer, in pixels, containing the block increment
     * @see javax.swing.Scrollable#getScrollableBlockIncrement
     */
    @Override
    public int getBlockIncrement ( final int direction )
    {
        final int blockIncrement;
        final JViewport vp = getScrollPane ().getViewport ();
        if ( blockIncrementSet || vp == null )
        {
            blockIncrement = super.getBlockIncrement ( direction );
        }
        else if ( vp.getView () instanceof Scrollable )
        {
            final Scrollable view = ( Scrollable ) vp.getView ();
            final Rectangle vr = vp.getViewRect ();
            blockIncrement = view.getScrollableBlockIncrement ( vr, getOrientation (), direction );
        }
        else if ( getOrientation () == VERTICAL )
        {
            blockIncrement = vp.getExtentSize ().height;
        }
        else
        {
            blockIncrement = vp.getExtentSize ().width;
        }
        return blockIncrement;
    }
}