Oxygen XML Editor 15.0 Author API

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

java.lang.Object
  extended by ro.sync.ecss.extensions.api.component.listeners.OpenURLHandler

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class OpenURLHandler
extends java.lang.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
OpenURLHandler()
           
 
Method Summary
 void handleOpenURL(java.net.URL toOpen)
          An attempt is made to open an URL.
 void handleOpenURLAsDITAMapTree(java.net.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 Detail

OpenURLHandler

public OpenURLHandler()
Method Detail

handleOpenURL

public void handleOpenURL(java.net.URL toOpen)
                   throws java.io.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:
java.io.IOException

handleOpenURLAsDITAMapTree

public void handleOpenURLAsDITAMapTree(java.net.URL toOpen)
                                throws java.io.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:
java.io.IOException
Since:
15

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


Oxygen XML Editor 15.0 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.