/*
* 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
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.swing;
import java.awt.Graphics;
import java.awt.Component;
A small fixed size picture, typically used to decorate components.
See Also: - ImageIcon
Since: 1.2
/**
* A small fixed size picture, typically used to decorate components.
*
* @see ImageIcon
* @since 1.2
*/
public interface Icon
{
Draw the icon at the specified location. Icon implementations
may use the Component argument to get properties useful for
painting, e.g. the foreground or background color.
Params: - c – a
Component
to get properties useful for painting - g – the graphics context
- x – the X coordinate of the icon's top-left corner
- y – the Y coordinate of the icon's top-left corner
/**
* Draw the icon at the specified location. Icon implementations
* may use the Component argument to get properties useful for
* painting, e.g. the foreground or background color.
*
* @param c a {@code Component} to get properties useful for painting
* @param g the graphics context
* @param x the X coordinate of the icon's top-left corner
* @param y the Y coordinate of the icon's top-left corner
*/
void paintIcon(Component c, Graphics g, int x, int y);
Returns the icon's width.
Returns: an int specifying the fixed width of the icon.
/**
* Returns the icon's width.
*
* @return an int specifying the fixed width of the icon.
*/
int getIconWidth();
Returns the icon's height.
Returns: an int specifying the fixed height of the icon.
/**
* Returns the icon's height.
*
* @return an int specifying the fixed height of the icon.
*/
int getIconHeight();
}