Package com.nomagic.magicdraw.hyperlinks

Interface HyperlinkHandler

All Superinterfaces:

ProtocolSupport

@OpenApiAll
public interface HyperlinkHandler
extends ProtocolSupport

Handle the hyperlink. The handler should be registered in HyperlinksHandlersRegistry

See Also:

• HyperlinksHandlersRegistry

Method Summary

Modifier and Type	Method	Description
void	activate(Element element, Hyperlink link)	Activate given hyperlink.
default Hyperlink	create(String text, String url)	Deprecated. use create(String, String, Project)
default Hyperlink	create(String text, String url, Project context)	Create hyperlink.
HyperlinkEditor	getEditor()	Get hyperlink editor.
Icon	getIcon(Hyperlink link)	Get hyperlink icon.

Methods inherited from interface com.nomagic.magicdraw.hyperlinks.ProtocolSupport

isSupportedProtocol

Method Details

getIcon

@CheckForNull
Icon getIcon(Hyperlink link)

Get hyperlink icon.

Parameters:

link - hyperlink

Returns:

icon

create

@CheckForNull
default Hyperlink create(@CheckForNull
 String text,
 String url,
 @CheckForNull
 Project context)

Create hyperlink.

Parameters:

text - hyperlink text

url - hyperlink URL

context - project

Returns:

created hyperlink

create

@CheckForNull
@Deprecated
default Hyperlink create(@CheckForNull
 String text,
 String url)

Deprecated.

use create(String, String, Project)

Create hyperlink.

Parameters:

text - hyperlink text

url - hyperlink URL

Returns:

created hyperlink

getEditor

@CheckForNull
HyperlinkEditor getEditor()

Get hyperlink editor.

Returns:

hyperlink editor

activate

void activate(@CheckForNull
 Element element,
 Hyperlink link)

Activate given hyperlink.

Parameters:

element - hyperlink owner

link - hyperlink to activate