com.zfqjava.swing
Class JLinkButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      com.zfqjava.swing.JLinkButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public class JLinkButton
extends JButton

JLinkButton provides a button can launch a URL.

See Also:

Serialized Form

Nested Class Summary

protected class

JLinkButton.AccessibleJLinkButton This class implements accessibility support for the JLinkButton class.

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

JButton.AccessibleJButton

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int	ALWAYS_UNDERLINE Identifies the always underline behavior of the link text.
static int	HOVER_UNDERLINE Identifies the hover underline behavior of the link text.
static int	NEVER_UNDERLINE Identifies the nerver underline behavior of the link text.
static int	SYSTEM_DEFAULT Identifies the default behavior of the link text.

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

JLinkButton()
Creates a button with no set text or icon or URL.

JLinkButton(Action a)
Creates a button where properties are taken from the Action supplied.

JLinkButton(Icon icon)
Creates a link button with an icon.

JLinkButton(Icon icon, URL url)
Creates a button with the icon and the URL.

JLinkButton(String text)
Creates a button with where text are taken from the URL.

JLinkButton(String text, Icon icon, URL url)
Creates a button with initial text and an icon.

JLinkButton(String text, URL url)
Creates a button with the text and the URL.

JLinkButton(URL url)
Creates a button with where text are taken from the URL.

Method Summary

protected Action	createDefaultAction() Creates a action handler to handle this button's action event.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JLinkButton.
Color	getActiveLinkColor() Returns the active link color.
Action	getDefaultAction() Returns the default action handler of this button.
Color	getDisabledLinkColor() Returns the disabled link color.
int	getLinkBehavior() Returns the current link behaviro of this JLinkButton.
Color	getLinkColor() Returns the link color.
URL	getLinkURL() Returns the URL that this button linked.
String	getUIClassID() Returns a string that specifies the name of the L&F class that renders this component.
Color	getVisitedLinkColor() Returns the visited link color.
boolean	isLinkVisited() Returns true if this link URL has been visited, otherwise return false;
protected String	paramString() Returns a string representation of this JLinkButton.
void	setActiveLinkColor(Color activeColor) Sets the active link color.
void	setDefaultAction(Action action) Sets the action that will handle this button's action event.
void	setDisabledLinkColor(Color disabledColor) Sets the disabled link color.
void	setLinkBehavior(int behavior) Sets this JLinkButton link behavior.
void	setLinkColor(Color color) Sets the link color.
void	setLinkURL(URL url) Sets the URL that this button linked.
void	setLinkVisited(boolean isVisited) Sets the linkVisited property, default is false.
protected void	setupToolTipText() Setup the tool tip text when the link URL changed.
void	setVisitedLinkColor(Color visitedColor) Sets the visited link color.
void	updateUI() Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JButton

isDefaultButton, isDefaultCapable, 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, setText, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, 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

ALWAYS_UNDERLINE

public static final int ALWAYS_UNDERLINE

Identifies the always underline behavior of the link text.

See Also:

Constant Field Values

HOVER_UNDERLINE

public static final int HOVER_UNDERLINE

Identifies the hover underline behavior of the link text.

See Also:

Constant Field Values

NEVER_UNDERLINE

public static final int NEVER_UNDERLINE

Identifies the nerver underline behavior of the link text.

See Also:

Constant Field Values

SYSTEM_DEFAULT

public static final int SYSTEM_DEFAULT

Identifies the default behavior of the link text.

See Also:

Constant Field Values

Constructor Detail

JLinkButton

public JLinkButton()

Creates a button with no set text or icon or URL.

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(Action a)

Creates a button where properties are taken from the Action supplied.

Parameters:

a - the Action used to specify the new button

Since:

1.3

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(Icon icon)

Creates a link button with an icon.

Parameters:

icon - the Icon image to display on the link button

JLinkButton

public JLinkButton(String text)

Creates a button with where text are taken from the URL.

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(URL url)

Creates a button with where text are taken from the URL.

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(String text,
                   URL url)

Creates a button with the text and the URL.

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(Icon icon,
                   URL url)

Creates a button with the icon and the URL.

See Also:

JLinkButton(java.lang.String, javax.swing.Icon, java.net.URL)

JLinkButton

public JLinkButton(String text,
                   Icon icon,
                   URL url)

Creates a button with initial text and an icon.

Parameters:

text - the text of the button

