jdk-sandbox: comparison jdk/src/share/classes/javax/swing/plaf/metal/MetalIconFactory.java

equal deleted inserted replaced

-:487a5e71f6dd
+:dbab904451e9
 // Ocean icons
 private static Icon oceanHorizontalSliderThumb;
 private static Icon oceanVerticalSliderThumb;
 // Constants
+/**
+* {@code DARK} is used for the property {@code Tree.expandedIcon}.
+*/
 public static final boolean DARK = false;
+/**
+* {@code LIGHT} is used for the property {@code Tree.collapsedIcon}.
+*/
 public static final boolean LIGHT = true;
 // Accessor functions for Icons. Does the caching work.
+/**
+* Returns the instance of {@code FileChooserDetailViewIcon}.
+*
+* @return the instance of {@code FileChooserDetailViewIcon}
+*/
 public static Icon getFileChooserDetailViewIcon() {
 if (fileChooserDetailViewIcon == null) {
 fileChooserDetailViewIcon = new FileChooserDetailViewIcon();
 }
 return fileChooserDetailViewIcon;
 }
+/**
+* Returns the instance of {@code FileChooserHomeFolderIcon}.
+*
+* @return the instance of {@code FileChooserHomeFolderIcon}
+*/
 public static Icon getFileChooserHomeFolderIcon() {
 if (fileChooserHomeFolderIcon == null) {
 fileChooserHomeFolderIcon = new FileChooserHomeFolderIcon();
 }
 return fileChooserHomeFolderIcon;
 }
+/**
+* Returns the instance of {@code FileChooserListViewIcon}.
+*
+* @return the instance of {@code FileChooserListViewIcon}
+*/
 public static Icon getFileChooserListViewIcon() {
 if (fileChooserListViewIcon == null) {
 fileChooserListViewIcon = new FileChooserListViewIcon();
 }
 return fileChooserListViewIcon;
 }
+/**
+* Returns the instance of {@code FileChooserNewFolderIcon}.
+*
+* @return the instance of {@code FileChooserNewFolderIcon}
+*/
 public static Icon getFileChooserNewFolderIcon() {
 if (fileChooserNewFolderIcon == null) {
 fileChooserNewFolderIcon = new FileChooserNewFolderIcon();
 }
 return fileChooserNewFolderIcon;
 }
+/**
+* Returns the instance of {@code FileChooserUpFolderIcon}.
+*
+* @return the instance of {@code FileChooserUpFolderIcon}
+*/
 public static Icon getFileChooserUpFolderIcon() {
 if (fileChooserUpFolderIcon == null) {
 fileChooserUpFolderIcon = new FileChooserUpFolderIcon();
 }
 return fileChooserUpFolderIcon;
 }
+/**
+* Constructs a new instance of {@code InternalFrameAltMaximizeIcon}.
+*
+* @param size the size of the icon
+* @return a new instance of {@code InternalFrameAltMaximizeIcon}
+*/
 public static Icon getInternalFrameAltMaximizeIcon(int size) {
 return new InternalFrameAltMaximizeIcon(size);
 }
+/**
+* Constructs a new instance of {@code InternalFrameCloseIcon}.
+*
+* @param size the size of the icon
+* @return a new instance of {@code InternalFrameCloseIcon}
+*/
 public static Icon getInternalFrameCloseIcon(int size) {
 return new InternalFrameCloseIcon(size);
 }
+/**
+* Returns the instance of {@code InternalFrameDefaultMenuIcon}.
+*
+* @return the instance of {@code InternalFrameDefaultMenuIcon}
+*/
 public static Icon getInternalFrameDefaultMenuIcon() {
 if (internalFrameDefaultMenuIcon == null) {
 internalFrameDefaultMenuIcon = new InternalFrameDefaultMenuIcon();
 }
 return internalFrameDefaultMenuIcon;
 }
+/**
+* Constructs a new instance of {@code InternalFrameMaximizeIcon}.
+*
+* @param size the size of the icon
+* @return a new instance of {@code InternalFrameMaximizeIcon}
+*/
 public static Icon getInternalFrameMaximizeIcon(int size) {
 return new InternalFrameMaximizeIcon(size);
 }
+/**
+* Constructs a new instance of {@code InternalFrameMinimizeIcon}.
+*
+* @param size the size of the icon
+* @return a new instance of {@code InternalFrameMinimizeIcon}
+*/
 public static Icon getInternalFrameMinimizeIcon(int size) {
 return new InternalFrameMinimizeIcon(size);
 }
