com.sshtools.ui.awt

Class ImageButton

java.lang.Object

java.awt.Component

java.awt.Canvas

com.sshtools.ui.awt.ImageTextLabel

com.sshtools.ui.awt.ImageButton

All Implemented Interfaces:

MouseListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

ActionButton

public class ImageButton
extends ImageTextLabel
implements MouseListener, ItemSelectable

An button implementation that can display an image.

Author:

$author$

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 inherited from class com.sshtools.ui.awt.ImageTextLabel

CENTER_ALIGNMENT, EMPTY, FLAT, LEFT_ALIGNMENT, LOWERED_BEVEL, NONE, RAISED_BEVEL, RAISED_ROUNDED, RIGHT_ALIGNMENT

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ImageButton()
ImageButton(Image image, String text, String actionCommand)
ImageButton(Image image, String text, String actionCommand, int hoverBorder, int depressedBorder, int normalBorder)

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l)
void	addItemListener(ItemListener l)
String	getActionCommand() Get the action command
int	getDarkness()
Image	getGrayImage()
Object[]	getSelectedObjects()
String	getToolTipText()
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent event)
void	removeActionListener(ActionListener l)
void	removeItemListener(ItemListener l)
void	setActionCommand(String actionCommand) Set the action command
void	setBackground(Color background)
void	setBaseBackground(Color base)
void	setBaseForeground(Color base)
void	setDarkness(int darkness)
void	setEnabled(boolean enabled)
void	setForeground(Color foreground)
void	setGrayImage(Image grayImage)
void	setHoverBackground(Color hoverBackground) Set the background color to use when hovering over a button.
void	setHoverBorder(int hoverBorder) Set the type of border to use when this is a hover button
void	setHoverButton(boolean hoverButton) Set if this is a 'hover button'.
void	setHoverForeground(Color hoverForeground) Set the foreground color to use when hovering over a button.
void	setPressed(boolean pressed)
void	setToolTipText(String toolTipText)

Methods inherited from class com.sshtools.ui.awt.ImageTextLabel

addNotify, doLayout, getBorderDarkShadowColor, getBorderShadowColor, getImage, getInsets, getMargin, getMinimumSize, getPreferredSize, getText, getTextImageGap, isTextVisible, paint, paintBorder, renderComponent, setBorderDarkShadowColor, setBorderShadowColor, setBorderType, setFont, setHorizontalAlignment, setImage, setMargin, setText, setTextImageGap, setTextVisible, update

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

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, 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, 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, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, 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

Constructor Detail

ImageButton

public ImageButton()

ImageButton

public ImageButton(Image image,
                   String text,
                   String actionCommand)

ImageButton

public ImageButton(Image image,
                   String text,
                   String actionCommand,
                   int hoverBorder,
                   int depressedBorder,
                   int normalBorder)

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class Component

setBaseBackground

public void setBaseBackground(Color base)

setBaseForeground

public void setBaseForeground(Color base)

setBackground

public void setBackground(Color background)

Overrides:

setBackground in class Component

setForeground

public void setForeground(Color foreground)

Overrides:

setForeground in class Component

setHoverBorder

public void setHoverBorder(int hoverBorder)

Set the type of border to use when this is a hover button

Parameters:

hoverBorder -

setHoverButton

public void setHoverButton(boolean hoverButton)

Set if this is a 'hover button'. If true a border will be raised when the user moves the mouse pointer over this component.

Parameters:

hoverButton -

setHoverBackground

public void setHoverBackground(Color hoverBackground)

Set the background color to use when hovering over a button. null means use default color.

Parameters:

hoverBackground - background color

setHoverForeground

public void setHoverForeground(Color hoverForeground)

Set the foreground color to use when hovering over a button. null means use default color.

Parameters:

hoverForeground - foreground color

getActionCommand

public String getActionCommand()

Get the action command

setActionCommand

public void setActionCommand(String actionCommand)

Set the action command

Parameters:

actionCommand - action command

setToolTipText

public void setToolTipText(String toolTipText)

getToolTipText

public String getToolTipText()

addActionListener

public void addActionListener(ActionListener l)

addItemListener

public void addItemListener(ItemListener l)

Specified by:

addItemListener in interface ItemSelectable

removeActionListener

public void removeActionListener(ActionListener l)

removeItemListener

public void removeItemListener(ItemListener l)

Specified by:

removeItemListener in interface ItemSelectable

getDarkness

public int getDarkness()

setDarkness

public void setDarkness(int darkness)

getGrayImage

public Image getGrayImage()

setGrayImage

public void setGrayImage(Image grayImage)

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent event)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

setPressed

public void setPressed(boolean pressed)

Parameters:

b -

getSelectedObjects

public Object[] getSelectedObjects()

Specified by:

getSelectedObjects in interface ItemSelectable