uk.co.ist.mwt
Class ImageButton

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--uk.co.ist.mwt.ShadowedComponent
                          |
                          +--uk.co.ist.mwt.BoxedButton
                                |
                                +--uk.co.ist.mwt.ImageButton

public class ImageButton
extends BoxedButton

ImageButtons are buttons which display an image inside their shadow box.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Fields inherited from class uk.co.ist.mwt.ShadowedComponent
shadowDrawer
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
ImageButton()
          Constructor; simply sets a sensible shadow thickness
 
Method Summary
 java.awt.Image getArmedImage()
          Method to get the image displayed in the button when it is enabled and armed
 java.awt.Image getDisabledImage()
          Method to get the image displayed in the button when it is disabled
 java.awt.Image getImage()
          Method to get the image displayed in the button when it is enabled and unarmed
 java.awt.Dimension getMinimumSize()
          Gets the minimum size of the ImageButton.
 java.awt.Dimension getPreferredSize()
          Gets the preferred size of the ImageButton.
 boolean imageUpdate(java.awt.Image img, int flags, int x, int y, int w, int h)
          Routine to repaint the image when it changes; we ask the parent to relayout if our idea of its size has changed.
 void paintComponent(java.awt.Graphics g)
          Method to paint the button - its shadow box and its image.
 void setArmedImage(java.awt.Image i)
          Method to specify the image to display in the button when it is enabled and armed
 void setDisabledImage(java.awt.Image i)
          Method to specify the image to display in the button when it is disabled
 void setImage(java.awt.Image i)
          Method to specify the image to display in the button when it is enabled and unarmed
 
Methods inherited from class uk.co.ist.mwt.BoxedButton
addActionListener, armed, onMouseDown, onMouseEnter, onMouseExit, onMouseUp, processActionEvent, processMouseEvent, removeActionListener, sinkOnArm
 
Methods inherited from class uk.co.ist.mwt.ShadowedComponent
draw3DRect, draw3DRect, draw3DRect, draw3DRect, drawShadow, drawShadow, getBottomShadowColor, getShadowThickness, getTopShadowColor, setBottomShadowColor, setShadowThickness, setTopShadowColor
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ImageButton

public ImageButton()
Constructor; simply sets a sensible shadow thickness
Method Detail

setImage

public void setImage(java.awt.Image i)
Method to specify the image to display in the button when it is enabled and unarmed
Parameters:
i - the image to display

getImage

public java.awt.Image getImage()
Method to get the image displayed in the button when it is enabled and unarmed

setDisabledImage

public void setDisabledImage(java.awt.Image i)
Method to specify the image to display in the button when it is disabled
Parameters:
i - the image to display

getDisabledImage

public java.awt.Image getDisabledImage()
Method to get the image displayed in the button when it is disabled

setArmedImage

public void setArmedImage(java.awt.Image i)
Method to specify the image to display in the button when it is enabled and armed
Parameters:
i - the image to display

getArmedImage

public java.awt.Image getArmedImage()
Method to get the image displayed in the button when it is enabled and armed
Parameters:
i - the image to display

paintComponent

public void paintComponent(java.awt.Graphics g)
Method to paint the button - its shadow box and its image.
Overrides:
paintComponent in class BoxedButton
Parameters:
g - the graphics context into which we should draw

getPreferredSize

public java.awt.Dimension getPreferredSize()
Gets the preferred size of the ImageButton. This is the same as its minimum size, and is large enough to hold the image with a shadow box surrounding it.
Overrides:
getPreferredSize in class javax.swing.JComponent
See Also:
getMinimumSize()

getMinimumSize

public java.awt.Dimension getMinimumSize()
Gets the minimum size of the ImageButton. This is the same as its preferred size, and is large enough to hold the image with a shadow box surrounding it.
Overrides:
getMinimumSize in class javax.swing.JComponent
See Also:
getPreferredSize()

imageUpdate

public boolean imageUpdate(java.awt.Image img,
                           int flags,
                           int x,
                           int y,
                           int w,
                           int h)
Routine to repaint the image when it changes; we ask the parent to relayout if our idea of its size has changed.
Overrides:
imageUpdate in class java.awt.Component