+/**
+* Returns the instance of {@code RadioButtonIcon}.
+*
+* @return the instance of {@code RadioButtonIcon}
+*/
 public static Icon getRadioButtonIcon() {
 if (radioButtonIcon == null) {
 radioButtonIcon = new RadioButtonIcon();
 }
 return radioButtonIcon;
 }
 /**
 * Returns a checkbox icon.
+*
+* @return a checkbox icon
 * @since 1.3
 */
 public static Icon getCheckBoxIcon() {
 if (checkBoxIcon == null) {
 checkBoxIcon = new CheckBoxIcon();
 }
 return checkBoxIcon;
 }
+/**
+* Returns the instance of {@code TreeComputerIcon}.
+*
+* @return the instance of {@code TreeComputerIcon}
+*/
 public static Icon getTreeComputerIcon() {
 if ( treeComputerIcon == null ) {
 treeComputerIcon = new TreeComputerIcon();
 }
 return treeComputerIcon;
 }
+/**
+* Returns the instance of {@code TreeFloppyDriveIcon}.
+*
+* @return the instance of {@code TreeFloppyDriveIcon}
+*/
 public static Icon getTreeFloppyDriveIcon() {
 if ( treeFloppyDriveIcon == null ) {
 treeFloppyDriveIcon = new TreeFloppyDriveIcon();
 }
 return treeFloppyDriveIcon;
 }
+/**
+* Constructs a new instance of {@code TreeFolderIcon}.
+*
+* @return a new instance of {@code TreeFolderIcon}
+*/
 public static Icon getTreeFolderIcon() {
 return new TreeFolderIcon();
 }
+/**
+* Returns the instance of {@code TreeHardDriveIcon}.
+*
+* @return the instance of {@code TreeHardDriveIcon}
+*/
 public static Icon getTreeHardDriveIcon() {
 if ( treeHardDriveIcon == null ) {
 treeHardDriveIcon = new TreeHardDriveIcon();
 }
 return treeHardDriveIcon;
 }
+/**
+* Constructs a new instance of {@code TreeLeafIcon}.
+*
+* @return a new instance of {@code TreeLeafIcon}
+*/
 public static Icon getTreeLeafIcon() {
 return new TreeLeafIcon();
 }
+/**
+* Constructs a new instance of {@code TreeControlIcon}.
+*
+* @param isCollapsed if {@code true} the icon is collapsed
+* @return a new instance of {@code TreeControlIcon}
+*/
 public static Icon getTreeControlIcon( boolean isCollapsed ) {
 return new TreeControlIcon( isCollapsed );
 }
+/**
+* Returns an icon to be used by {@code JMenu}.
+*
+* @return an icon to be used by {@code JMenu}
+*/
 public static Icon getMenuArrowIcon() {
 if (menuArrowIcon == null) {
 menuArrowIcon = new MenuArrowIcon();
 }
 return menuArrowIcon;
 */
 public static Icon getMenuItemCheckIcon() {
 return null;
 }
+/**
+* Returns an icon to be used by {@code JMenuItem}.
+*
+* @return an icon to be used by {@code JMenuItem}
+*/
 public static Icon getMenuItemArrowIcon() {
 if (menuItemArrowIcon == null) {
 menuItemArrowIcon = new MenuItemArrowIcon();
 }
 return menuItemArrowIcon;
 }
+/**
+* Returns an icon to be used by {@code JCheckBoxMenuItem}.
+*
+* @return an icon to be used by {@code JCheckBoxMenuItem}
+*/
 public static Icon getCheckBoxMenuItemIcon() {
 if (checkBoxMenuItemIcon == null) {
 checkBoxMenuItemIcon = new CheckBoxMenuItemIcon();
 }
 return checkBoxMenuItemIcon;
 }
+/**
+* Returns an icon to be used by {@code JRadioButtonMenuItem}.
+*
+* @return an icon to be used by {@code JRadioButtonMenuItem}
+*/
 public static Icon getRadioButtonMenuItemIcon() {
 if (radioButtonMenuItemIcon == null) {
 radioButtonMenuItemIcon = new RadioButtonMenuItemIcon();
 }
 return radioButtonMenuItemIcon;
 }
+/**
+* Returns a thumb icon to be used by horizontal slider.
+*
+* @return a thumb icon to be used by horizontal slider
+*/
 public static Icon getHorizontalSliderThumbIcon() {
 if (MetalLookAndFeel.usingOcean()) {
 if (oceanHorizontalSliderThumb == null) {
 oceanHorizontalSliderThumb =
 new OceanHorizontalSliderThumbIcon();
 }
 // don't cache these, bumps don't get updated otherwise
 return new HorizontalSliderThumbIcon();
 }
+/**
+* Returns a thumb icon to be used by vertical slider.
+*
+* @return a thumb icon to be used by vertical slider
+*/
 public static Icon getVerticalSliderThumbIcon() {
 if (MetalLookAndFeel.usingOcean()) {
 if (oceanVerticalSliderThumb == null) {
 oceanVerticalSliderThumb = new OceanVerticalSliderThumbIcon();
 }
 g.drawLine( 1, 6, right - 7, 6 );
 g.drawLine( right - 6, 7, right - 1, 7 );
 }
+/**
+* Returns a shift of the icon.
+*
+* @return a shift of the icon
+*/
 public int getShift() { return 0; }
+/**
+* Returns an additional height of the icon.
+*
+* @return an additional height of the icon
+*/
 public int getAdditionalHeight() { return 0; }
 public int getIconWidth() { return folderIcon16Size.width; }
 public int getIconHeight() { return folderIcon16Size.height + getAdditionalHeight(); }
 }
 g.drawLine( right - 5, 2, right - 3, 4 );           // slant
 g.drawLine( 3, bottom - 1, right - 2, bottom - 1 ); // bottom
 }
+/**
+* Returns a shift of the icon.
+*
+* @return a shift of the icon
+*/
 public int getShift() { return 0; }
+/**
+* Returns an additional height of the icon.
+*
+* @return an additional height of the icon
+*/
 public int getAdditionalHeight() { return 0; }
 public int getIconWidth() { return fileIcon16Size.width; }
 public int getIconHeight() { return fileIcon16Size.height + getAdditionalHeight(); }
 }
