qx.ui.embed
Class Iframe

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.ui.core.Widget
              qx.ui.basic.Terminator
                  qx.ui.embed.Iframe

public class Iframe
extends Terminator

Container widget for internal frames (iframes).

An iframe can display any HTML page inside the widget.

Field Summary

Fields inherited from class qx.ui.core.Widget

AUTO

Constructor Summary

Iframe()

Iframe(java.lang.String vSource)

Method Summary

void	_applyElement(java.lang.Object value, java.lang.Object old)
void	_applyFrameName(java.lang.Object value, java.lang.Object old, java.lang.Object propName, java.lang.Object uniqModIds)
void	_applyScrolling(java.lang.Object value, java.lang.Object old) Applies changes of the property value of the property scrolling.
void	_applySource(java.lang.Object value, java.lang.Object old)
void	_beforeAppear()
void	_beforeDisappear()
void	_generateBlockerElement()
void	_generateIframeElement(java.lang.String vFrameName) Creates an template iframe element and sets all required html and style properties.
void	_onload()
void	_syncScrolling() Sync scrolling property to the iframe DOM node.
void	_syncSource()
void	block() Cover the iframe with a transparent blocker div element.
java.lang.Object	getBlockerNode()
java.lang.Object	getContentDocument() Get the DOM document object of the iframe.
java.lang.Object	getContentWindow() Get the DOM window object of the iframe.
java.lang.String	getFrameName() Returns the (computed) value of the property frameName.
java.lang.Object	getIframeNode() Get the DOM element of the iframe.
java.lang.Object	getScrolling() Returns the (computed) value of the property scrolling.
java.lang.String	getSource() Returns the (computed) value of the property source.
void	initFrameName(java.lang.String arg) Calls the apply method and dispatches the change event of the property frameName with the default value defined by the class developer.
void	initScrolling(java.lang.Object arg) Calls the apply method and dispatches the change event of the property scrolling with the default value defined by the class developer.
void	initSource(java.lang.String arg) Calls the apply method and dispatches the change event of the property source with the default value defined by the class developer.
void	isLoaded()
java.lang.String	queryCurrentUrl() Returns the current (served) URL inside the iframe
void	release() Release the blocker set by block().
void	reload() Reload the contents of the iframe.
void	resetFrameName() Resets the user value of the property frameName.
void	resetScrolling() Resets the user value of the property scrolling.
void	resetSource() Resets the user value of the property source.
java.lang.Object	setBlockerNode(java.lang.Object vBlockerNode)
void	setFrameName(java.lang.String arg) Sets the user value of the property frameName.
void	setIframeNode(java.lang.Object vIframeNode) Change the DOM element of the iframe.
void	setScrolling(java.lang.Object arg) Sets the user value of the property scrolling.
void	setSource(java.lang.String arg) Sets the user value of the property source.

Methods inherited from class qx.ui.basic.Terminator

_computeBoxHeightFallback, _computeBoxWidthFallback, _computePreferredInnerHeight, _computePreferredInnerWidth, _isHeightEssential, _isWidthEssential, _layoutPost, _postApply, _renderContent, renderPadding

Methods inherited from class qx.ui.core.Widget

