com.haulmont.cuba.gui.components

Interface BrowserFrame

All Superinterfaces:

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

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 and Description
static class	BrowserFrame.Allow Standard values of the attribute allow of iframe HTML element.
static class	BrowserFrame.ReferrerPolicy Standard values of the attribute referrerpolicy of iframe HTML element.
static class	BrowserFrame.Sandbox Standard values of the attribute sandbox of iframe HTML element.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ResourceView

ResourceView.HasMimeType, ResourceView.HasStreamSettings, ResourceView.SourceChangeEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAllow()
java.lang.String	getReferrerPolicy()
java.lang.String	getSandbox()
java.lang.String	getSrcdoc()
void	setAllow(BrowserFrame.Allow allow) Sets value of the attribute allow.
void	setAllow(java.util.EnumSet<BrowserFrame.Allow> allowSet) Sets value of the attribute allow.
void	setAllow(java.lang.String value) Sets value of the attribute allow.
void	setReferrerPolicy(BrowserFrame.ReferrerPolicy referrerPolicy) Sets value of the attribute referrerpolicy.
void	setReferrerPolicy(java.lang.String value) Sets value of the attribute referrerpolicy.
void	setSandbox(BrowserFrame.Sandbox sandbox) Sets value of the attribute sandbox.
void	setSandbox(java.util.EnumSet<BrowserFrame.Sandbox> sandboxSet) Sets value of the attribute sandbox.
void	setSandbox(java.lang.String value) Sets value of the attribute sandbox.
void	setSrcdoc(java.lang.String value) Sets value of the attribute srcdoc.

Methods inherited from interface com.haulmont.cuba.gui.components.ResourceView

addSourceChangeListener, createResource, getAlternateText, getSource, removeSourceChangeListener, setAlternateText, setSource, setSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getSandbox

java.lang.String getSandbox()

Returns:

value of the attribute sandbox

setSandbox

void setSandbox(java.lang.String value)

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

Parameters:

value - sandbox

setSandbox

void setSandbox(BrowserFrame.Sandbox sandbox)

Sets value of the attribute sandbox.

Parameters:

sandbox - sandbox

setSandbox

void setSandbox(java.util.EnumSet<BrowserFrame.Sandbox> sandboxSet)

Sets value of the attribute sandbox.

Parameters:

sandboxSet - EnumSet of BrowserFrame.Sandbox

setSrcdoc

void setSrcdoc(java.lang.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

java.lang.String getSrcdoc()

Returns:

value of the attribute srcdoc

setAllow

void setAllow(java.lang.String value)

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

Parameters:

value - allow

setAllow

void setAllow(BrowserFrame.Allow allow)

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

Parameters:

allow - allow

setAllow

void setAllow(java.util.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

java.lang.String getAllow()

Returns:

value of the attribute allow

getReferrerPolicy

java.lang.String getReferrerPolicy()

Returns:

value of the attribute referrerpolicy

setReferrerPolicy

void setReferrerPolicy(java.lang.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

void setReferrerPolicy(BrowserFrame.ReferrerPolicy referrerPolicy)

Sets value of the attribute referrerpolicy.

Parameters:

referrerPolicy - referrerpolicy