Class HTMLPane
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasContentLoadedHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers
HTMLFlow configured to display HTML content in a pane of specified size.
If the HTML content is larger than the size of the pane, the pane will provide scrollbars for viewing clipped content.
HTML content can be specified directly via contents, or
loaded from a URL via the property contentsURL. This
method of loading is for simple HTML content only; Smart GWT components should be loaded via the ViewLoader class.
HTMLPanes have the ability to render snippets of HTML directly in the
document, or use an IFRAME to render a complete HTML page. See contentsType for more information
You can set the size of an
HTMLPane directly via the width and height properties, or indirectly by placing the HTMLPane in a container component
(Layout, Window, SectionStack, etc) that manages the sizes of its members.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()booleanIfContentsTypeis not explicitly specified, should it be automatically derived?String of HTML contents for this component - may be a fragment of HTML to display or a complete HTML page.ThecontentsTypeattribute governs whether the contents of this htmlFlow are a fragment of HTML to inserted directly into the DOM, or a complete HTML page to be displayed in an IFRAME.If specified the HTMLFlow will load its contents from this URL instead of displayingthis.contents.Parameters to be sent to the contentsURL when fetching content.intDefault height for the component.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static HTMLPanegetOrCreateRef(JavaScriptObject jsObj) HTMLPanes areoverflow:"auto"by default.booleanCan this component have itscontentsspecified as a complete standalone HTML page to be rendered into an embedded IFRAME?setAutoDeriveContentsType(boolean autoDeriveContentsType) IfContentsTypeis not explicitly specified, should it be automatically derived?setContents(String contents) String of HTML contents for this component - may be a fragment of HTML to display or a complete HTML page.setContentsType(ContentsType contentsType) ThecontentsTypeattribute governs whether the contents of this htmlFlow are a fragment of HTML to inserted directly into the DOM, or a complete HTML page to be displayed in an IFRAME.setContentsURL(String contentsURL) If specified the HTMLFlow will load its contents from this URL instead of displayingthis.contents.setContentsURLParams(Map contentsURLParams) Parameters to be sent to the contentsURL when fetching content.setDefaultHeight(int defaultHeight) Default height for the component.static voidsetDefaultProperties(HTMLPane hTMLPaneProperties) Class level method to set the default properties of this class.voidsetIFrameURL(String url) Sets thecontentsURLof this HTMLPane to the supplied url, and thecontentsTypetoContentsType.PAGE, provided the HTMLPane hasn't beendrawn.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setOverflow(Overflow overflow) HTMLPanes areoverflow:"auto"by default.setSupportsContentsAsPage(boolean supportsContentsAsPage) Can this component have itscontentsspecified as a complete standalone HTML page to be rendered into an embedded IFRAME?Methods inherited from class com.smartgwt.client.widgets.HTMLFlow
addContentLoadedHandler, fetchRelatedData, fetchRelatedData, fetchRelatedData, getAllowCaching, getAutoChangeProtocol, getCanSelectText, getCaptureSCComponents, getDefaultWidth, getDynamicContents, getEvalScriptBlocks, getHttpMethod, getIframeSandbox, getLoadingMessage, getSelectContentOnSelectAll, getStructuralHTMLTags, isPageHTML, loadingContent, setAllowCaching, setAutoChangeProtocol, setCanSelectText, setCaptureSCComponents, setDefaultProperties, setDefaultWidth, setDynamicContents, setEvalScriptBlocks, setHttpMethod, setIframeSandbox, setLoadingMessage, setLogicalStructure, setSelectContentOnSelectAll, setStructuralHTMLTags, transformHTMLMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
HTMLPane
public HTMLPane() -
HTMLPane
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setAutoDeriveContentsType
IfContentsTypeis not explicitly specified, should it be automatically derived?If set to true, this component will use
isPageHTML()to determine whether the contents are a standalone HTML page which should be rendered into an embedded IFRAME rather than written directly into the component's handle in the DOM.Note that this property will auto derive the appropriate contents type for both explicitly specified
contentsand for HTML loaded from thecontentsURLSee
ContentsTypefor further information on displaying complete HTML pages in an IFRAME.- Overrides:
setAutoDeriveContentsTypein classHTMLFlow- Parameters:
autoDeriveContentsType- New autoDeriveContentsType value. Default value is false- Returns:
HTMLPaneinstance, for chaining setter calls
-
getAutoDeriveContentsType
public boolean getAutoDeriveContentsType()IfContentsTypeis not explicitly specified, should it be automatically derived?If set to true, this component will use
isPageHTML()to determine whether the contents are a standalone HTML page which should be rendered into an embedded IFRAME rather than written directly into the component's handle in the DOM.Note that this property will auto derive the appropriate contents type for both explicitly specified
contentsand for HTML loaded from thecontentsURLSee
ContentsTypefor further information on displaying complete HTML pages in an IFRAME.- Overrides:
getAutoDeriveContentsTypein classHTMLFlow- Returns:
- Current autoDeriveContentsType value. Default value is false
-
setContents
String of HTML contents for this component - may be a fragment of HTML to display or a complete HTML page. SeeHTMLFlow.contentsTypeandHTMLFlow.supportsContentsAsPage.To load HTML contents from a URL, use
HTMLFlow.contentsURLinstead of this property. IfcontentsURLis non-null,contentswill be ignored.- Overrides:
setContentsin classHTMLFlow- Parameters:
contents- New contents value. Default value is " "- Returns:
HTMLPaneinstance, for chaining setter calls- See Also:
-
getContents
String of HTML contents for this component - may be a fragment of HTML to display or a complete HTML page. SeeHTMLFlow.contentsTypeandHTMLFlow.supportsContentsAsPage.To load HTML contents from a URL, use
HTMLFlow.contentsURLinstead of this property. IfcontentsURLis non-null,contentswill be ignored.- Overrides:
getContentsin classHTMLFlow- Returns:
- Current contents value. Default value is " "
- See Also:
-
setContentsType
ThecontentsTypeattribute governs whether the contents of this htmlFlow are a fragment of HTML to inserted directly into the DOM, or a complete HTML page to be displayed in an IFRAME. If not explicitly specified,autoDeriveContentsTypemay be set to automatically determine the appropriate contents type by analyzing the contents of the component. IfautoDeriveContentsTypeis false andcontentsTypeis not explicitly specified, contents will always be assumed to be"fragment".HTMLFlow contents may be
directly specifiedor loaded from aspecified URL. Note that ifsupportsContentsAsPageis false and nocontentsURLis specified, the contents string will always be assumed to be a fragment, even ifContentsTypeis explicitly set to"page".Note that an HTMLFlow with contentsType:"page" should not be used to load and display a page containing a set of Smart GWT components into the application. To dynamically load Smart GWT components, use
ViewLoader, never this mechanism (clickherefor why).Scripting, CSS and scoping considerations for HTMLFlow contents
The following considerations apply to HTMLFlow contents, whether directly specified or loaded from a contentsURL.When contentsType is
"page", the HTML content will be rendered as a standalone document using an IFRAME. UseiframeSandboxto specify IFRAME restrictions using the native sandbox attribute. Note that any script (if allowed) will be executed in the scope of the embedded IFRAME window, not the main application window. Similarly, other features like css stylesheets loaded by the HTMLFlow will apply to the IFRAME window only, and the IFRAME will not pick up css style from the main application by default.When contentsType is
"fragment", if script is encountered within the HTML fragment it will be evaluated in the scope of the main application ifevalScriptBlocksis enabled. Developers should be aware that this evaluation occurs as part of the draw/redraw process, but unlike script embedded directly in a static HTML page, it is not processed by the browser while the elements are being written into the DOM anddocument.write(...)can not be used to modify the HTML as it is being rendered. In this mode, since the contents is written directly into the DOM, standard css styling for the page will be applied.Note that if
autoDeriveContentsTypeis enabled, the default set of recognizedstructuralHTMLTagsinclude<script>, so HTML contents including script will display ascontentsType:"page". The list ofstructuralHTMLTagscan be modified to exclude script tags if desired.- Overrides:
setContentsTypein classHTMLFlow- Parameters:
contentsType- New contentsType value. Default value is null- Returns:
HTMLPaneinstance, for chaining setter calls
-
getContentsType
ThecontentsTypeattribute governs whether the contents of this htmlFlow are a fragment of HTML to inserted directly into the DOM, or a complete HTML page to be displayed in an IFRAME. If not explicitly specified,autoDeriveContentsTypemay be set to automatically determine the appropriate contents type by analyzing the contents of the component. IfautoDeriveContentsTypeis false andcontentsTypeis not explicitly specified, contents will always be assumed to be"fragment".HTMLFlow contents may be
directly specifiedor loaded from aspecified URL. Note that ifsupportsContentsAsPageis false and nocontentsURLis specified, the contents string will always be assumed to be a fragment, even ifContentsTypeis explicitly set to"page".Note that an HTMLFlow with contentsType:"page" should not be used to load and display a page containing a set of Smart GWT components into the application. To dynamically load Smart GWT components, use
ViewLoader, never this mechanism (clickherefor why).Scripting, CSS and scoping considerations for HTMLFlow contents
The following considerations apply to HTMLFlow contents, whether directly specified or loaded from a contentsURL.When contentsType is
"page", the HTML content will be rendered as a standalone document using an IFRAME. UseiframeSandboxto specify IFRAME restrictions using the native sandbox attribute. Note that any script (if allowed) will be executed in the scope of the embedded IFRAME window, not the main application window. Similarly, other features like css stylesheets loaded by the HTMLFlow will apply to the IFRAME window only, and the IFRAME will not pick up css style from the main application by default.When contentsType is
"fragment", if script is encountered within the HTML fragment it will be evaluated in the scope of the main application ifevalScriptBlocksis enabled. Developers should be aware that this evaluation occurs as part of the draw/redraw process, but unlike script embedded directly in a static HTML page, it is not processed by the browser while the elements are being written into the DOM anddocument.write(...)can not be used to modify the HTML as it is being rendered. In this mode, since the contents is written directly into the DOM, standard css styling for the page will be applied.Note that if
autoDeriveContentsTypeis enabled, the default set of recognizedstructuralHTMLTagsinclude<script>, so HTML contents including script will display ascontentsType:"page". The list ofstructuralHTMLTagscan be modified to exclude script tags if desired.- Overrides:
getContentsTypein classHTMLFlow- Returns:
- Current contentsType value. Default value is null
-
setContentsURL
If specified the HTMLFlow will load its contents from this URL instead of displayingthis.contents. May be combined with parameters ifcontentsURLParamswere specified.The HTML retrieved from the target URL may be a complete standalone page to be rendered into its own scope using an IFRAME, or a fragment of HTML to display within this component's handle. See
ContentsTypeandautoDeriveContentsTypefor more information.Note that the link{loadingMessage} and
httpMethodfeatures only apply if contentsURL was set and contentsType was not explicitly set to"page"- Overrides:
setContentsURLin classHTMLFlow- Parameters:
contentsURL- New contentsURL value. Default value is null- Returns:
HTMLPaneinstance, for chaining setter calls- See Also:
-
getContentsURL
If specified the HTMLFlow will load its contents from this URL instead of displayingthis.contents. May be combined with parameters ifcontentsURLParamswere specified.The HTML retrieved from the target URL may be a complete standalone page to be rendered into its own scope using an IFRAME, or a fragment of HTML to display within this component's handle. See
ContentsTypeandautoDeriveContentsTypefor more information.Note that the link{loadingMessage} and
httpMethodfeatures only apply if contentsURL was set and contentsType was not explicitly set to"page"- Overrides:
getContentsURLin classHTMLFlow- Returns:
- Current contentsURL value. Default value is null
- See Also:
-
setContentsURLParams
Parameters to be sent to the contentsURL when fetching content.- Overrides:
setContentsURLParamsin classHTMLFlow- Parameters:
contentsURLParams- New contentsURLParams value. Default value is null- Returns:
HTMLPaneinstance, for chaining setter calls
-
getContentsURLParams
Parameters to be sent to the contentsURL when fetching content.- Returns:
- Current contentsURLParams value. Default value is null
-
setDefaultHeight
Default height for the component.For a component that should potentially be sized automatically by a Layout, set this property rather than
heightdirectly, because Layouts regard a height setting as an explicit size that shouldn't be changed.Note : This is an advanced setting
- Overrides:
setDefaultHeightin classHTMLFlow- Parameters:
defaultHeight- New defaultHeight value. Default value is 200- Returns:
HTMLPaneinstance, for chaining setter calls- See Also:
-
getDefaultHeight
public int getDefaultHeight()Default height for the component.For a component that should potentially be sized automatically by a Layout, set this property rather than
heightdirectly, because Layouts regard a height setting as an explicit size that shouldn't be changed.- Overrides:
getDefaultHeightin classHTMLFlow- Returns:
- Current defaultHeight value. Default value is 200
- See Also:
-
setOverflow
HTMLPanes areoverflow:"auto"by default.Note that for
contentsType:"page",overflow:"visible"is not supported.- Overrides:
setOverflowin classHTMLFlow- Parameters:
overflow- New overflow value. Default value is Canvas.AUTO- Returns:
HTMLPaneinstance, for chaining setter calls- See Also:
-
getOverflow
HTMLPanes areoverflow:"auto"by default.Note that for
contentsType:"page",overflow:"visible"is not supported.- Overrides:
getOverflowin classHTMLFlow- Returns:
- Current overflow value. Default value is Canvas.AUTO
- See Also:
-
setSupportsContentsAsPage
Can this component have itscontentsspecified as a complete standalone HTML page to be rendered into an embedded IFRAME?If true, if
ContentsTypeis specified as, orderived to be"page", the contents will be rendered into an embedded IFRAME using thesrcdocattribute rather than written directly into the component handle.If false, contentsType has no effect unless contents are being loaded from an explicitly specified
contentsURL- Overrides:
setSupportsContentsAsPagein classHTMLFlow- Parameters:
supportsContentsAsPage- New supportsContentsAsPage value. Default value is true- Returns:
HTMLPaneinstance, for chaining setter calls
-
getSupportsContentsAsPage
public boolean getSupportsContentsAsPage()Can this component have itscontentsspecified as a complete standalone HTML page to be rendered into an embedded IFRAME?If true, if
ContentsTypeis specified as, orderived to be"page", the contents will be rendered into an embedded IFRAME using thesrcdocattribute rather than written directly into the component handle.If false, contentsType has no effect unless contents are being loaded from an explicitly specified
contentsURL- Overrides:
getSupportsContentsAsPagein classHTMLFlow- Returns:
- Current supportsContentsAsPage value. Default value is true
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
hTMLPaneProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setIFrameURL
Sets thecontentsURLof this HTMLPane to the supplied url, and thecontentsTypetoContentsType.PAGE, provided the HTMLPane hasn't beendrawn. Throws an AssertionError RuntimeException in GWT Classic DevMode if the HTMLPane has already been drawn.- Parameters:
url- the IFrame url
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classHTMLFlow
-