Laf-Widget client properties

View all client properties.


Client property name

LafWidget.AUTO_SCROLL

Description

Client property name for specifying that a scroll pane should have auto-scroll support invoked on middle-mouse button click. This property can be installed on a single scroll pane or globally on UIManager, and the value should be either Boolean.TRUE or Boolean.FALSE.


See also


Sample code

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.*;

import org.pushingpixels.lafwidget.LafWidget;
import org.pushingpixels.substance.api.SubstanceLookAndFeel;
import org.pushingpixels.substance.api.skin.BusinessBlackSteelSkin;

/**
 * Test application that shows the use of the {@link LafWidget#AUTO_SCROLL}
 * client property.
 
 @author Kirill Grouchnikov
 @see LafWidget#AUTO_SCROLL
 */
public class AutoScroll extends JFrame {
  /**
   * Creates the main frame for <code>this</code> sample.
   */
  public AutoScroll() {
    super("Auto scroll");

    this.setLayout(new BorderLayout());

    // Create panel with custom painting logic - simple
    // diagonal fill.
    JPanel samplePanel = new JPanel() {
      @Override
      protected void paintComponent(Graphics g) {
        Graphics2D graphics = (Graphics2Dg.create();
        graphics
            .setPaint(new GradientPaint(00new Color(100100,
                255), getWidth(), getHeight()new Color(255,
                100100)));
        graphics.fillRect(00, getWidth(), getHeight());
        graphics.dispose();
      }
    };
    samplePanel.setPreferredSize(new Dimension(800400));
    samplePanel.setSize(this.getPreferredSize());
    samplePanel.setMinimumSize(this.getPreferredSize());

    final JScrollPane scrollPane = new JScrollPane(samplePanel);
    this.add(scrollPane, BorderLayout.CENTER);

    JPanel controls = new JPanel(new FlowLayout(FlowLayout.RIGHT));
    final JCheckBox hasAutoScroll = new JCheckBox("has auto scroll");
    hasAutoScroll.addActionListener(new ActionListener() {
      public void actionPerformed(ActionEvent e) {
        SwingUtilities.invokeLater(new Runnable() {
          public void run() {
            scrollPane.putClientProperty(LafWidget.AUTO_SCROLL,
                hasAutoScroll.isSelected() ? Boolean.TRUE
                    null);
            repaint();
          }
        });
      }
    });
    controls.add(hasAutoScroll);
    this.add(controls, BorderLayout.SOUTH);

    this.setSize(400200);
    this.setLocationRelativeTo(null);
    this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  }

  /**
   * The main method for <code>this</code> sample. The arguments are
   * ignored.
   
   @param args
   *            Ignored.
   */
  public static void main(String[] args) {
    JFrame.setDefaultLookAndFeelDecorated(true);
    SwingUtilities.invokeLater(new Runnable() {
      public void run() {
        SubstanceLookAndFeel.setSkin(new BusinessBlackSteelSkin());
        new AutoScroll().setVisible(true);
      }
    });
  }
}

When this property is installed (select the checkbox), clicking the mouse middle button transfers the scroll pane to the auto-scroll mode.