Package com.ebasetech.xi.api.controls
Interface IFrameControl
- All Superinterfaces:
BorderStyleProperties
,Control
,Element
,EventOwner
,MarginStyleProperties
,MessageContainer
,MessageProperties
,java.io.Serializable
,WebFormEventOwner
public interface IFrameControl extends Control, MessageProperties, BorderStyleProperties, MarginStyleProperties
-
Method Summary
Modifier and Type Method Description java.lang.String
getHeight()
Panel height.java.lang.String
getName()
java.lang.String
getReferrerPolicy()
java.lang.String
getSandboxExceptions()
java.lang.String
getSrc()
Text
getTitle()
java.lang.String
getWidth()
IFrame width This is equivalent to the CSS width property, and any valid value for this CSS property can be used when setting a value.boolean
isSandbox()
The sandbox attribute enables an extra set of restriction for the content in the framevoid
setHeight(java.lang.String height)
Sets the IFrame height, and is equivalent to the CSS height property and any valid value for this CSS property can be used.void
setName(java.lang.String name)
Set the target name attribute for the IFrame elementvoid
setReferrerPolicy(java.lang.String referrerPolicy)
Set the referer policy attribute for the IFrame element.void
setSandbox(boolean sandbox)
Set the sandbox attribute which enables an extra set of restriction for the content in the framevoid
setSandboxExceptions(java.lang.String sandboxExceptions)
Set space separated list of exceptions for the sandbox mode.void
setSrc(java.lang.String src)
Set src url of the IFramevoid
setWidth(java.lang.String width)
Set width of the IFrame element.Methods inherited from interface com.ebasetech.xi.api.controls.BorderStyleProperties
getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth
Methods inherited from interface com.ebasetech.xi.api.controls.Control
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show
Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties
getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin
Methods inherited from interface com.ebasetech.xi.api.MessageContainer
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
Methods inherited from interface com.ebasetech.xi.api.controls.MessageProperties
getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle
-
Method Details
-
getSrc
java.lang.String getSrc()- Returns:
- The src url of the IFrame
-
setSrc
void setSrc(java.lang.String src)Set src url of the IFrame -
getReferrerPolicy
java.lang.String getReferrerPolicy()- Returns:
- The referer policy attribute for the IFrame element
-
setReferrerPolicy
void setReferrerPolicy(java.lang.String referrerPolicy)Set the referer policy attribute for the IFrame element. no-referrer: The Referrer header will not be sent no-referrer-when-downgrade: The Referrer header will not be sent to origins with HTTPS origin: The sent referrer will be limited to the origin of the referring page. origin-when-cross-origin: The referrer sent to other origins will be limited to the scheme, the host, and the port. same-origin: A referrer will be sent for the same origin. strict-origin: Only send the origin of the document as the referrer when the protocol security level stays the same (http->https), but don't send it to a less secure destination (https->http). strict-origin-when-cross-origin: Send a full URL when performing a same-origin request, only send the origin when the protocol security level stays the same (http->https), and send no header to a less secure destination (https->http). unsafe-url: The referrer will include the origin and the path -
getName
java.lang.String getName()- Returns:
- The target name attribute for the IFrame element
-
setName
void setName(java.lang.String name)Set the target name attribute for the IFrame element -
getTitle
Text getTitle()- Returns:
- The title attribute for the IFrame element
-
isSandbox
boolean isSandbox()The sandbox attribute enables an extra set of restriction for the content in the frame- Returns:
- The sandbox attribute for the IFrame element
-
setSandbox
void setSandbox(boolean sandbox)Set the sandbox attribute which enables an extra set of restriction for the content in the frame -
getSandboxExceptions
java.lang.String getSandboxExceptions()- Returns:
- A space separated list of exceptions for the sandbox mode.
-
setSandboxExceptions
void setSandboxExceptions(java.lang.String sandboxExceptions)Set space separated list of exceptions for the sandbox mode. allow-forms: Allows the resource to submit forms. If this keyword is not used, form submission is blocked. allow-modals: Let the resource open modal windows. allow-orientation-lock: Lets the resource lock the screen orientation. allow-pointer-lock: Lets the resource use the Pointer Lock API allow-popups: Allow popups (e.g window.open()) allow-popups-to-escape-sandbox: Lets the sandboxed document open new windows without those windows inheriting the sandboxing. allow-presentation: Lets the resource start a presentation session. allow-same-origin: Allows the IFrame content to be treated as being from the same origin. allow-scripts: Allows running scripts. allow-top-navigation: Allows the IFrame content to navigate its top level browser content. -
getWidth
java.lang.String getWidth()IFrame width This is equivalent to the CSS width property, and any valid value for this CSS property can be used when setting a value.- Returns:
- Width of the IFrame element .
-
setWidth
void setWidth(java.lang.String width)Set width of the IFrame element. -
getHeight
java.lang.String getHeight()Panel height. This is equivalent to the CSS height property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setHeight(String)
-
setHeight
void setHeight(java.lang.String height)Sets the IFrame height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. Setting this property tonull
removes any existing value.Examples:
controls.IFRAME1.height = "50px"; controls.IFRAME1.setHeight("100px");
- Since:
- V4.4
-