Package nl.nikhef.jgridstart.gui.util

Class URLLauncher

java.lang.Object

nl.nikhef.jgridstart.gui.util.URLLauncher

Direct Known Subclasses:

URLLauncherCertificate

public class URLLauncher
extends Object

URL Handler to external webbrowser and Action invocation.

This method is used to handle opening of URLs. All URLs are opened with an external web browser via BrowserFactory, but action: URLs are handled specially.

An action: URL activates an Actions actionPerformed method, so it is equivalent to selecting a menu item or pressing a button. Before an action can be called as URL, it must be made known using addAction(java.lang.String, javax.swing.Action), for example:

   class CoolAction extends AbstractAction {
     public CoolAction() {
       super();
       putValue(NAME, "Cool thing...");
       URLLauncher.addAction("cool", this);
     }
     public void actionPerformed(ActionEvent e) {
       System.out.println("Cool down "+e.getActionCommand());
     }
   }
 

It is then possible to launch the action by invoking URLLauncher.openURL("action:cool").

Actions can have an argument specified in brackets, which sets the ActionEvent's command. So when URLLauncher.openURL("action:cool(please)") would be invoked, CoolAction's actionPerformed method would print "Cool down please".

The API is compatible with BareBonesBrowserLaunch (original version), so this could be used as a drop-in replacement to add action-handling.

Author:

wvengen

Field Summary

Fields

Modifier and Type	Field	Description
protected static HashMap<String,Action>	actions	list of registered actions

Constructor Summary

Constructors

Constructor	Description
URLLauncher()

Method Summary

Modifier and Type	Method	Description
static void	addAction(String name, Action a)	Add an Action to the list of recognised actions.
static Action	getAction(String name)	Return a previously added action
static void	openURL(String surl)	Open a string URL
static void	openURL(String surl, Component parent)	Open a string URL
static void	openURL(URL url)	Open an URL
static void	openURL(URL url, Component parent)	Open a URL
static void	performAction(String action, Component parent)	Perform an action.
protected static void	runBrowser(String location, Component parent)	Open the URL in an external web browser.

Methods inherited from class java.lang.Object

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

Field Detail

actions

protected static HashMap<String,Action> actions

list of registered actions

Constructor Detail

URLLauncher

public URLLauncher()

Method Detail

runBrowser

protected static void runBrowser(String location,
                                 Component parent)

Open the URL in an external web browser.

openURL

public static void openURL(URL url,
                           Component parent)

Open a URL

Parameters:

url - url to open

parent - parent component for error dialog

openURL

public static void openURL(String surl,
                           Component parent)

Open a string URL

Parameters:

surl - url to open (as String)

parent - parent component for error dialog

openURL

public static void openURL(URL url)

Open an URL

This is equal to openURL(url, null) so any error dialog will have no parent.

Parameters:

url - url to open

openURL

public static void openURL(String surl)

Open a string URL

This is equal to openURL(url, null) so any error dialog will have no parent.

Parameters:

surl - url to open (as String)

performAction

public static void performAction(String action,
                                 Component parent)

Perform an action.

This method is called for each action: URL, it calls ActionListener.actionPerformed(java.awt.event.ActionEvent) of the specified action.

If the action is not found in the list of known actions, an error dialog is shown.

Parameters:

action - name of action to perform

parent - parent

addAction

public static void addAction(String name,
                             Action a)

Add an Action to the list of recognised actions.

It is suggested to run this in an Action's constructor like this:

   class MyAction extends AbstractAction {
     
     public MyAction() {
       super("MyAction");
       ActionHandler.addAction("myaction", this);
     }
     
     public void actionPerformed(ActionEvent e) {
       // ...
     }
   }
 

See also this class's description.

Parameters:

name - name in url, e.g. "myaction" to respond to url "action:myaction"

a - Action to perform when url is opened

getAction

public static Action getAction(String name)

Return a previously added action