ImageButton (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Canvas
  - - vib.segment.ImageButton

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
```
public class ImageButton
extends Canvas
implements MouseListener
```
ImageButton - A button component with an image in it

Author:

DTAI, Incorporated

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Canvas
  Canvas.AccessibleAWTCanvas
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type Field and Description

static int ARMED

static int DISABLED

static int OVER

static int UNARMED
- Fields inherited from class java.awt.Component
  accessibleContext, 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

Fields
Modifier and Type	Field and Description
`static int`	`ARMED`
`static int`	`DISABLED`
`static int`	`OVER`
`static int`	`UNARMED`

Constructor Summary

Constructors
Constructor and Description

ImageButton()
Constructs an ImageButton

ImageButton(Image image)
Constructs an ImageButton with the given image.

Constructors
Constructor and Description
`ImageButton()` Constructs an ImageButton
`ImageButton(Image image)` Constructs an ImageButton with the given image.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActionListener(ActionListener l)`
`String`	`getActionCommand()`
`Border`	`getArmedBorder()` Gets the border to display when the button is pressed and the mouse is still over the button.
`Image`	`getArmedImage()` Gets the image to display when the button is pressed and the mouse is still over the button.
`int`	`getButtonState()` Gets the current buttonState id for the button
`Border`	`getDisabledBorder()` Gets the border to display when the button is disabled.
`Image`	`getDisabledImage()` Gets the image to display when the button is disabled.
`Border`	`getOverBorder()` Gets the border to display when the button is not pressed and the mouse is over the button.
`Image`	`getOverImage()` Gets the image to display when the button is not pressed and the mouse is over the button.
`Dimension`	`getPreferredSize()` Overrides awt.Component.preferredSize() to return the preferred size of the button.
`Border`	`getUnarmedBorder()` Gets the border to display when the button is not pressed or hilited because of a mouse-over.
`Image`	`getUnarmedImage()` Gets the image to display when the button is not pressed or hilited because of a mouse-over.
`void`	`mouseClicked(MouseEvent arg0)`
`void`	`mouseEntered(MouseEvent arg0)`
`void`	`mouseExited(MouseEvent arg0)`
`void`	`mousePressed(MouseEvent arg0)`
`void`	`mouseReleased(MouseEvent arg0)`
`void`	`paint(Graphics g)` Overrides awt.Component.paint() to paint the current border and image.
`protected void`	`processActionEvent(ActionEvent e)`
`void`	`removeActionListener(ActionListener l)`
`void`	`setActionCommand(String command)`
`void`	`setArmedBorder(Border border)` Sets the border to display when the button is pressed and the mouse is still over the button.
`void`	`setArmedImage(Image image)` Sets the image to display when the button is pressed and the mouse is still over the button.
`protected void`	`setButtonState(int buttonState)` Sets the current buttonState id for the button
`void`	`setDisabledBorder(Border border)` Sets the border to display when the button is disabled.
`void`	`setDisabledImage(Image image)` Sets the image to display when the button is disabled.
`void`	`setOverBorder(Border border)` Sets the border to display when the button is not pressed and the mouse is over the button.
`void`	`setOverImage(Image image)` Sets the image to display when the button is not pressed and the mouse is over the button.
`void`	`setUnarmedBorder(Border border)` Sets the border to display when the button is not pressed or hilited because of a mouse-over.
`void`	`setUnarmedImage(Image image)` Sets the image to display when the button is not pressed or hilited because of a mouse-over.

Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, 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, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, 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, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNARMED
```
public static final int UNARMED
```
    See Also:
    
    Constant Field Values
  - ARMED
```
public static final int ARMED
```
    See Also:
    
    Constant Field Values
  - OVER
```
public static final int OVER
```
    See Also:
    
    Constant Field Values
  - DISABLED
```
public static final int DISABLED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageButton
```
public ImageButton()
```
    Constructs an ImageButton
  - ImageButton
```
public ImageButton(Image image)
```
    Constructs an ImageButton with the given image.
    
    Parameters:
    
    image - the image for all states of the button (until other images are assigned)
- Method Detail
  - setUnarmedImage
```
public void setUnarmedImage(Image image)
```
    Sets the image to display when the button is not pressed or hilited because of a mouse-over. This image is also used in those other cases if no alternative image is requested.
    
    Parameters:
    
    image - the unarmed image
  - setArmedImage
```
public void setArmedImage(Image image)
```
    Sets the image to display when the button is pressed and the mouse is still over the button.
    
    Parameters:
    
    image - the armed image
  - setOverImage
```
public void setOverImage(Image image)
```
    Sets the image to display when the button is not pressed and the mouse is over the button.
    
    Parameters:
    
    image - the over image
  - setDisabledImage
```
public void setDisabledImage(Image image)
```
    Sets the image to display when the button is disabled.
    
    Parameters:
    
    image - the disabled image
  - getUnarmedImage
```
public Image getUnarmedImage()
```
    Gets the image to display when the button is not pressed or hilited because of a mouse-over. This image is also used in those other cases if no alternative image is requested.
    
    Returns:
    
    the unarmed image
  - getArmedImage
```
public Image getArmedImage()
```
    Gets the image to display when the button is pressed and the mouse is still over the button.
    
    Returns:
    
    the armed image
  - getOverImage
```
public Image getOverImage()
```
    Gets the image to display when the button is not pressed and the mouse is over the button.
    
    Returns:
    
    the over image
  - getDisabledImage
```
public Image getDisabledImage()
```
    Gets the image to display when the button is disabled.
    
    Returns:
    
    the armed image
  - setUnarmedBorder
```
public void setUnarmedBorder(Border border)
```
    Sets the border to display when the button is not pressed or hilited because of a mouse-over. This border is also used in those other cases if no alternative border is requested.
    
    Parameters:
    
    border - the unarmed border
  - setArmedBorder
```
public void setArmedBorder(Border border)
```
    Sets the border to display when the button is pressed and the mouse is still over the button.
    
    Parameters:
    
    border - the armed border
  - setOverBorder
```
public void setOverBorder(Border border)
```
    Sets the border to display when the button is not pressed and the mouse is over the button.
    
    Parameters:
    
    border - the over border
  - setDisabledBorder
```
public void setDisabledBorder(Border border)
```
    Sets the border to display when the button is disabled.
    
    Parameters:
    
    border - the disabled border
  - getUnarmedBorder
```
public Border getUnarmedBorder()
```
    Gets the border to display when the button is not pressed or hilited because of a mouse-over. This border is also used in those other cases if no alternative border is requested.
    
    Returns:
    
    the unarmed border
  - getArmedBorder
```
public Border getArmedBorder()
```
    Gets the border to display when the button is pressed and the mouse is still over the button.
    
    Returns:
    
    the armed border
  - getOverBorder
```
public Border getOverBorder()
```
    Gets the border to display when the button is not pressed and the mouse is over the button.
    
    Returns:
    
    the over border
  - getDisabledBorder
```
public Border getDisabledBorder()
```
    Gets the border to display when the button is disabled.
    
    Returns:
    
    the armed border
  - getButtonState
```
public int getButtonState()
```
    Gets the current buttonState id for the button
    
    Returns:
    
    the button state integer id
  - setButtonState
```
protected void setButtonState(int buttonState)
```
    Sets the current buttonState id for the button
    
    Parameters:
    
    buttonState - the button state integer id
  - paint
```
public void paint(Graphics g)
```
    Overrides awt.Component.paint() to paint the current border and image.
    
    Overrides:
    
    paint in class Canvas
    
    Parameters:
    
    g - The Graphics in which to draw
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Overrides awt.Component.preferredSize() to return the preferred size of the button. This assumes the images (if more than one) are all the same size. It also calculates the maximum insets from all borders and adds them to the image dimensions.
    
    Overrides:
    
    getPreferredSize in class Component
  - setActionCommand
```
public void setActionCommand(String command)
```
  - getActionCommand
```
public String getActionCommand()
```
  - addActionListener
```
public void addActionListener(ActionListener l)
```
  - removeActionListener
```
public void removeActionListener(ActionListener l)
```
  - processActionEvent
```
protected void processActionEvent(ActionEvent e)
```
  - mouseClicked
```
public void mouseClicked(MouseEvent arg0)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mousePressed
```
public void mousePressed(MouseEvent arg0)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseReleased
```
public void mouseReleased(MouseEvent arg0)
```
    Specified by:
    
    mouseReleased in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent arg0)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent arg0)
```
    Specified by:
    
    mouseExited in interface MouseListener

Class ImageButton

Nested Class Summary

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

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Canvas

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

UNARMED

ARMED

OVER

DISABLED

Constructor Detail

ImageButton

ImageButton

Method Detail

setUnarmedImage

setArmedImage

setOverImage

setDisabledImage

getUnarmedImage

getArmedImage

getOverImage

getDisabledImage

setUnarmedBorder

setArmedBorder

setOverBorder

setDisabledBorder

getUnarmedBorder

getArmedBorder

getOverBorder

getDisabledBorder

getButtonState

setButtonState

paint

getPreferredSize

setActionCommand

getActionCommand

addActionListener

removeActionListener

processActionEvent

mouseClicked

mousePressed

mouseReleased

mouseEntered

mouseExited