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

equal deleted inserted replaced

-:6333e4aa8a70
+:88051e6ecdc7
 /*
-* 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
 // is for the text over the unfilled progress bar area.
 private Color selectionForeground, selectionBackground;
 private Animator animator;
+/**
+* The instance of {@code JProgressBar}.
+*/
 protected JProgressBar progressBar;
+/**
+* The instance of {@code ChangeListener}.
+*/
 protected ChangeListener changeListener;
 private Handler handler;
 /**
 * The current state of the indeterminate animation's cycle.
 /** For bouncing-box animation, the change in position per frame. */
 private double delta = 0.0;
 private int maxPosition = 0; //maximum X (horiz) or Y box location
+/**
+* Returns a new instance of {@code BasicProgressBarUI}.
+*
+* @param x a component
+* @return a new instance of {@code BasicProgressBarUI}
+*/
 public static ComponentUI createUI(JComponent x) {
 return new BasicProgressBarUI();
 }
 public void installUI(JComponent c) {
 uninstallDefaults();
 uninstallListeners();
 progressBar = null;
 }
+/**
+* Installs default properties.
+*/
 protected void installDefaults() {
 LookAndFeel.installProperty(progressBar, "opaque", Boolean.TRUE);
 LookAndFeel.installBorder(progressBar,"ProgressBar.border");
 LookAndFeel.installColorsAndFont(progressBar,
 "ProgressBar.background",
 cellSpacing = UIManager.getInt("ProgressBar.cellSpacing");
 selectionForeground = UIManager.getColor("ProgressBar.selectionForeground");
 selectionBackground = UIManager.getColor("ProgressBar.selectionBackground");
 }
+/**
+* Unintalls default properties.
+*/
 protected void uninstallDefaults() {
 LookAndFeel.uninstallBorder(progressBar);
 }
+/**
+* Registers listeners.
+*/
 protected void installListeners() {
 //Listen for changes in the progress bar's data.
 changeListener = getHandler();
 progressBar.addChangeListener(changeListener);
 // protected void installComponents()
 // protected void uninstallComponents()
 // protected void installKeyboardActions()
 // protected void uninstallKeyboardActions()
+/**
+* Returns preferred size of the horizontal {@code JProgressBar}.
+*
+* @return preferred size of the horizontal {@code JProgressBar}
+*/
 protected Dimension getPreferredInnerHorizontal() {
 Dimension horizDim = (Dimension)DefaultLookup.get(progressBar, this,
 "ProgressBar.horizontalSize");
 if (horizDim == null) {
 horizDim = new Dimension(146, 12);
 }
 return horizDim;
 }
+/**
+* Returns preferred size of the vertical {@code JProgressBar}.
+*
+* @return preferred size of the vertical {@code JProgressBar}
+*/
 protected Dimension getPreferredInnerVertical() {
 Dimension vertDim = (Dimension)DefaultLookup.get(progressBar, this,
 "ProgressBar.verticalSize");
 if (vertDim == null) {
 vertDim = new Dimension(12, 146);
 }
 /**
 * The "selectionForeground" is the color of the text when it is painted
 * over a filled area of the progress bar.
+*
+* @return the color of the selected foreground
 */
 protected Color getSelectionForeground() {
 return selectionForeground;
 }
 /**
 * The "selectionBackground" is the color of the text when it is painted
 * over an unfilled area of the progress bar.
+*
+* @return the color of the selected background
 */
 protected Color getSelectionBackground() {
 return selectionBackground;
 }
 } else {
 return cellLength;
 }
 }
+/**
+* Sets the cell length.
+*
+* @param cellLen a new cell length
+*/
 protected void setCellLength(int cellLen) {
 this.cellLength = cellLen;
 }
 /**
 } else {
 return cellSpacing;
 }
 }
+/**
+* Sets the cell spacing.
+*
+* @param cellSpace a new cell spacing
+*/
 protected void setCellSpacing(int cellSpace) {
 this.cellSpacing = cellSpace;
 }
 /**
 * This determines the amount of the progress bar that should be filled
 * based on the percent done gathered from the model. This is a common
 * operation so it was abstracted out. It assumes that your progress bar
 * is linear. That is, if you are making a circular progress indicator,
 * you will want to override this method.
+*
+* @param b insets
+* @param width a width
+* @param height a height
+* @return the amount of the progress bar that should be filled
 */
 protected int getAmountFull(Insets b, int width, int height) {
 int amountFull = 0;
 BoundedRangeModel model = progressBar.getModel();
 * All purpose paint method that should do the right thing for all
 * linear bouncing-box progress bars.
 * Override this if you are making another kind of
 * progress bar.
 *
+* @param g an instance of {@code Graphics}
+* @param c a component
 * @see #paintDeterminate
 *
 * @since 1.4
 */
 protected void paintIndeterminate(Graphics g, JComponent c) {
 * the defaults
 * table, things should work just fine to paint your progress bar.
 * Naturally, override this if you are making a circular or
 * semi-circular progress bar.
 *
+* @param g an instance of {@code Graphics}
+* @param c a component
 * @see #paintIndeterminate
 *
 * @since 1.4
 */
 protected void paintDeterminate(Graphics g, JComponent c) {
 barRectWidth, barRectHeight,
 amountFull, b);
 }
 }
+/**
+* Paints the progress string.
+*
+* @param g an instance of {@code Graphics}
+* @param x X location of bounding box
+* @param y Y location of bounding box
+* @param width width of bounding box
+* @param height height of bounding box
+* @param amountFull size of the fill region, either width or height
+*        depending upon orientation.
+* @param b Insets of the progress bar.
+*/
 protected void paintString(Graphics g, int x, int y,
 int width, int height,
 int amountFull, Insets b) {
 if (progressBar.getOrientation() == JProgressBar.HORIZONTAL) {
 if (BasicGraphicsUtils.isLeftToRight(progressBar)) {
 * Designate the place where the progress string will be painted.
 * This implementation places it at the center of the progress
 * bar (in both x and y). Override this if you want to right,
 * left, top, or bottom align the progress string or if you need
 * to nudge it around for any reason.
+*
+* @param g an instance of {@code Graphics}
+* @param progressString a text
+* @param x an X coordinate
+* @param y an Y coordinate
+* @param width a width
+* @param height a height
+* @return the place where the progress string will be painted
 */
 protected Point getStringPlacement(Graphics g, String progressString,
 int x,int y,int width,int height) {
 FontMetrics fontSizer = SwingUtilities2.getFontMetrics(progressBar, g,
 progressBar.getFont());
 }
 /**
 * Gets the index of the current animation frame.
 *
+* @return the index of the current animation frame
 * @since 1.4
 */
 protected int getAnimationIndex() {
 return animationIndex;
 }

changeset 25765	88051e6ecdc7
parent 23010	6dadb192ad81