com.nomagic.magicdraw.hyperlinks.ui

Interface HyperlinkEditor

All Known Implementing Classes:

HyperlinkEditorPanel

@OpenApiAll
public interface HyperlinkEditor

Hyperlink editor.

Method Summary

Modifier and Type	Method and 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) Set favorite hyperlinks.
void	setHyperlink(Hyperlink link) Set hyperlink to edit.

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

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

Set favorite hyperlinks. Editor can show favorite hyperlinks.

Parameters:

favorites - favorite hyperlinks.

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.