org.formaria.swing
Class ImageButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JToggleButton
                      org.formaria.swing.ImageButton

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.SwingConstants

public class ImageButton
extends javax.swing.JToggleButton
implements java.awt.event.MouseListener

Uses a set of images to create a button

Copyright (c) Formaria Ltd., 2008

License: see license.txt $Revision: 1.17 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JToggleButton

javax.swing.JToggleButton.AccessibleJToggleButton, javax.swing.JToggleButton.ToggleButtonModel

Nested classes/interfaces inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

protected boolean	antiAlias
protected Project	currentProject The current project
protected TextRenderer	textRenderer The renderer that will paint the component

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ImageButton()
Creates a new instance of ImageButton

Method Summary

static void	drawStringUnderlineCharAt(javax.swing.JComponent c, java.awt.FontMetrics fm, java.awt.Graphics g, java.lang.String text, int underlinedIndex, int x, int y) Draws the string at the specified location underlining the specified character.
java.lang.String	getDisabledImageName() Get the name of the disabled image
java.lang.String	getImageName() Get the name of the main image
Painter	getPainter() Get the background painter object
java.awt.Dimension	getPreferredSize() Gets the preferred size of this component.
java.lang.String	getPressedImageName() Get the name of the pressed image
java.lang.String	getRolloverImageName() Get the name of the rollover image
boolean	imageUpdate(java.awt.Image img, int infoflags, int x, int y, int width, int height) Update the image as it is loaded.
boolean	isVertical() Is the button drawn vertically?
void	mouseClicked(java.awt.event.MouseEvent e) Invoked when the mouse button has been clicked (pressed and released) on a component.
void	mouseEntered(java.awt.event.MouseEvent e) Invoked when the mouse enters a component.
void	mouseExited(java.awt.event.MouseEvent e) Invoked when the mouse exits a component.
void	mousePressed(java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on a component.
void	mouseReleased(java.awt.event.MouseEvent e) Invoked when a mouse button has been released on a component.
void	paintComponent(java.awt.Graphics g) Paints the component
void	setAlignment(int align) Set one or more attributes of the component.
void	setAntiAlias(boolean value)
void	setContent(java.lang.String value)
void	setDisabledImage(java.awt.Image img) Sets the pressed image to display.
void	setDisabledImageName(java.lang.String imgName) Sets the disabled image to display based on the image name.
void	setHorizontalAlignment(int alignment) Set the horizontal text alignment
void	setIconName(java.lang.String value)
void	setImage(java.awt.Image img) Sets the image to display.
void	setImageName(java.lang.String imgName) Sets the image to display based on the image name.
void	setPainter(Painter xp) Set the background painter object
void	setPainter(java.lang.String value)
void	setPressedImage(java.awt.Image img) Sets the pressed image to display.
void	setPressedImageName(java.lang.String imgName) Sets the pressed image to display based on the image name.
void	setRolloverImage(java.awt.Image img) Sets the pressed image to display.
void	setRolloverImageName(java.lang.String imgName) Sets the rollover image to display based on the image name.
void	setToolTip(java.lang.String text) Set the tool tip text
void	setUseRenderer(boolean value)
void	setVertical(boolean isVertical) Set the button to draw vertically?
void	setVerticalAlignment(int verticalAlignment) Set the vertical text alignment

Methods inherited from class javax.swing.JToggleButton

getAccessibleContext, getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

antiAlias

protected boolean antiAlias

textRenderer

protected TextRenderer textRenderer

The renderer that will paint the component

currentProject

protected Project currentProject

The current project

Constructor Detail

ImageButton

public ImageButton()

Creates a new instance of ImageButton

Method Detail

paintComponent

public void paintComponent(java.awt.Graphics g)

Paints the component

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - The graphics context

getPreferredSize

public java.awt.Dimension getPreferredSize()

Gets the preferred size of this component.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

a dimension object indicating this component's preferred size

See Also:

JComponent.getMinimumSize(), LayoutManager

imageUpdate

public boolean imageUpdate(java.awt.Image img,
                           int infoflags,
                           int x,
                           int y,
                           int width,
                           int height)

Update the image as it is loaded.

Specified by:

imageUpdate in interface java.awt.image.ImageObserver

Overrides:

imageUpdate in class javax.swing.AbstractButton

Parameters:

img - the image

infoflags - the flags

x - the left/x coordinate

y - the y/top coordinate

width - width dimension

height - the height dimension

Returns:

super.imageUpdate(...)

setAlignment

public void setAlignment(int align)

Set one or more attributes of the component. Attributes include
align (left|right|center ) or
alignment (left|right|center )
buffered (true|false) double buffering

Parameters:

align - 1 to right align the text, 0 for left alignment and 2 for centered text

setImage

public void setImage(java.awt.Image img)

Sets the image to display.

Parameters:

img - the image

setPressedImage

public void setPressedImage(java.awt.Image img)

Sets the pressed image to display.

Parameters:

img - the image

setDisabledImage

public void setDisabledImage(java.awt.Image img)

Sets the pressed image to display.

Parameters:

img - the image

setRolloverImage

public void setRolloverImage(java.awt.Image img)

Sets the pressed image to display.

Parameters:

img - the image

setImageName

public void setImageName(java.lang.String imgName)

Sets the image to display based on the image name.

Parameters:

imgName - the image

setPressedImageName

public void setPressedImageName(java.lang.String imgName)

Sets the pressed image to display based on the image name.

Parameters:

imgName - the image

setRolloverImageName

public void setRolloverImageName(java.lang.String imgName)

Sets the rollover image to display based on the image name.

Parameters:

imgName - the image

setDisabledImageName

public void setDisabledImageName(java.lang.String imgName)

Sets the disabled image to display based on the image name.

Parameters:

imgName - the image

getImageName

public java.lang.String getImageName()

Get the name of the main image

Returns:

the image file name

getRolloverImageName

public java.lang.String getRolloverImageName()

Get the name of the rollover image

Returns:

the image file name

getPressedImageName

public java.lang.String getPressedImageName()

Get the name of the pressed image

Returns:

the image file name

getDisabledImageName

public java.lang.String getDisabledImageName()

Get the name of the disabled image

Returns:

the image file name

setContent

public void setContent(java.lang.String value)

Parameters:

value -

setIconName

public void setIconName(java.lang.String value)

Parameters:

value -

setAntiAlias

public void setAntiAlias(boolean value)

Parameters:

value -

setUseRenderer

public void setUseRenderer(boolean value)

Parameters:

value -

setPainter

public void setPainter(java.lang.String value)

Parameters:

value -

setToolTip

public void setToolTip(java.lang.String text)

Set the tool tip text

Parameters:

text - the new text

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Invoked when the mouse button has been clicked (pressed and released) on a component.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Parameters:

e - the event

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Invoked when a mouse button has been pressed on a component.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Invoked when a mouse button has been released on a component.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Invoked when the mouse enters a component.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Invoked when the mouse exits a component.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Parameters:

e - the event

drawStringUnderlineCharAt

public static void drawStringUnderlineCharAt(javax.swing.JComponent c,
                                             java.awt.FontMetrics fm,
                                             java.awt.Graphics g,
                                             java.lang.String text,
                                             int underlinedIndex,
                                             int x,
                                             int y)

Draws the string at the specified location underlining the specified character.

Parameters:

c - JComponent that will display the string, may be null

g - Graphics to draw the text to

text - String to display

underlinedIndex - Index of a character in the string to underline

x - X coordinate to draw the text at

y - Y coordinate to draw the text at

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Set the horizontal text alignment

Overrides:

setHorizontalAlignment in class javax.swing.AbstractButton

setVerticalAlignment

public void setVerticalAlignment(int verticalAlignment)

Set the vertical text alignment

Overrides:

setVerticalAlignment in class javax.swing.AbstractButton

setPainter

public void setPainter(Painter xp)

Set the background painter object

Parameters:

xp - the painter object

getPainter

public Painter getPainter()

Get the background painter object

Returns:

the painter object

isVertical

public boolean isVertical()

Is the button drawn vertically?

Returns:

setVertical

public void setVertical(boolean isVertical)

Set the button to draw vertically?