_afterAppear, _afterDisappear, _afterInsertDom, _afterRemoveDom, _applyAppearance, _applyBackgroundColor, _applyBackgroundImage, _applyBackgroundRepeat, _applyBorder, _applyBottom, _applyCapture, _applyClip, _applyCommand, _applyCursor, _applyDisplay, _applyElementData, _applyEnabled, _applyFocused, _applyFont, _applyHeight, _applyHideFocus, _applyHtmlAttributes, _applyHtmlProperties, _applyLeft, _applyMarginBottom, _applyMarginLeft, _applyMarginRight, _applyMarginTop, _applyMaxHeight, _applyMaxWidth, _applyMinHeight, _applyMinWidth, _applyOpacity, _applyOverflow, _applyPaddingBottom, _applyPaddingLeft, _applyPaddingRight, _applyPaddingTop, _applyParent, _applyRight, _applySelectable, _applyStateStyleFocus, _applyStyleProperties, _applyTabIndex, _applyTextColor, _applyTop, _applyVisibility, _applyWidth, _applyZIndex, _beforeInsertDom, _beforeRemoveDom, _checkParent, _compileClipString, _computeBoxHeight, _computeBoxWidth, _computeDisplayable, _computeFrameHeight, _computeFrameWidth, _computeHasAutoX, _computeHasAutoY, _computeHasFlexX, _computeHasFlexY, _computeHasPercentX, _computeHasPercentY, _computeInnerHeight, _computeInnerWidth, _computeOuterHeight, _computeOuterWidth, _computePreferredBoxHeight, _computePreferredBoxWidth, _computeValuePercentX, _computeValuePercentXLimit, _computeValuePercentY, _computeValuePercentYLimit, _computeValuePixel, _computeValuePixelLimit, _createElementImpl, _evalUnitsPixelPercent, _evalUnitsPixelPercentAuto, _evalUnitsPixelPercentAutoFlex, _flushJobQueue, _generateHtmlId, _getTargetNode, _handleDisplayable, _invalidateFrameDimensions, _invalidatePreferredInnerDimensions, _queueBorder, _recomputeFlexX, _recomputeFlexY, _recomputePercentX, _recomputePercentY, _recomputeRangeX, _recomputeRangeY, _recomputeStretchingX, _recomputeStretchingY, _recursiveAppearanceThemeUpdate, _renderAppearance, _renderOverflow, _resetAppearanceThemeWrapper, _styleBackgroundColor, _styleBackgroundImage, _styleFromMap, _unitDetectionPixelPercent, _unitDetectionPixelPercentAuto, _unitDetectionPixelPercentAutoFlex, _unstyleFromArray, _visualizeBlur, _visualizeFocus, _visualPropertyCheck, addState, addToDocument, addToJobQueue, addToLayoutChanges, addToQueue, addToQueueRuntime, addToStateQueue, auto, blur, connect, contains, disconnect, execute, focus, getActiveChild, getAllowStretchX, getAllowStretchY, getAnonymous, getAppearance, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBottom, getBottomValue, getCapture, getChildren, getChildrenLength, getClientHeight, getClientWidth, getClipHeight, getClipLeft, getClipTop, getClipWidth, getCommand, getContextMenu, getCursor, getDisplay, getDropDataTypes, getElement, getEnabled, getEnableElementFocus, getFocused, getFocusRoot, getFont, getHeight, getHeightValue, getHideFocus, getHorizontalAlign, getHtmlAttribute, getHtmlProperty, getLeft, getLeftValue, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getMinWidthValue, getNeededHeight, getNeededWidth, getNextActiveSibling, getNextSibling, getNextVisibleSibling, getOffsetHeight, getOffsetLeft, getOffsetTop, getOffsetWidth, getOpacity, getOverflow, getOverflowX, getOverflowY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPreviousActiveSibling, getPreviousSibling, getPreviousVisibleSibling, getRight, getRightValue, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectable, getStyleProperty, getSupportsDropMethod, getTabIndex, getTextColor, getToolTip, getTop, getTopLevelWidget, getTopValue, getVerticalAlign, getVisibility, getVisibleChildren, getVisibleChildrenLength, getWidth, getWidthValue, getZIndex, hasChildren, hasState, hasVisibleChildren, hide, indexOf, initAllowStretchX, initAllowStretchY, initAnonymous, initAppearance, initBackgroundColor, initBackgroundImage, initBackgroundRepeat, initBorder, initBottom, initCapture, initClipHeight, initClipLeft, initClipTop, initClipWidth, initCommand, initContextMenu, initCursor, initDisplay, initDropDataTypes, initElement, initEnabled, initEnableElementFocus, initFocused, initFont, initHeight, initHideFocus, initHorizontalAlign, initLeft, initMarginBottom, initMarginLeft, initMarginRight, initMarginTop, initMaxHeight, initMaxWidth, initMinHeight, initMinWidth, initOpacity, initOverflow, initPaddingBottom, initPaddingLeft, initPaddingRight, initPaddingTop, initParent, initRight, initSelectable, initSupportsDropMethod, initTabIndex, initTextColor, initToolTip, initTop, initVerticalAlign, initVisibility, initWidth, initZIndex, isAllowStretchX, isAllowStretchY, isAnonymous, isAppearRelevant, isCapture, isCreated, isDisplay, isDisplayable, isEmpty, isEnabled, isEnableElementFocus, isFirstChild, isFirstVisibleChild, isFocusable, isFocused, isFocusRoot, isHideFocus, isLastChild, isLastVisibleChild, isMaterialized, isSeeable, isSelectable, isVisibility, isVisibleEmpty, moveSelfAfter, moveSelfBefore, moveSelfToBegin, moveSelfToEnd, pack, recursiveAddToStateQueue, removeHtmlAttribute, removeHtmlProperty, removeState, removeStyleProperty, resetAlign, resetAllowStretchX, resetAllowStretchY, resetAnonymous, resetAppearance, resetBackgroundColor, resetBackgroundImage, resetBackgroundRepeat, resetBorder, resetBottom, resetCapture, resetClip, resetClipDimension, resetClipHeight, resetClipLeft, resetClipLocation, resetClipTop, resetClipWidth, resetCommand, resetContextMenu, resetCursor, resetDimension, resetDisplay, resetDropDataTypes, resetEdge, resetElement, resetEnabled, resetEnableElementFocus, resetFocused, resetFont, resetHeight, resetHeights, resetHideFocus, resetHorizontalAlign, resetLeft, resetLocation, resetMargin, resetMarginBottom, resetMarginLeft, resetMarginRight, resetMarginTop, resetMaxHeight, resetMaxWidth, resetMinHeight, resetMinWidth, resetOpacity, resetOverflow, resetPadding, resetPaddingBottom, resetPaddingLeft, resetPaddingRight, resetPaddingTop, resetParent, resetRight, resetSelectable, resetSpace, resetSupportsDropMethod, resetTabIndex, resetTextColor, resetToolTip, resetTop, resetVerticalAlign, resetVisibility, resetWidth, resetWidths, resetZIndex, scrollIntoView, scrollIntoViewX, scrollIntoViewY, setAlign, setAllowStretchX, setAllowStretchY, setAnonymous, setAppearance, setBackgroundColor, setBackgroundImage, setBackgroundRepeat, setBorder, setBottom, setCapture, setClip, setClipDimension, setClipHeight, setClipLeft, setClipLocation, setClipTop, setClipWidth, setCommand, setContextMenu, setCursor, setDimension, setDisplay, setDropDataTypes, setEdge, setElement, setEnabled, setEnableElementFocus, setFocused, setFont, setHeight, setHeights, setHideFocus, setHorizontalAlign, setHtmlAttribute, setHtmlProperty, setLeft, setLocation, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setParent, setRight, setScrollLeft, setScrollTop, setSelectable, setSpace, setStyleProperty, setSupportsDropMethod, setTabIndex, setTextColor, setToolTip, setTop, setVerticalAlign, setVisibility, setWidth, setWidths, setZIndex, show, supportsDrop, toggleAllowStretchX, toggleAllowStretchY, toggleAnonymous, toggleCapture, toggleDisplay, toggleEnabled, toggleEnableElementFocus, toggleFocused, toggleHideFocus, toggleSelectable, toggleVisibility

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Iframe