+/**
+* The class represents a tree leaf icon.
+*/
 public static class TreeLeafIcon extends FileIcon16 {
 public int getShift() { return 2; }
 public int getAdditionalHeight() { return 4; }
 }
 * has been added to the <code>java.beans</code> package.
 * Please see {@link java.beans.XMLEncoder}.
 */
 @SuppressWarnings("serial") // Same-version serialization only
 public static class TreeControlIcon implements Icon, Serializable {
-// This data member should not have been exposed.  It's called
-// isLight, but now it really means isCollapsed.  Since we can't change
+/**
-// any APIs... that's life.
+* if {@code true} the icon is collapsed.
+* NOTE: This data member should not have been exposed. It's called
+* {@code isLight}, but now it really means {@code isCollapsed}.
+* Since we can't change any APIs... that's life.
+*/
 protected boolean isLight;
+/**
+* Constructs an instance of {@code TreeControlIcon}.
+*
+* @param isCollapsed if {@code true} the icon is collapsed
+*/
 public TreeControlIcon( boolean isCollapsed ) {
 isLight = isCollapsed;
 }
 ImageCacher imageCacher;
 4, 3, 17, 17, null);
 }
 }
 }
+/**
+* Paints the {@code TreeControlIcon}.
+*
+* @param c a component
+* @param g an instance of {@code Graphics}
+* @param x an X coordinate
+* @param y an Y coordinate
+*/
 public void paintMe(Component c, Graphics g, int x, int y) {
 g.setColor( MetalLookAndFeel.getPrimaryControlInfo() );
 int xoff = (MetalUtils.isLeftToRight(c)) ? 0 : 4;
 g.drawLine( xoff + 4, 6, xoff + 4, 9 );     // left
 g.drawLine( xoff + 5, 5, xoff + 5, 5 );     // top left dot
 g.drawLine( xoff + 6, 4, xoff + 9, 4 );     // top
 g.drawLine( xoff + 10, 5, xoff + 10, 5 );   // top right dot
 g.drawLine( xoff + 11, 6, xoff + 11, 9 );   // right
-g.drawLine( xoff + 10, 10, xoff + 10, 10 ); // botom right dot
+g.drawLine( xoff + 10, 10, xoff + 10, 10 ); // bottom right dot
 g.drawLine( xoff + 6, 11, xoff + 9, 11 );   // bottom
 g.drawLine( xoff + 5, 10, xoff + 5, 10 );   // bottom left dot
 // Draw Center Dot
 g.drawLine( xoff + 7, 7, xoff + 8, 7 );

changeset 25178	dbab904451e9
parent 25095	c5dedd869f01