com.vaadin.flow.component.html.
Class IFrame
All Implemented Interfaces:
AttachNotifier
, DetachNotifier
, HasAriaLabel
, HasElement
, HasSize
, HasStyle
, Serializable
Component representing a <iframe>
element.
Since:
1.3
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Importance types.
static enum
Sandbox types.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAllow()
Gets the value of allow attribute.
Gets the importance attribute value.
getName()
Gets the name attribute.
Gets the list of sandbox attribute values.
getSrc()
Gets the source of the iframe.
Gets the srcdoc of the iframe.
void
reload()
Reloads the IFrame.
void
Sets the allow property to specify a feature policy.
void
setImportance
(IFrame.ImportanceType importance) Sets the importance attribute to the specified
IFrame.ImportanceType
value.void
Sets the name attribute.
void
setSandbox
(IFrame.SandboxType... types) Sets the sandbox attribute to the given
IFrame.SandboxType
s.void
Sets the source of the iframe.
void
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, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, 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.HasAriaLabel
getAriaLabel, getAriaLabelledBy, setAriaLabel, setAriaLabelledBy
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 Details
-
IFrame
public IFrame()Creates a new iframe.
-
IFrame
Creates a new iframe with a source URL.
Parameters:
src
- Source URL
-
-
Method Details
-
setSrc
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
Gets the source of the iframe.
Returns:
the source of the iframe.
-
setSrcdoc
Sets the srcdoc of the iframe.
Parameters:
srcdoc
- srcdoc URL. -
getSrcdoc
Gets the srcdoc of the iframe.
Returns:
the srcdoc of the iframe.
-
setAllow
Sets the allow property to specify a feature policy.
Parameters:
allow
- the allow attribute value.See Also:
-
getAllow
Gets the value of allow attribute.
Returns:
the currently applied allow value.
-
setName
Sets the name attribute.
Parameters:
name
- the value for the name attribute. -
getName
Gets the name attribute.
Returns:
the name attribute.
-
setImportance
Sets the importance attribute to the specified
IFrame.ImportanceType
value.Parameters:
importance
-IFrame.ImportanceType
value.See Also:
-
getImportance
Gets the importance attribute value.
Returns:
the importance value.
See Also:
-
setSandbox
Sets the sandbox attribute to the given
IFrame.SandboxType
s.Parameters:
types
-IFrame.SandboxType
s. -
getSandbox
Gets the list of sandbox attribute values.
Returns:
the current
IFrame.SandboxType
s. -
reload
public void reload()Reloads the IFrame.
-