icon - the Icon image to display on the button

Method Detail

updateUI

public void updateUI()

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

Overrides:

updateUI in class JButton

See Also:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Returns a string that specifies the name of the L&F class that renders this component.

Overrides:

getUIClassID in class JButton

Returns:

the string "LinkButtonUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setupToolTipText

protected void setupToolTipText()

Setup the tool tip text when the link URL changed. If the link URL not null, use it's toExternalForm method get string as current tool tip text. If you can't use this automatic feature, overide this method, do nothing.

setLinkBehavior

public void setLinkBehavior(int behavior)

Sets this JLinkButton link behavior. One of the 4 legal values:

• JLinkButton.ALWAYS_UNDERLINE
• JLinkButton.HOVER_UNDERLINE
• JLinkButton.NEVER_UNDERLINE
• JLinkButton.SYSTEM_DEFAULT

  Parameters:

  behavior - the link behavior type

  Throws:

  IllegalArgumentException - if the behavior illegal

  See Also:

  getLinkBehavior()

getLinkBehavior

public int getLinkBehavior()

Returns the current link behaviro of this JLinkButton. One of the 4 legal values:

• JLinkButton.ALWAYS_UNDERLINE
• JLinkButton.HOVER_UNDERLINE
• JLinkButton.NEVER_UNDERLINE
• JLinkButton.SYSTEM_DEFAULT

  Returns:

  the link behavior type

  See Also:

  setLinkBehavior(int)

setLinkColor

public void setLinkColor(Color color)

Sets the link color.

Parameters:

color - the link color

See Also:

getLinkColor()

getLinkColor

public Color getLinkColor()

Returns the link color.

Returns:

the link color

See Also:

setLinkColor(java.awt.Color)

setActiveLinkColor

public void setActiveLinkColor(Color activeColor)

Sets the active link color.

Parameters:

activeColor - the active link color

See Also:

getActiveLinkColor()

getActiveLinkColor

public Color getActiveLinkColor()

Returns the active link color.

Returns:

the active link color

See Also:

setActiveLinkColor(java.awt.Color)

setDisabledLinkColor

public void setDisabledLinkColor(Color disabledColor)

Sets the disabled link color.

Parameters:

disabledColor - the disabled link color

See Also:

getDisabledLinkColor()

getDisabledLinkColor

public Color getDisabledLinkColor()

Returns the disabled link color.

Returns:

the disabled link color

See Also:

setDisabledLinkColor(java.awt.Color)

setVisitedLinkColor

public void setVisitedLinkColor(Color visitedColor)

Sets the visited link color.

Parameters:

visitedColor - the visited link color

See Also:

getVisitedLinkColor()

getVisitedLinkColor

public Color getVisitedLinkColor()

Returns the visited link color.

Returns:

the visited link color

See Also:

setVisitedLinkColor(java.awt.Color)

getLinkURL

public URL getLinkURL()

Returns the URL that this button linked.

Returns:

the URL that this button linked

See Also:

getLinkURL()

setLinkURL

public void setLinkURL(URL url)

Sets the URL that this button linked.

Parameters:

url - the URL that this button linked

See Also:

getLinkURL()

setLinkVisited

public void setLinkVisited(boolean isVisited)

Sets the linkVisited property, default is false.

Parameters:

isVisited - the visited state

See Also:

isLinkVisited()

isLinkVisited

public boolean isLinkVisited()

Returns true if this link URL has been visited, otherwise return false;

Returns:

true if this link URL has been visited, otherwise return false

See Also:

setLinkVisited(boolean)

setDefaultAction

public void setDefaultAction(Action action)

Sets the action that will handle this button's action event.

Parameters:

action - the action handler to use

See Also:

getDefaultAction()

getDefaultAction

public Action getDefaultAction()

Returns the default action handler of this button.

Returns:

the default action handler

See Also:

setDefaultAction(javax.swing.Action)

createDefaultAction

protected Action createDefaultAction()

Creates a action handler to handle this button's action event.

paramString

protected String paramString()

Returns a string representation of this JLinkButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class JButton

Returns:

a string representation of this JLinkButton.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JLinkButton. For JLinkButtons, the AccessibleContext takes the form of an AccessibleJLinkButton. A new AccessibleJLinkButton instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JButton

Returns:

an AccessibleJLinkButton that serves as the AccessibleContext of this JLinkButton