org.pzgui.icon
Class ImageIcon

java.lang.Object
  java.awt.Component
      org.pzgui.icon.Icon
          org.pzgui.icon.ImageIcon

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ImageIcon
extends Icon

An icon backed by a rasterized image.

Author:

David Underhill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class org.pzgui.icon.Icon

FONT_METRICS, lblForFM

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ImageIcon(java.lang.String fn)
Creates an image from the specified filename.

ImageIcon(java.lang.String fn, float scale)
Creates an image from the speccified filename with its width and height scaled by the specified scale value.

ImageIcon(java.lang.String fn, int width, int height)
Creates an image from the speccified filename with the specified width and height.

Method Summary

void	clearCache() Clears any cached copies of the icon at any size other than its original size.
static void	draw(java.awt.Graphics2D gfx, java.awt.Image img, int x, int y, int w, int h)
void	draw(java.awt.Graphics2D gfx, int x, int y) Draws this icon on the specified graphics object at the specified coordinates.
void	draw(java.awt.Graphics2D gfx, int x, int y, int w, int h) Draws this icon on the specified graphics object at the specified coordinates at the specified size.
java.awt.Image	getImage()
java.awt.Image	getImage(java.awt.Dimension sz)
static java.awt.Image	getScaledImage(java.awt.Image img, int w, int h) Scales the specified image to the requested size
java.awt.Dimension	getSize() Returns the default size of this icon.
static java.awt.Image	loadImage(java.lang.String fn) Loads an image into memory

Methods inherited from class org.pzgui.icon.Icon

contains, draw, getHeight, getWidth, paint, setSize

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageIcon

public ImageIcon(java.lang.String fn)

Creates an image from the specified filename. The image's height and width will be scaled based on the ratio of the GUI's current size to the 1080p resolution. In other words, the original image is assumed to be in native resolution for 1080p.

Parameters:

fn - path to the image file

ImageIcon

public ImageIcon(java.lang.String fn,
                 int width,
                 int height)

Creates an image from the speccified filename with the specified width and height. The original image will be resampled if needed.

Parameters:

fn - path to the image file

width - width of this icon

height - height of this icon

ImageIcon

public ImageIcon(java.lang.String fn,
                 float scale)

Creates an image from the speccified filename with its width and height scaled by the specified scale value.

Parameters:

fn - path to the image file

scale - how much to scale this icon from its native size

Method Detail

loadImage

public static java.awt.Image loadImage(java.lang.String fn)

Loads an image into memory

getScaledImage

public static final java.awt.Image getScaledImage(java.awt.Image img,
                                                  int w,
                                                  int h)

Scales the specified image to the requested size

clearCache

public void clearCache()

Description copied from class: Icon

Clears any cached copies of the icon at any size other than its original size.

Specified by:

clearCache in class Icon

draw

public void draw(java.awt.Graphics2D gfx,
                 int x,
                 int y)

Description copied from class: Icon

Draws this icon on the specified graphics object at the specified coordinates.

Overrides:

draw in class Icon

draw

public void draw(java.awt.Graphics2D gfx,
                 int x,
                 int y,
                 int w,
                 int h)

Description copied from class: Icon

Draws this icon on the specified graphics object at the specified coordinates at the specified size.

Specified by:

draw in class Icon

draw

public static void draw(java.awt.Graphics2D gfx,
                        java.awt.Image img,
                        int x,
                        int y,
                        int w,
                        int h)

getSize

public java.awt.Dimension getSize()

Description copied from class: Icon

Returns the default size of this icon.

Specified by:

getSize in class Icon

getImage

public java.awt.Image getImage()

getImage

public java.awt.Image getImage(java.awt.Dimension sz)