Package io.jmix.ui.component

Interface Link

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

All Known Subinterfaces:

WebdavDocumentVersionLink

All Known Implementing Classes:

LinkImpl, WebdavDocumentVersionLinkImpl

@StudioComponent(caption="Link",
                 category="Components",
                 xmlElement="link",
                 icon="io/jmix/ui/icon/component/link.svg",
                 canvasBehaviour=LINK,
                 canvasText="New Link",
                 canvasTextProperty="caption",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/link.html")
public interface Link
extends Component, Component.HasCaption, Component.BelongToFrame, Component.HasIcon, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

HTML link component.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
String	getRel()
String	getTarget()
String	getUrl()
void	setRel(String rel)	Sets the relation between current document and the target document.
void	setTarget(String target)
void	setUrl(String url)

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

setUrl

@StudioProperty(type=LOCALIZED_STRING)
void setUrl(String url)

getUrl

@Nullable
String getUrl()

setTarget

@StudioProperty
void setTarget(String target)

getTarget

String getTarget()

setRel

@StudioProperty(defaultValue="noopener noreferrer")
void setRel(String rel)

Sets the relation between current document and the target document. Default value is "noopener noreferrer".

Parameters:

rel - string value of relation (e.g. noreferrer)

getRel

String getRel()

Returns:

string value of relation