com.lf.commons.gui.button

Class HyperlinkButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

com.lf.commons.gui.button.HyperlinkButton

All Implemented Interfaces:

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

public class HyperlinkButton
extends javax.swing.JButton
implements java.awt.event.ActionListener

Special button showing a hyperlink which can be activated by using the mouse.

This class is based on SUN's JHyperlink class shipping with the SwingSet3 demo. If the underlying URI is not set (null) then no link is displayed but normal text.

Since:

1.6

Version:

$Revision: 1.5 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JButton.AccessibleJButton

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

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

Constructors

Constructor and Description
HyperlinkButton() Creates a hyperlink button instance.
HyperlinkButton(java.lang.String text, javax.swing.Icon icon, java.lang.String uriTarget) Creates a hyperlink button instance with a given link text, icon, and URI.
HyperlinkButton(java.lang.String text, javax.swing.Icon icon, java.net.URI uri) Creates a hyperlink button instance with a given link text, icon, and URI.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Automatically called when the user clicks on the link.
java.awt.Color	getActiveForeground() Provides the active foreground (text) color.
java.awt.Cursor	getCursor() Provides the cursor for the hyperlink button.
boolean	getDrawUnderline() Provides the info whether to draw an underline or not.
java.lang.String	getPlainText() Provides the button text.
boolean	getRememberVisited() Remember visited links (drawn in other color)?
boolean	getShowURIToolTip() Show URI as tooltip?
java.net.URI	getURI() Provides the link target which is also displayed as tooltip.
java.awt.Color	getVisitedForeground() Provides the visited foreground (text) color.
boolean	isVisited() Provides the info whether the link has already been visited.
protected void	paintComponent(java.awt.Graphics g) Draws the component based on the current settings.
void	setActiveForeground(java.awt.Color active) Sets the active foreground (text) color.
void	setDrawUnderline(boolean drawUnderline) Sets the info whether to draw an underline or not.
void	setForeground(java.awt.Color foreground) Sets the normal foreground (text) color.
void	setRememberVisited(boolean enable) Remember visited links (drawn in other color)?
void	setShowURIToolTip(boolean enable) Show URI as tooltip?
void	setText(java.lang.String text) Sets the button text.
void	setURI(java.net.URI uri) Sets the link target which is also displayed as tooltip.
void	setVisited(boolean visited) Sets the info whether the link has already been visited.
void	setVisitedForeground(java.awt.Color visited) Sets the visited foreground (text) color.
void	updateUI() Resets the UI property to a value from the current look & feel.

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable

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, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setUI, setVerticalAlignment, 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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperlinkButton

public HyperlinkButton()

Creates a hyperlink button instance.

HyperlinkButton

public HyperlinkButton(java.lang.String text,
               javax.swing.Icon icon,
               java.lang.String uriTarget)

Creates a hyperlink button instance with a given link text, icon, and URI.

Remember that the text is converted into HTML if underline feature is enabled.

Parameters:

text - The text to be displayed as link, may be null

icon - The icon to be displayed, may be null

uriTarget - The URI to be opened, may be null

HyperlinkButton

public HyperlinkButton(java.lang.String text,
               javax.swing.Icon icon,
               java.net.URI uri)

Creates a hyperlink button instance with a given link text, icon, and URI.

Remember that the text is converted into HTML if underline feature is enabled.

Parameters:

text - The text to be displayed as link

icon - The icon to be displayed

uri - The URI to be opened

Method Detail

setURI

public void setURI(java.net.URI uri)

Sets the link target which is also displayed as tooltip.

If the underlying URI is not set (null) then no link is displayed but normal text.

Parameters:

uri - The URI to be opened, may be null

getURI

public java.net.URI getURI()

Provides the link target which is also displayed as tooltip.

Returns:

The URI to be opened, may be null

setVisited

public void setVisited(boolean visited)

Sets the info whether the link has already been visited.

Parameters:

visited - Visited link?

isVisited

public boolean isVisited()

Provides the info whether the link has already been visited.

Returns:

Visited link?

setForeground

public void setForeground(java.awt.Color foreground)

Sets the normal foreground (text) color.

Overrides:

setForeground in class javax.swing.JComponent

Parameters:

foreground - Foreground color

setActiveForeground

public void setActiveForeground(java.awt.Color active)

Sets the active foreground (text) color.

Parameters:

active - Foreground color

getActiveForeground

public java.awt.Color getActiveForeground()

Provides the active foreground (text) color.

Returns:

Foreground color

setVisitedForeground

public void setVisitedForeground(java.awt.Color visited)

Sets the visited foreground (text) color.

Parameters:

visited - Foreground color

getVisitedForeground

public java.awt.Color getVisitedForeground()

Provides the visited foreground (text) color.

Returns:

Foreground color

setDrawUnderline

public void setDrawUnderline(boolean drawUnderline)

Sets the info whether to draw an underline or not.

Parameters:

drawUnderline - Draw underline?

getDrawUnderline

public boolean getDrawUnderline()

Provides the info whether to draw an underline or not.

Returns:

Draw underline?

setText

public void setText(java.lang.String text)

Sets the button text.

Overrides:

setText in class javax.swing.AbstractButton

Parameters:

text - Text to be displayed

getPlainText

public java.lang.String getPlainText()

Provides the button text.

Returns:

Text to be displayed

updateUI

public void updateUI()

Resets the UI property to a value from the current look & feel.

Overrides:

updateUI in class javax.swing.JButton

paintComponent

protected void paintComponent(java.awt.Graphics g)

Draws the component based on the current settings.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - Graphics context

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Automatically called when the user clicks on the link.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Action event

getCursor

public java.awt.Cursor getCursor()

Provides the cursor for the hyperlink button.

Hand cursor if URL is specified, default cursor else.

Overrides:

getCursor in class java.awt.Component

Returns:

The cursor of the component

setRememberVisited

public void setRememberVisited(boolean enable)

Remember visited links (drawn in other color)?

Parameters:

enable - Remember?

getRememberVisited

public boolean getRememberVisited()

Remember visited links (drawn in other color)?

Returns:

Remember?

setShowURIToolTip

public void setShowURIToolTip(boolean enable)

Show URI as tooltip?

Parameters:

enable - URI tooltip?

getShowURIToolTip

public boolean getShowURIToolTip()

Show URI as tooltip?

Returns:

URI tooltip?