Package ro.sync.ecss.extensions.api.component.listeners

Class OpenURLHandler

java.lang.Object

ro.sync.ecss.extensions.api.component.listeners.OpenURLHandler

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class OpenURLHandler
extends Object

Listener for URLs the user is trying to open from the Author Component. For example the user clicked on a link in the Author page.

Since:

12.2

Constructor Summary

Constructors

Constructor	Description
OpenURLHandler()

Method Summary

Modifier and Type	Method	Description
void	handleOpenURL(URL toOpen)	An attempt is made to open an URL.
void	handleOpenURLAsDITAMapTree(URL toOpen)	An attempt is made to open an URL as a DITA Map tree.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenURLHandler

public OpenURLHandler()

Method Details

handleOpenURL

public void handleOpenURL(URL toOpen)
                   throws IOException

An attempt is made to open an URL. For example a click was made in the Author page.

Parameters:

toOpen - The URL which should be opened by the developer's code.

Throws:

IOException

handleOpenURLAsDITAMapTree

public void handleOpenURLAsDITAMapTree(URL toOpen)
                                throws IOException

An attempt is made to open an URL as a DITA Map tree. For example a map is opened in the DITAMapTreeComponentProvider and the user double clicks a map referenced in the current map. By default this method delegates to handleOpenURL(URL) but it can be overwritten to open the URL as a DITAMapTreeComponentProvider.

Parameters:

toOpen - The URL which should be opened by the developer's code.

Throws:

IOException

Since:

15