Package com.nomagic.magicdraw.hyperlinks.ui

Interface HyperlinkEditor

All Known Implementing Classes:

HyperlinkEditorPanel

@OpenApiAll
public interface HyperlinkEditor

Hyperlink editor.

Method Summary

Modifier and Type	Method	Description
java.awt.Component	getComponent()	Get editor component.
Hyperlink	getHyperlink(java.lang.String text)	Get edited hyperlink.
java.lang.String	getTitle()	Get editor title.
boolean	isProjectScope()	If edited hyperlink is of project scope.
void	setFavorites(java.util.List<Hyperlink> favorites)	Deprecated.
void	setHyperlink(Hyperlink link)	Set hyperlink to edit.
default void	setOptions(HyperlinkEditorOptions options)	Set options which can be used in editor editor;

Method Detail

getTitle

java.lang.String getTitle()

Get editor title.

Returns:

title string.

getComponent

java.awt.Component getComponent()

Get editor component.

Returns:

component.

getHyperlink

@CheckForNull
Hyperlink getHyperlink(java.lang.String text)

Get edited hyperlink.

Parameters:

text - hyperlink text.

Returns:

hyperlink.

setHyperlink

void setHyperlink(Hyperlink link)

Set hyperlink to edit.

Parameters:

link - hyperlink.

setFavorites

@Deprecated
void setFavorites(java.util.List<Hyperlink> favorites)

Deprecated.

Set favorite hyperlinks. Editor can show favorite hyperlinks.

Deprecated Use setOptions(com.nomagic.magicdraw.hyperlinks.ui.HyperlinkEditorOptions)

Parameters:

favorites - favorite hyperlinks.

setOptions

default void setOptions(@CheckForNull
                        HyperlinkEditorOptions options)

Set options which can be used in editor editor;

Parameters:

options - hyperlink editor options

isProjectScope

boolean isProjectScope()

If edited hyperlink is of project scope. Used to calculate favorite hyperlinks storage - project hyperlink is stored in project, non project hyperlink is stored in environment.

Returns:

true if hyperlink is project specific, false - environment specific.