net.sourceforge.doyen
Class URLLabel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLabel
                  net.sourceforge.doyen.URLLabel

All Implemented Interfaces:

Accessible, EventListener, ImageObserver, MenuContainer, MouseListener, MouseMotionListener, Serializable, SwingConstants

public class URLLabel

extends JLabel

implements MouseListener, MouseMotionListener

Label to display a URL and handle opening it in a browser Uses the BrowserLauncher component

Version:

$Revision: 1.1 $

Author:

David Carr

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JLabel

JLabel.AccessibleJLabel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

private int	mBegin The index of the beginning of the linked text
private int	mEnd The index after the linked text
private static Logger	mLogger Private storage for a reference to the Logger
private String	mURL The URL for the link

Fields inherited from class javax.swing.JLabel

labelFor

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.Container

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

URLLabel(String url)
Constructor for a URL with no other text

URLLabel(String url, String text)
Constructor for a url with different text (all of which is linked)

URLLabel(String url, String preText, String linkText, String postText)
Constructor for a url with text before and after the link text

Method Summary

private String	buildHTML(String preText, String linkText, String postText) Creates an HTML formatting for the specified text
private String	escapeChars(String str) Escapes chars for HTML (<, >)
private boolean	isWithinLink(Point p) Tests whether the specified point is within the link text section
void	mouseClicked(MouseEvent e) Handles clicks by opening the URL in the default browser
void	mouseDragged(MouseEvent e) Unused
void	mouseEntered(MouseEvent e) Sets the cursor appropriately
void	mouseExited(MouseEvent e) Sets the cursor appropriately
void	mouseMoved(MouseEvent e) Sets the cursor appropriately
void	mousePressed(MouseEvent e) Unused
void	mouseReleased(MouseEvent e) Unused

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

mURL

private String mURL

The URL for the link

mBegin

private int mBegin

The index of the beginning of the linked text

mEnd

private int mEnd

The index after the linked text

mLogger

private static Logger mLogger

Private storage for a reference to the Logger

Constructor Detail

URLLabel

public URLLabel(String url)

Constructor for a URL with no other text

Parameters:

url - the url

URLLabel

public URLLabel(String url,
                String text)

Constructor for a url with different text (all of which is linked)

Parameters:

url - the url

URLLabel

public URLLabel(String url,
                String preText,
                String linkText,
                String postText)

Constructor for a url with text before and after the link text

Parameters:

url - the url

preText - the text to display before the link

linkText - the text to link

postText - the text to display after the link

Method Detail

buildHTML

private String buildHTML(String preText,
                         String linkText,
                         String postText)

Creates an HTML formatting for the specified text

Parameters:

preText - the text before the link

linkText - the text to link (blue underlined)

postText - the text after the link

escapeChars

private String escapeChars(String str)

Escapes chars for HTML (<, >)

Parameters:

str - the string to escape

Returns:

the escaped string

mouseClicked

public void mouseClicked(MouseEvent e)

Handles clicks by opening the URL in the default browser

Specified by:

mouseClicked in interface MouseListener

Parameters:

e - the click event

mouseEntered

public void mouseEntered(MouseEvent e)

Sets the cursor appropriately

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - the event

mouseExited

public void mouseExited(MouseEvent e)

Sets the cursor appropriately

Specified by:

mouseExited in interface MouseListener

Parameters:

e - the event

mouseMoved

public void mouseMoved(MouseEvent e)

Sets the cursor appropriately

Specified by:

mouseMoved in interface MouseMotionListener

Parameters:

e - the event

isWithinLink

private boolean isWithinLink(Point p)

Tests whether the specified point is within the link text section

Parameters:

p - the point to test

Returns:

whether the point is within the link text

mousePressed

public void mousePressed(MouseEvent e)

Unused

Specified by:

mousePressed in interface MouseListener

Parameters:

e - the event

mouseReleased

public void mouseReleased(MouseEvent e)

Unused

Specified by:

mouseReleased in interface MouseListener

Parameters:

e - the event

mouseDragged

public void mouseDragged(MouseEvent e)

Unused

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

e - the event