Package ca.corbett.extras.io

Class HyperlinkUtil.BrowseAction

java.lang.Object

javax.swing.AbstractAction

ca.corbett.extras.io.HyperlinkUtil.BrowseAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Enclosing class:

HyperlinkUtil

public static class HyperlinkUtil.BrowseAction
extends AbstractAction

If the current JRE supports browsing, this action will open the given URI in the user's default browser. This is equivalent to invoking one of the openHyperlink methods, but in a convenient Action form for use with buttons, menu items, etc.

By default, the name of this action is set to the String representation of the given URI. You can change the name later by calling setName(). For example:

 // Creates an action with a name equal to the URI string:
 HyperlinkUtil.BrowseAction browseAction =
       HyperlinkUtil.BrowseAction.of(new URI(someValidUrl));

 // Update the name to something more user-friendly:
 browseAction.setName("Visit our website!");
 

See Also:

• Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Opens our configured hyperlink when invoked.
String	getName()	Returns the name of this action.
static HyperlinkUtil.BrowseAction	of(String urlString)	Creates a new BrowseAction for the given URL string and with no popup dialog.
static HyperlinkUtil.BrowseAction	of(String urlString, Component owner)	Creates a new BrowseAction for the given URL string and the given owner Component for showing popup dialogs.
static HyperlinkUtil.BrowseAction	of(URI uri)	Creates a new BrowseAction for the given URI and with no popup dialog.
static HyperlinkUtil.BrowseAction	of(URI uri, Component owner)	Creates a new BrowseAction for the given URI and the given owner Component for showing popup dialogs.
static HyperlinkUtil.BrowseAction	of(URL url)	Creates a new BrowseAction for the given URL and with no popup dialog.
static HyperlinkUtil.BrowseAction	of(URL url, Component owner)	Creates a new BrowseAction for the given URL and the given owner Component for showing popup dialogs.
HyperlinkUtil.BrowseAction	setName(String name)	Allows modifying the name of this action after creation.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept

Method Details

setName

public HyperlinkUtil.BrowseAction setName(String name)

Allows modifying the name of this action after creation.

getName

public String getName()

Returns the name of this action.

of

public static HyperlinkUtil.BrowseAction of(URI uri)

Creates a new BrowseAction for the given URI and with no popup dialog.

of

public static HyperlinkUtil.BrowseAction of(URL url)

Creates a new BrowseAction for the given URL and with no popup dialog.

of

public static HyperlinkUtil.BrowseAction of(String urlString)

Creates a new BrowseAction for the given URL string and with no popup dialog.

of

public static HyperlinkUtil.BrowseAction of(URI uri,
 Component owner)

Creates a new BrowseAction for the given URI and the given owner Component for showing popup dialogs.

of

public static HyperlinkUtil.BrowseAction of(URL url,
 Component owner)

Creates a new BrowseAction for the given URL and the given owner Component for showing popup dialogs.

of

public static HyperlinkUtil.BrowseAction of(String urlString,
 Component owner)

Creates a new BrowseAction for the given URL string and the given owner Component for showing popup dialogs.

actionPerformed

public void actionPerformed(ActionEvent e)

Opens our configured hyperlink when invoked.