Class: LinkOpenedEvent

sync.api.Editor.LinkOpenedEvent

new LinkOpenedEvent(url, external, paramsopt, linkTargetopt)

Link opened event.

Example of listening for this event:

goog.events.listen(editor, sync.api.Editor.EventTypes.LINK_OPENED, function(e) {
  // e is of type sync.api.Editor.LinkOpenedEvent
});
Parameters:
Name Type Attributes Description
url string The URL to be opened or a #fragment. The syntax of the anchor is interpreted by the ElementLocatorProvider (java API) provided by the framework.
external boolean Whether the link should be opened in an external application.
params object <optional>
The parameters to pass to the new editor.
linkTarget sync.api.Editor.LinkOpenedEvent.Target <optional>
The target of the link. Specifies whether to open the link in a new window or in the current one.
Source:

Members

(static) Target

Properties:
Name Type Description
SELF The link will be opened in the current window.
BLANK The link will be opened in a new window.
Source:

$actualUrl :string

The actual URL that will be opened. EXPERIMENTAL (subject to change).
Type:
  • string
Source:

external :boolean

Flag indicating whether the link is an external one, e.g. to a web page.
Type:
  • boolean
Source:

linkTarget :sync.api.Editor.LinkOpenedEvent.Target

Used to determine if a link should be opened in the current window or in a new one.
Type:
Source:

params :Object.<string, string>

Key-value mapping that contains parameters that will be passed to the new editor in case it is opened in the oXygen XML WebApp.
Type:
  • Object.<string, string>
Source:

url :string

The URL that will be opened.
Type:
  • string
Source:

Methods

$setActualUrl($actualUrl)

Sets the actual URL to be opened for this event. EXPERIMENTAL (subject to change).
Parameters:
Name Type Description
$actualUrl string The actual URL that will be opened.
Source: