We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.html.
Class IFrame
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.HtmlComponent
-
- com.vaadin.flow.component.html.IFrame
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasSize,HasStyle,Serializable@Tag("iframe") public class IFrame extends HtmlComponentComponent representing a
<iframe>element.Since:
1.3
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classIFrame.ImportanceTypeImportance types.
static classIFrame.SandboxTypeSandbox types.
-
Method Summary
All Methods Modifier and Type Method Description Optional<String>getAllow()Gets the value of allow attribute.
Optional<IFrame.ImportanceType>getImportance()Gets the importance attribute value.
Optional<String>getName()Gets the name attribute.
Optional<IFrame.SandboxType[]>getSandbox()Gets the list of sandbox attribute values.
StringgetSrc()Gets the source of the iframe.
Optional<String>getSrcdoc()Gets the srcdoc of the iframe.
voidreload()Reloads the IFrame.
voidsetAllow(String allow)Sets the allow property to specify a feature policy.
voidsetImportance(IFrame.ImportanceType importance)Sets the importance attribute to the specified
IFrame.ImportanceTypevalue.voidsetName(String name)Sets the name attribute.
voidsetSandbox(IFrame.SandboxType... types)Sets the sandbox attribute to the given
IFrame.SandboxTypes.voidsetSrc(String src)Sets the source of the iframe.
voidsetSrcdoc(String srcdoc)Sets the srcdoc of the iframe.
-
Methods inherited from class com.vaadin.flow.component.HtmlComponent
getTitle, setTitle
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
-
-
-
Constructor Detail
-
IFrame
public IFrame()Creates a new iframe.
-
IFrame
public IFrame(String src)Creates a new iframe with a source URL.
Parameters:
src- Source URL
-
-
Method Detail
-
setSrc
public void setSrc(String src)Sets the source of the iframe. If the contents at the src of the IFrame has changed and you want to refresh it in the user's browser, the src does not to be reset. In this case use the #reload() method.
Parameters:
src- Source URL.
-
getSrc
public String getSrc()Gets the source of the iframe.
Returns:
the source of the iframe.
-
setSrcdoc
public void setSrcdoc(String srcdoc)Sets the srcdoc of the iframe.
Parameters:
srcdoc- srcdoc URL.
-
getSrcdoc
public Optional<String> getSrcdoc()Gets the srcdoc of the iframe.
Returns:
the srcdoc of the iframe.
-
setAllow
public void setAllow(String allow)Sets the allow property to specify a feature policy.
Parameters:
allow- the allow attribute value.See Also:
-
getAllow
public Optional<String> getAllow()Gets the value of allow attribute.
Returns:
the currently applied allow value.
-
setName
public void setName(String name)Sets the name attribute.
Parameters:
name- the value for the name attribute.
-
setImportance
public void setImportance(IFrame.ImportanceType importance)Sets the importance attribute to the specified
IFrame.ImportanceTypevalue.Parameters:
importance-IFrame.ImportanceTypevalue.See Also:
-
getImportance
public Optional<IFrame.ImportanceType> getImportance()Gets the importance attribute value.
Returns:
the importance value.
See Also:
-
setSandbox
public void setSandbox(IFrame.SandboxType... types)Sets the sandbox attribute to the given
IFrame.SandboxTypes.Parameters:
types-IFrame.SandboxTypes.
-
getSandbox
public Optional<IFrame.SandboxType[]> getSandbox()Gets the list of sandbox attribute values.
Returns:
the current
IFrame.SandboxTypes.
-
reload
public void reload()Reloads the IFrame.
-
-