public Iframe()

Iframe

public Iframe(java.lang.String vSource)

Method Detail

_applyElement

public void _applyElement(java.lang.Object value,
                          java.lang.Object old)

Overrides:

_applyElement in class Widget

_applyFrameName

public void _applyFrameName(java.lang.Object value,
                            java.lang.Object old,
                            java.lang.Object propName,
                            java.lang.Object uniqModIds)

_applyScrolling

public void _applyScrolling(java.lang.Object value,
                            java.lang.Object old)

Applies changes of the property value of the property scrolling.

For further details take a look at the property definition: _applyScrolling(java.lang.Object, java.lang.Object).

_applySource

public void _applySource(java.lang.Object value,
                         java.lang.Object old)

_beforeAppear

public void _beforeAppear()

Overrides:

_beforeAppear in class Widget

_beforeDisappear

public void _beforeDisappear()

Overrides:

_beforeDisappear in class Widget

_generateBlockerElement

public void _generateBlockerElement()

_generateIframeElement

public void _generateIframeElement(java.lang.String vFrameName)

Creates an template iframe element and sets all required html and style properties.

_onload

public void _onload()

_syncScrolling

public void _syncScrolling()

Sync scrolling property to the iframe DOM node.

_syncSource

public void _syncSource()

block

public void block()

Cover the iframe with a transparent blocker div element. This prevents mouse or key events to be handled by the iframe. To release the blocker use release().

getBlockerNode

public java.lang.Object getBlockerNode()

getContentDocument

public java.lang.Object getContentDocument()

Get the DOM document object of the iframe.

getContentWindow

public java.lang.Object getContentWindow()

Get the DOM window object of the iframe.

getFrameName

public java.lang.String getFrameName()

Returns the (computed) value of the property frameName.

For further details take a look at the property definition: frameName.

getIframeNode

public java.lang.Object getIframeNode()

Get the DOM element of the iframe.

getScrolling

public java.lang.Object getScrolling()

Returns the (computed) value of the property scrolling.

For further details take a look at the property definition: scrolling.

getSource

public java.lang.String getSource()

Returns the (computed) value of the property source.

For further details take a look at the property definition: source.

initFrameName

public void initFrameName(java.lang.String arg)

Calls the apply method and dispatches the change event of the property frameName with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: frameName.

initScrolling

public void initScrolling(java.lang.Object arg)

Calls the apply method and dispatches the change event of the property scrolling with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: scrolling.

initSource

public void initSource(java.lang.String arg)

Calls the apply method and dispatches the change event of the property source with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: source.

isLoaded

public void isLoaded()

queryCurrentUrl

public java.lang.String queryCurrentUrl()

Returns the current (served) URL inside the iframe

release

public void release()

Release the blocker set by block().

reload

public void reload()

Reload the contents of the iframe.

resetFrameName

public void resetFrameName()

Resets the user value of the property frameName.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: frameName.

resetScrolling

public void resetScrolling()

Resets the user value of the property scrolling.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: scrolling.

resetSource

public void resetSource()

Resets the user value of the property source.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: source.

setBlockerNode

public java.lang.Object setBlockerNode(java.lang.Object vBlockerNode)

setFrameName

public void setFrameName(java.lang.String arg)

Sets the user value of the property frameName.

For further details take a look at the property definition: frameName.

setIframeNode

public void setIframeNode(java.lang.Object vIframeNode)

Change the DOM element of the iframe.

setScrolling

public void setScrolling(java.lang.Object arg)

Sets the user value of the property scrolling.

For further details take a look at the property definition: scrolling.

setSource

public void setSource(java.lang.String arg)

Sets the user value of the property source.

For further details take a look at the property definition: source.