jdk-sandbox: comparison jdk/src/share/classes/javax/swing/plaf/basic/BasicScrollPaneUI.java

equal deleted inserted replaced

-:c4a3548120c6
+:51d1f910f68d
 /*
-* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
+* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * @author Hans Muller
 */
 public class BasicScrollPaneUI
 extends ScrollPaneUI implements ScrollPaneConstants
 {
+/**
+* The instance of {@code JScrollPane}.
+*/
 protected JScrollPane scrollpane;
+/**
+* {@code ChangeListener} installed on the vertical scrollbar.
+*/
 protected ChangeListener vsbChangeListener;
+/**
+* {@code ChangeListener} installed on the horizontal scrollbar.
+*/
 protected ChangeListener hsbChangeListener;
+/**
+* {@code ChangeListener} installed on the viewport.
+*/
 protected ChangeListener viewportChangeListener;
+/**
+* {@code PropertyChangeListener} installed on the scroll pane.
+*/
 protected PropertyChangeListener spPropertyChangeListener;
 private MouseWheelListener mouseScrollListener;
 private int oldExtent = Integer.MIN_VALUE;
 /**
-* PropertyChangeListener installed on the vertical scrollbar.
+* {@code PropertyChangeListener} installed on the vertical scrollbar.
 */
 private PropertyChangeListener vsbPropertyChangeListener;
 /**
-* PropertyChangeListener installed on the horizontal scrollbar.
+* {@code PropertyChangeListener} installed on the horizontal scrollbar.
 */
 private PropertyChangeListener hsbPropertyChangeListener;
 private Handler handler;
 * before the value of "extent" was set in right-to-left component
 * orientation.
 */
 private boolean setValueCalled = false;
+/**
+* Returns a new instance of {@code BasicScrollPaneUI}.
+*
+* @param x a component.
+* @return a new instance of {@code BasicScrollPaneUI}
+*/
 public static ComponentUI createUI(JComponent x) {
 return new BasicScrollPaneUI();
 }
 static void loadActionMap(LazyActionMap map) {
 */
 public Dimension getMaximumSize(JComponent c) {
 return new Dimension(Short.MAX_VALUE, Short.MAX_VALUE);
 }
+/**
+* Installs default properties.
+*
+* @param scrollpane an instance of {@code JScrollPane}
+*/
 protected void installDefaults(JScrollPane scrollpane)
 {
 LookAndFeel.installBorder(scrollpane, "ScrollPane.border");
 LookAndFeel.installColorsAndFont(scrollpane,
 "ScrollPane.background",
 scrollpane.setViewportBorder(vpBorder);
 }
 LookAndFeel.installProperty(scrollpane, "opaque", Boolean.TRUE);
 }
+/**
+* Registers listeners.
+*
+* @param c an instance of {@code JScrollPane}
+*/
 protected void installListeners(JScrollPane c)
 {
 vsbChangeListener = createVSBChangeListener();
 vsbPropertyChangeListener = createVSBPropertyChangeListener();
 hsbChangeListener = createHSBChangeListener();
 mouseScrollListener = createMouseWheelListener();
 scrollpane.addMouseWheelListener(mouseScrollListener);
 }
+/**
+* Registers keyboard actions.
+*
+* @param c an instance of {@code JScrollPane}
+*/
 protected void installKeyboardActions(JScrollPane c) {
 InputMap inputMap = getInputMap(JComponent.
 WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
 SwingUtilities.replaceUIInputMap(c, JComponent.
 installDefaults(scrollpane);
 installListeners(scrollpane);
 installKeyboardActions(scrollpane);
 }
+/**
+* Uninstalls default properties.
+*
+* @param c an instance of {@code JScrollPane}
+*/
 protected void uninstallDefaults(JScrollPane c) {
 LookAndFeel.uninstallBorder(scrollpane);
 if (scrollpane.getViewportBorder() instanceof UIResource) {
 scrollpane.setViewportBorder(null);
 }
 }
+/**
+* Unregisters listeners.
+*
+* @param c a component
+*/
 protected void uninstallListeners(JComponent c) {
 JViewport viewport = scrollpane.getViewport();
 JScrollBar vsb = scrollpane.getVerticalScrollBar();
 JScrollBar hsb = scrollpane.getHorizontalScrollBar();
 spPropertyChangeListener = null;
 mouseScrollListener = null;
 handler = null;
 }
+/**
+* Unregisters keyboard actions.
+*
+* @param c an instance of {@code JScrollPane}
+*/
 protected void uninstallKeyboardActions(JScrollPane c) {
 SwingUtilities.replaceUIActionMap(c, null);
 SwingUtilities.replaceUIInputMap(c, JComponent.
 WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, null);
 }
 handler = new Handler();
 }
 return handler;
 }
+/**
+* Synchronizes the {@code JScrollPane} with {@code Viewport}.
+*/
 protected void syncScrollPaneWithViewport()
 {
 JViewport viewport = scrollpane.getViewport();
 JScrollBar vsb = scrollpane.getVerticalScrollBar();
 JScrollBar hsb = scrollpane.getHorizontalScrollBar();
 public void stateChanged(ChangeEvent e) {
 getHandler().stateChanged(e);
 }
 }
+/**
+* Returns an instance of viewport {@code ChangeListener}.
+*
+* @return an instance of viewport {@code ChangeListener}
+*/
 protected ChangeListener createViewportChangeListener() {
 return getHandler();
 }
 */
 private PropertyChangeListener createHSBPropertyChangeListener() {
 return getHandler();
 }
+/**
+* Returns an instance of horizontal scroll bar {@code ChangeListener}.
+*
+* @return an instance of horizontal scroll bar {@code ChangeListener}
+*/
 protected ChangeListener createHSBChangeListener() {
 return getHandler();
 }
 */
 private PropertyChangeListener createVSBPropertyChangeListener() {
 return getHandler();
 }
+/**
+* Returns an instance of vertical scroll bar {@code ChangeListener}.
+*
+* @return an instance of vertical scroll bar {@code ChangeListener}
+*/
 protected ChangeListener createVSBChangeListener() {
 return getHandler();
 }
 /**
 */
 protected MouseWheelListener createMouseWheelListener() {
 return getHandler();
 }
+/**
+* Updates a scroll bar display policy.
+*
+* @param e the property change event
+*/
 protected void updateScrollBarDisplayPolicy(PropertyChangeEvent e) {
 scrollpane.revalidate();
 scrollpane.repaint();
 }
+/**
+* Updates viewport.
+*
+* @param e the property change event
+*/
 protected void updateViewport(PropertyChangeEvent e)
 {
 JViewport oldViewport = (JViewport)(e.getOldValue());
 JViewport newViewport = (JViewport)(e.getNewValue());
 newViewport.setViewPosition(p);
 newViewport.addChangeListener(viewportChangeListener);
 }
 }
+/**
+* Updates row header.
+*
+* @param e the property change event
+*/
 protected void updateRowHeader(PropertyChangeEvent e)
 {
 JViewport newRowHead = (JViewport)(e.getNewValue());
 if (newRowHead != null) {
 JViewport viewport = scrollpane.getViewport();
 p.y = (viewport != null) ? viewport.getViewPosition().y : 0;
 newRowHead.setViewPosition(p);
 }
 }
+/**
+* Updates column header.
+*
+* @param e the property change event
+*/
 protected void updateColumnHeader(PropertyChangeEvent e)
 {
 JViewport newColHead = (JViewport)(e.getNewValue());
 if (newColHead != null) {
 JViewport viewport = scrollpane.getViewport();
 }
 /**
-* Creates an instance of PropertyChangeListener that's added to
+* Creates an instance of {@code PropertyChangeListener} that's added to
-* the JScrollPane by installUI().  Subclasses can override this method
+* the {@code JScrollPane} by {@code installUI()}. Subclasses can override
-* to return a custom PropertyChangeListener, e.g.
+* this method to return a custom {@code PropertyChangeListener}, e.g.
 * <pre>
 * class MyScrollPaneUI extends BasicScrollPaneUI {
 *    protected PropertyChangeListener <b>createPropertyChangeListener</b>() {
 *        return new MyPropertyChangeListener();
 *    }
 *            super.propertyChange(e);
 *        }
 *    }
 * }
 * </pre>
+*
+* @return an instance of {@code PropertyChangeListener}
 *
 * @see java.beans.PropertyChangeListener
 * @see #installUI
 */
 protected PropertyChangeListener createPropertyChangeListener() {

changeset 25763	51d1f910f68d
parent 23010	6dadb192ad81