org.pzgui.icon
Class Icon

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CompositeIcon, EmptyIcon, GeometricIcon, ImageIcon, ShapeIcon, TemporalIcon, TextIcon

public abstract class Icon
extends java.awt.Component

Generic icon for drawing. Caches different sizes of the icon as needed.

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

static java.awt.FontMetrics	FONT_METRICS
protected static javax.swing.JLabel	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

Icon()

Method Summary

abstract void	clearCache() Clears any cached copies of the icon at any size other than its original size.
boolean	contains(int x, int y, int iconX, int iconY) whether x,y is contained by this icon
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, float scale) Draws this icon on the specified graphics object at the specified coordinates at the specified scale.
abstract 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.
int	getHeight() gets the default height of this icon
abstract java.awt.Dimension	getSize() Returns the default size of this icon.
int	getWidth() gets the default width of this icon
void	paint(java.awt.Graphics g) Draws this icon.
void	setSize(int w, int h)

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

Field Detail

lblForFM

protected static final javax.swing.JLabel lblForFM

FONT_METRICS

public static java.awt.FontMetrics FONT_METRICS

Constructor Detail

Icon

public Icon()

Method Detail

clearCache

public abstract void clearCache()

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

draw

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

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

draw

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

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

draw

public abstract 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.

paint

public void paint(java.awt.Graphics g)

Draws this icon.

Overrides:

paint in class java.awt.Component

contains

public boolean contains(int x,
                        int y,
                        int iconX,
                        int iconY)

whether x,y is contained by this icon

getSize

public abstract java.awt.Dimension getSize()

Returns the default size of this icon.

Overrides:

getSize in class java.awt.Component

getHeight

public int getHeight()

gets the default height of this icon

Overrides:

getHeight in class java.awt.Component

getWidth

public int getWidth()

gets the default width of this icon

Overrides:

getWidth in class java.awt.Component

setSize

public void setSize(int w,
                    int h)

Overrides:

setSize in class java.awt.Component