Package io.jmix.ui.component

Interface BrowserFrame

All Superinterfaces:

Component, Component.HasCaption, Component.HasDescription, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, ResourceView

All Known Implementing Classes:

BrowserFrameImpl

@StudioComponent(caption="BrowserFrame",
                 category="Components",
                 xmlElement="browserFrame",
                 icon="io/jmix/ui/icon/component/browserFrame.svg",
                 canvasIconSize=LARGE,
                 canvasIcon="io/jmix/ui/icon/component/browserFrame_canvas.png",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/browser-frame.html")
public interface BrowserFrame
extends ResourceView

A component displaying an embedded web page. Implemented as a HTML iframe element.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BrowserFrame.Allow	Standard values of the attribute allow of iframe HTML element.
static enum	BrowserFrame.ReferrerPolicy	Standard values of the attribute referrerpolicy of iframe HTML element.
static enum	BrowserFrame.Sandbox	Standard values of the attribute sandbox of iframe HTML element.

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

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

HasContextHelp.ContextHelpIconClickEvent

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

ResourceView.HasMimeType, ResourceView.HasStreamSettings, ResourceView.SourceChangeEvent

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	getAllow()
String	getReferrerPolicy()
String	getSandbox()
String	getSrcdoc()
default void	reset()	Resets the component source and disposes of the corresponding resource.
void	setAllow(BrowserFrame.Allow allow)	Sets value of the attribute allow.
void	setAllow(String value)	Sets value of the attribute allow.
void	setAllow(EnumSet<BrowserFrame.Allow> allowSet)	Sets value of the attribute allow.
void	setReferrerPolicy(BrowserFrame.ReferrerPolicy referrerPolicy)	Sets value of the attribute referrerpolicy.
void	setReferrerPolicy(String value)	Sets value of the attribute referrerpolicy.
void	setSandbox(BrowserFrame.Sandbox sandbox)	Sets value of the attribute sandbox.
void	setSandbox(String value)	Sets value of the attribute sandbox.
void	setSandbox(EnumSet<BrowserFrame.Sandbox> sandboxSet)	Sets value of the attribute sandbox.
void	setSrcdoc(String value)	Sets value of the attribute srcdoc.

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.HasCaption

getCaption, setCaption

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

getDescription, setDescription

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

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

addSourceChangeListener, getAlternateText, getSource, setAlternateText, setSource, setSource

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

reset

default void reset()

Resets the component source and disposes of the corresponding resource.

getSandbox

@Nullable
String getSandbox()

Returns:

value of the attribute sandbox

setSandbox

void setSandbox(@Nullable
 String value)

Sets value of the attribute sandbox. This attribute applies extra restrictions to the content in the frame.

Parameters:

value - sandbox

setSandbox

@StudioProperty(type=ENUMERATION,
                options={"allow-forms","allow-modals","allow-orientation-lock","allow-pointer-lock","allow-popups","allow-popups-to-escape-sandbox","allow-presentation","allow-same-origin","allow-scripts","allow-storage-access-by-user-activation","allow-top-navigation","allow-top-navigation-by-user-activation","allow-downloads-without-user-activation"})
void setSandbox(BrowserFrame.Sandbox sandbox)

Sets value of the attribute sandbox.

Parameters:

sandbox - sandbox

setSandbox

void setSandbox(@Nullable
 EnumSet<BrowserFrame.Sandbox> sandboxSet)

Sets value of the attribute sandbox.

Parameters:

sandboxSet - EnumSet of BrowserFrame.Sandbox

setSrcdoc

@StudioProperty(name="srcdoc",
                type=LOCALIZED_STRING)
void setSrcdoc(@Nullable
 String value)

Sets value of the attribute srcdoc. Inline HTML to embed, overriding the src attribute. You can also specify a value for the attribute srcdoc using attribute srcdocFile in xml by passing the path to the file with HTML code.

Parameters:

value - inline HTML code

getSrcdoc

@Nullable
String getSrcdoc()

Returns:

value of the attribute srcdoc

setAllow

void setAllow(@Nullable
 String value)

Sets value of the attribute allow. Specifies a feature policy for the iframe.

Parameters:

value - allow

setAllow

@StudioProperty(type=ENUMERATION,
                options={"autoplay","camera","document-domain","encrypted-media","fullscreen","geolocation","microphone","midi","payment","vr"})
void setAllow(BrowserFrame.Allow allow)

Sets value of the attribute allow. Specifies a feature policy for the iframe.

Parameters:

allow - allow

setAllow

void setAllow(@Nullable
 EnumSet<BrowserFrame.Allow> allowSet)

Sets value of the attribute allow. The value of the attribute can be a space-separated list of allow features.

Parameters:

allowSet - EnumSet of BrowserFrame.Allow

getAllow

@Nullable
String getAllow()

Returns:

value of the attribute allow

getReferrerPolicy

@Nullable
String getReferrerPolicy()

Returns:

value of the attribute referrerpolicy

setReferrerPolicy

void setReferrerPolicy(@Nullable
 String value)

Sets value of the attribute referrerpolicy. This attribute indicates which referrer to send when fetching the frame's resource

Parameters:

value - referrerpolicy

setReferrerPolicy

@StudioProperty(name="referrerpolicy",
                type=ENUMERATION,
                options={"no-referrer","no-referrer-when-downgrade","origin","origin-when-cross-origin","same-origin","strict-origin","strict-origin-when-cross-origin","unsafe-url"})
void setReferrerPolicy(BrowserFrame.ReferrerPolicy referrerPolicy)

Sets value of the attribute referrerpolicy.

Parameters:

referrerPolicy - referrerpolicy