Substance client properties

Client property name

Description

Client property name for specifying scroll pane button policy. This property can be set on either a specific JScrollPane or globally on UIManager. The value should be one of the SubstanceConstants.ScrollPaneButtonPolicyKind enum.

See also

Sample code

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

import javax.swing.*;

import org.pushingpixels.substance.api.SubstanceLookAndFeel;
import org.pushingpixels.substance.api.SubstanceConstants.ScrollPaneButtonPolicyKind;
import org.pushingpixels.substance.api.skin.BusinessBlackSteelSkin;

/**
 * Test application that shows the use of the
 * {@link SubstanceLookAndFeel#SCROLL_PANE_BUTTONS_POLICY} client property.
 * 
 * @author Kirill Grouchnikov
 * @see SubstanceLookAndFeel#SCROLL_PANE_BUTTONS_POLICY
 */
public class ScrollPaneButtonsPolicy extends JFrame {
  /**
   * Creates the main frame for <code>this</code> sample.
   */
  public ScrollPaneButtonsPolicy() {
    super("Scroll pane buttons policy");

    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 = (Graphics2D) g.create();
        graphics
            .setPaint(new GradientPaint(0, 0, new Color(100, 100,
                255), getWidth(), getHeight(), new Color(255,
                100, 100)));
        graphics.fillRect(0, 0, getWidth(), getHeight());
        graphics.dispose();
      }
    };
    samplePanel.setPreferredSize(new Dimension(800, 250));
    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 JComboBox buttonsPolicyCombo = new JComboBox(new Object[] {
        ScrollPaneButtonPolicyKind.NONE,
        ScrollPaneButtonPolicyKind.OPPOSITE,
        ScrollPaneButtonPolicyKind.ADJACENT,
        ScrollPaneButtonPolicyKind.MULTIPLE,
        ScrollPaneButtonPolicyKind.MULTIPLE_BOTH });
    buttonsPolicyCombo.setSelectedItem(ScrollPaneButtonPolicyKind.OPPOSITE);
    buttonsPolicyCombo.addActionListener(new ActionListener() {
      public void actionPerformed(ActionEvent e) {
        // set the selected button policy kind on the scroll pane
        ScrollPaneButtonPolicyKind buttonPolicy = (ScrollPaneButtonPolicyKind) buttonsPolicyCombo
            .getSelectedItem();
        scrollPane.putClientProperty(
            SubstanceLookAndFeel.SCROLL_PANE_BUTTONS_POLICY,
            buttonPolicy);
        scrollPane.repaint();
      }
    });

    controls.add(new JLabel("Buttons policy"));
    controls.add(buttonsPolicyCombo);
    this.add(controls, BorderLayout.SOUTH);

    this.setSize(400, 200);
    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 ScrollPaneButtonsPolicy().setVisible(true);
      }
    });
  }
}

The screenshot below shows scroll pane with default button policy (this property is not installed):

The screenshot below shows scroll pane with SubstanceConstants.ScrollPaneButtonPolicyKind.MULTIPLE button policy installed: