Class Iframe

Includes an inline frame.

Unlike HTML iframe, this component doesn't have the frameborder property. Rather, use the CSS style to customize the border (like any other components).

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

$afterCommand $binder $f $init $instanceof $n $o $s $service $super $supers afterInit appendChild bind bindMissingAncestors canActivate clear clearCache detach fire fireX focus forcerender fromPageCoord get get$Class getAction getAlign getCaveNode getChildAt getChildIndex getContext getCssflex getCtrlKeys getDragNode getDraggable getDroppable getHeight getHflex getId getInputNode? getLeft getMold getName getPage getPopup getRenderdefer getSclass getScrollLeft getScrollTop getScrolling getSrc getStyle getTabindex getTextNode getTooltip getTooltiptext getTop getTopWidget getVflex getWidth getZIndex getZclass getZindex hide insertBefore isAutohide isBinding isCssflex isFocus isHflex isListen isRealElement isRealVisible isVflex isVisible listen onAfterSize onSize proxy redraw removeChild replaceHTML replaceWidget rerender scrollIntoView set setAction setAlign setAutohide setChildren setContext setCssflex setCtrlKeys setDraggable setDroppable setFocus setHeight setHflex setId setLeft setListener setListener0 setListeners setListeners0 setMold setName setOverride setOverrides setPopup setRenderdefer setSclass setScrollLeft setScrollTop setScrolling setSrc setStyle setTabindex setTooltip setTooltiptext setTop setTopmost setVflex setVisible setWidth setZIndex setZclass setZindex show smartUpdate toJSON unbind unlisten zsync $ disableChildCallback enableChildCallback getClass getElementsById getElementsByName getOpenTooltip getWidgetByUuid isAssignableFrom isAutoId isInstance newInstance nextUuid register uuid

Constructors

Properties

$ZKBINDER$?: boolean
$ZKMATCHMEDIA$?: string[]
$button?: boolean
$inputWidget?: boolean
$oid: number = 0

The object ID. Each object has its own unique $oid. It is mainly used for debugging purpose.

Trick: you can test if a JavaScript object is a ZK object by examining this property, such as `if (o.$oid) alert('o is a ZK object');`

Notice: zk.Class extends from zk.Object (so a class also has $oid)

$weave?: object = undefined

The weave controller that is used by ZK Weaver. It is not null if it is created and controlled by ZK Weaver. In other words, it is called in the Design Mode if Widget.$weave is not null.

_afterComposed: boolean
_beforeAfterComposeCallbacks: CallableFunction[]
_disabledShadowAdjustment: boolean
autag?: string

The AU tag of this widget. The AU tag tag is used to tag the AU requests sent by the peer widget. For instance, if the AU tag is xxx,yyy and the desktop's request path (Desktop#requestPath) is /foo.zul, then the URL of the AU request will contain /_/foo.zul/xxx,yyy,.

Default Value

null

Since

6.0.0

bindLevel: number = -1

The bind level (integer).

The level in the widget tree after this widget is bound to a DOM tree (bind_). For example, a widget's bind level is one plus the parent widget's

It starts at 0 if it is the root of the widget tree (a desktop, zk.Desktop), then 1 if a child of the root widget, and son on. Notice that it is -1 if not bound.

It is mainly useful if you want to maintain a list that parent widgets is in front of (or after) child widgets. bind level.

blankPreserved?: boolean
className: string

The class name of the widget. For example, zk.Widget's class name is "zk.Widget", while zul.wnd.Window's "zul.wnd.Window".

Notice that it is available if a widget class is loaded by WPD loader (i.e., specified in zk.wpd). If you create a widget class dynamically, you have to invoke register to make this member available. On the other hand, zk.Object.$class is available for all objects extending from zk.Object.

See

widgetName

desktop?: Desktop

The desktop that this widget belongs to.

It is set when it is bound to the DOM tree.

Notice it is always non-null if bound to the DOM tree, while Widget.$n is always non-null if bound. For example, zul.utl.Timer.

It is readonly, and set automatically when bind_ is called.

doAfterProcessRerenderArgs: undefined | unknown[]
domExtraAttrs?: Record<string, string>
firstChild?: Widget<HTMLElement>

The first child, or null if no child at all.

See

getChildAt

id?: string

The identifier of this widget, or null if not assigned.

It is the same as getId.

To change the value, use setId.

inServer: boolean = false

Whether this widget has a peer component.

It is set if a widget is created automatically to represent a component at the server. On the other hand, it is false if a widget is created by the client application (by calling, say, new zul.inp.Textox()).

lastChild?: Widget<HTMLElement>

The last child, or null if no child at all.

See

getChildAt

nChildren: number = 0

The number of children (integer).

nextSibling?: Widget<HTMLElement>

The next sibling, or null if this widget is the last child.

offsetHeight?: any
offsetWidth?: any
parent?: Widget<HTMLElement>

The parent, or null if this widget has no parent.

previousSibling?: Widget<HTMLElement>

The previous sibling, or null if this widget is the first child.

prolog?: string
rawId: any
uuid: string = ''

The UUID. Don't change it if it is bound to the DOM tree, or inServer is true. Developers rarely need to modify it since it is generated automatically.

widgetName: string

The widget name of the widget. It is the same as this.className.substring(this.className.lastIndexOf('.') + 1).toLowerCase(). For example, if className is zul.wnd.Window, then widgetName is window.

Notice that className is unique while widgetName is not necessary unique.

See

className

Since

5.0.2

z$display?: string
z$rod?: boolean
z$rod0?: false
z_isDataHandlerBound: any
z_rod?: number | boolean
z_virnd?: boolean
$oid: any
auDelay: number = 38

The default delay before sending an AU request when fire is called (and the server has an ARAP event listener registered).

Default Value

38 (Unit: miliseconds).

Since

5.0.8

molds: {
    default(out): void;
}

Type declaration

  • default:function
    • Parameters

      • out: string[]

      Returns void

Accessors

  • get $class(): typeof ZKObject
  • The class that this object belongs to.

    Returns typeof ZKObject

Methods

  • Parameters

    • command: string
    • Optional args: unknown[]

    Returns void

  • Returns undefined | Record<string, Widget<HTMLElement>>

    the map of all fellows of this widget.

    wgt.$f().main.setTitle("foo");
    

    Since

    5.0.2

  • Type Parameters

    Parameters

    • id: string

      the widget's ID (id)

    • Optional global: boolean

      whether to search all ID spaces of this desktop. If true, it first search its own ID space, and then the other Id spaces in this browser window (might have one or multiple desktops). If omitted, it won't search all ID spaces.

    Returns undefined | T

    the fellow (Widget) of the specified ID of the ID space that this widget belongs to. It returns undefined if not found.

  • The constructor.

    Parameters

    • Optional props: Record<string, unknown> | (() => void)

    Returns void

    Default Value

    it does nothing so the subclass needs not to copy back
    (also harmless to call back).

    See

    afterInit

    Deprecated

    as of 10.0 released. Using ES6 constructor instead.

  • Determines if this object is an instance of the class represented by the specified Class parameter. Example:

    if (obj.$instanceof(zul.wgt.Label, zul.wgt.Image)) {
    }

    Parameters

    • Rest ...klass: any[]

      the Class object to be checked. Any number of arguments can be specified.

    Returns boolean

    true if this object is an instance of the class

  • Returns undefined | HTMLIFrameElement

    the DOM element that this widget is bound to. It is null if it is not bound to the DOM tree, or it doesn't have the associated DOM node (for example, zul.utl.Timer).

    Notice that desktop is always non-null if it is bound to the DOM tree. In additions, this method is much faster than invoking jq() (see _global_.jq, since it caches the result (and clean up at the unbind_). ```ts var n = wgt.$n(); ```

    See

    #$n(String)

  • Type Parameters

    • T extends HTMLElement = HTMLElement

    Parameters

    • Optional subId: string

      the sub ID of the child element

    Returns undefined | T

    the child element of the DOM element(s) that this widget is bound to. This method assumes the ID of the child element the concatenation of uuid, -, and subId. For example,

    var cave = wgt.$n('cave'); //the same as jq('#' + wgt.uuid + '-' + 'cave')[0]
    

    Like Widget.$n, this method caches the result so the performance is much better than invoking jq() directly.

  • Type Parameters

    Returns undefined | T

    the owner of the ID space that this widget belongs to, or null if it doesn't belong to any ID space.

    Notice that, if this widget is an ID space owner, this method returns itself.

  • Parameters

    • Optional subclass: string

    Returns string

    the sub zclass name that cache for this widget. It returns the zclass if the subclass is empty or null, since it caches the result (and clean up at the setZclass).

    var subzcls = wgt.$s('hover'); // z-xxx-hover will be return
    

    See

    getZclass

    Since

    7.0.0

  • Returns undefined | Service

    the service instance from the current widget, if any.

    Since

    8.0.0

  • Invokes a method defined in the superclass with any number of arguments. It is like Function's call() that takes any number of arguments.

    Example: ```ts multiply: function (n) { return this.$super('multiply', n + 2); } ```

    Type Parameters

    • M extends "$init" | "$supers" | "_$ais" | "_$supers" | "_$proxies" | "_$super" | "_importantEvts" | "afterCreated_" | "afterInit" | "$class" | "get$Class" | "$oid" | "$instanceof" | "$super" | "proxy" | "desktop" | "fire" | "onSize" | "$n" | "hide" | "toJSON" | "$weave" | "isVisible" | "scrollIntoView" | "$n_" | "z$rod" | "_rodopen" | "z_virnd" | "$button" | "$inputWidget" | "_uplder" | "_autodisable_self" | "_uploading" | "offsetWidth" | "offsetHeight" | "blankPreserved" | "getInputNode" | "z_rod" | "_z$rd" | "z$display" | "prolog" | "_rodKid" | "_node" | "_nodeSolved" | "_rmAftAnm" | "_$evproxs" | "_fellows" | "_norenderdefer" | "_rerendering" | "domExtraAttrs" | "_flexListened" | "_cssFlexApplied" | "_beforeSizeHasScroll" | "doAfterProcessRerenderArgs" | "_vflex" | "_hflex" | "_flexFixed" | "_nvflex" | "_nhflex" | "_hflexsz" | "_vflexsz" | "_binding" | "rawId" | "_$service" | "childReplacing_" | "_userZIndex" | "_zIndex" | "z_isDataHandlerBound" | "_drag" | "_preWidth" | "_preHeight" | "_action" | "_tabindex" | "_draggable" | "_asaps" | "_lsns" | "_bklsns" | "_subnodes" | "_subzcls" | "_sclass" | "_zclass" | "_width" | "_height" | "_left" | "_top" | "_tooltiptext" | "_droppable" | "_dropTypes" | "_fitSizeListened" | "_focus" | "_visible" | "_mold" | "_style" | "_renderdefer" | "_cssflex" | "actions_" | "nChildren" | "bindLevel" | "className" | "widgetName" | "autag" | "_floating" | "firstChild" | "lastChild" | "parent" | "nextSibling" | "previousSibling" | "id" | "inServer" | "uuid" | "insertingBefore_" | "effects_" | "setMold" | "getMold" | "setStyle" | "getStyle" | "setSclass" | "getSclass" | "setZclass" | "getZclass" | "setWidth" | "getWidth" | "setHeight" | "getHeight" | "setLeft" | "getLeft" | "setTop" | "getTop" | "setTooltiptext" | "getTooltiptext" | "setDroppable" | "getDroppable" | "setVflex" | "getVflex" | "isVflex" | "setHflex" | "getHflex" | "isHflex" | "getRenderdefer" | "setRenderdefer" | "getAction" | "setAction" | "getTabindex" | "setTabindex" | "getCssflex" | "isCssflex" | "setCssflex" | "setHflex_" | "setVflex_" | "afterAnima_" | "setDraggable" | "getDraggable" | "$o" | "$f" | "getId" | "setId" | "set" | "_setServerListener" | "get" | "getChildAt" | "getChildIndex" | "setChildren" | "appendChild" | "shallChildROD_" | "insertBefore" | "beforeChildRemoved_" | "triggerBeforeHostChildRemoved_" | "removeChild" | "detach" | "clear" | "replaceWidget" | "replaceCavedChildren_" | "beforeParentChanged_" | "triggerBeforeHostParentChanged_" | "afterParentChanged_" | "isRealVisible" | "setVisible" | "isFocus" | "setFocus" | "zsync" | "show" | "setDomVisible_" | "beforeChildAdded_" | "triggerBeforeHostChildAdded_" | "onChildAdded_" | "triggerAfterHostChildAdded_" | "onChildRemoved_" | "triggerAfterHostChildRemoved_" | "onChildReplaced_" | "onChildVisible_" | "onChildRenderDefer_" | "setTopmost" | "setFloatZIndex_" | "getFloatZIndex_" | "getTopWidget" | "isFloating_" | "setFloating_" | "getZIndex" | "getZindex" | "setZIndex" | "setZindex" | "getScrollTop" | "getScrollLeft" | "setScrollTop" | "setScrollLeft" | "redraw" | "deferRedraw_" | "deferRedrawHTML_" | "forcerender" | "updateDomClass_" | "updateDomStyle_" | "_domTextStyle" | "getTextNode" | "domStyle_" | "domClass_" | "domAttrs_" | "domExtraAttrs_" | "domTooltiptext_" | "domTextStyleAttr_" | "replaceHTML" | "getOldWidget_" | "redrawHTML_" | "rerender" | "rerenderLater_" | "replaceChildHTML_" | "insertChildHTML_" | "getCaveNode" | "getFirstNode_" | "removeChildHTML_" | "removeHTML_" | "$service" | "$afterCommand" | "isRealElement" | "inRerendering_" | "$s" | "clearCache" | "unbindRod_" | "getPage" | "isBinding" | "rerenderNow_" | "bindMissingAncestors" | "bind" | "unbind" | "bind_" | "bindChildren_" | "unbind_" | "unbindChildren_" | "extraBind_" | "setFlexSize_" | "setFlexSizeH_" | "setFlexSizeW_" | "beforeChildReplaced_" | "beforeChildrenFlex_" | "afterChildrenFlex_" | "afterChildMinFlexChanged_" | "ignoreFlexSize_" | "ignoreChildNodeOffset_" | "beforeMinFlex_" | "beforeParentMinFlex_" | "afterChildrenMinFlex_" | "afterResetChildSize_" | "isExcludedHflex_" | "isExcludedVflex_" | "getChildMinSize_" | "getParentSize_" | "getMarginSize_" | "getContentEdgeHeight_" | "getContentEdgeWidth_" | "fixFlex_" | "fixMinFlex_" | "clearCachedSize_" | "resetSize_" | "getFlexContainer_" | "getFlexDirection_" | "afterClearFlex_" | "initDrag_" | "cleanDrag_" | "getDragNode" | "getDragOptions_" | "ignoreDrag_" | "getDrop_" | "dropEffect_" | "getDragMessage_" | "onDrop_" | "cloneDrag_" | "uncloneDrag_" | "onAfterSize" | "bindSwipe_" | "unbindSwipe_" | "bindDoubleTap_" | "unbindDoubleTap_" | "bindTapHold_" | "unbindTapHold_" | "focus" | "focus_" | "canActivate" | "smartUpdate" | "fireX" | "beforeSendAU_" | "sendAU_" | "shallIgnoreClick_" | "listen" | "unlisten" | "isListen" | "setListeners" | "setListeners0" | "setListener" | "setListener0" | "setOverride" | "setOverrides" | "doSelect_" | "doTooltipOver_" | "doTooltipOut_" | "doClick_" | "doDoubleClick_" | "doRightClick_" | "doMouseOver_" | "doMouseOut_" | "doMouseDown_" | "doMouseUp_" | "doMouseMove_" | "doKeyDown_" | "doKeyUp_" | "doKeyPress_" | "doPaste_" | "doSwipe_" | "doFocus_" | "doBlur_" | "doResizeScroll_" | "domListen_" | "domUnlisten_" | "listenOnFitSize_" | "unlistenOnFitSize_" | "fromPageCoord" | "isWatchable_" | "ignoreDescendantFloatUp_" | "getDomEvtInf_" | "shallFireSizedLaterWhenAddChd_" | "afterCompose_" | "_$binder" | "$ZKBINDER$" | "$ZKMATCHMEDIA$" | "$binder" | "z$rod0" | "_afterComposed" | "_beforeAfterComposeCallbacks" | "_disabledShadowAdjustment" | "_context" | "_popup" | "_doScrollableSyncScroll" | "_tooltip" | "_ctrlKeys" | "_parsedCtlKeys" | "getContext" | "setContext" | "getPopup" | "setPopup" | "getTooltip" | "setTooltip" | "getCtrlKeys" | "setCtrlKeys" | "_parsePopParams" | "_smartFellow" | "afterKeyDown_" | "beforeCtrlKeys_" | "_align" | "setAlign" | "getAlign" | "_name" | "getName" | "setName" | "_src" | "getSrc" | "setSrc" | "_scrolling" | "_autohide" | "isAutohide" | "setAutohide" | "getScrolling" | "setScrolling"

    • F extends any

    Parameters

    • mtd: M

      the method name to invoke

    • Rest ...args: Parameters<F>

      any number of arguments

    Returns ReturnType<F>

    the object being returned by the method of the superclass.

  • Invokes a method defined in the superclass with any number of arguments. It is like Function's call() that takes any number of arguments.

    It is similar to ZKObject.$super, but this method works even if the superclass calls back the same member method. In short, it is tedious but safer.

    Example: ```ts foo.MyClass = zk.$extends(foo.MySuper, { multiply: function (n) { return this.$super(foo.MyClass, 'multiply', n + 2); } ```

    Notice that the class specified in the first argument is not the super class having the method. Rather, it is the class that invokes this method.

    Type Parameters

    • M extends "$init" | "$supers" | "_$ais" | "_$supers" | "_$proxies" | "_$super" | "_importantEvts" | "afterCreated_" | "afterInit" | "$class" | "get$Class" | "$oid" | "$instanceof" | "$super" | "proxy" | "desktop" | "fire" | "onSize" | "$n" | "hide" | "toJSON" | "$weave" | "isVisible" | "scrollIntoView" | "$n_" | "z$rod" | "_rodopen" | "z_virnd" | "$button" | "$inputWidget" | "_uplder" | "_autodisable_self" | "_uploading" | "offsetWidth" | "offsetHeight" | "blankPreserved" | "getInputNode" | "z_rod" | "_z$rd" | "z$display" | "prolog" | "_rodKid" | "_node" | "_nodeSolved" | "_rmAftAnm" | "_$evproxs" | "_fellows" | "_norenderdefer" | "_rerendering" | "domExtraAttrs" | "_flexListened" | "_cssFlexApplied" | "_beforeSizeHasScroll" | "doAfterProcessRerenderArgs" | "_vflex" | "_hflex" | "_flexFixed" | "_nvflex" | "_nhflex" | "_hflexsz" | "_vflexsz" | "_binding" | "rawId" | "_$service" | "childReplacing_" | "_userZIndex" | "_zIndex" | "z_isDataHandlerBound" | "_drag" | "_preWidth" | "_preHeight" | "_action" | "_tabindex" | "_draggable" | "_asaps" | "_lsns" | "_bklsns" | "_subnodes" | "_subzcls" | "_sclass" | "_zclass" | "_width" | "_height" | "_left" | "_top" | "_tooltiptext" | "_droppable" | "_dropTypes" | "_fitSizeListened" | "_focus" | "_visible" | "_mold" | "_style" | "_renderdefer" | "_cssflex" | "actions_" | "nChildren" | "bindLevel" | "className" | "widgetName" | "autag" | "_floating" | "firstChild" | "lastChild" | "parent" | "nextSibling" | "previousSibling" | "id" | "inServer" | "uuid" | "insertingBefore_" | "effects_" | "setMold" | "getMold" | "setStyle" | "getStyle" | "setSclass" | "getSclass" | "setZclass" | "getZclass" | "setWidth" | "getWidth" | "setHeight" | "getHeight" | "setLeft" | "getLeft" | "setTop" | "getTop" | "setTooltiptext" | "getTooltiptext" | "setDroppable" | "getDroppable" | "setVflex" | "getVflex" | "isVflex" | "setHflex" | "getHflex" | "isHflex" | "getRenderdefer" | "setRenderdefer" | "getAction" | "setAction" | "getTabindex" | "setTabindex" | "getCssflex" | "isCssflex" | "setCssflex" | "setHflex_" | "setVflex_" | "afterAnima_" | "setDraggable" | "getDraggable" | "$o" | "$f" | "getId" | "setId" | "set" | "_setServerListener" | "get" | "getChildAt" | "getChildIndex" | "setChildren" | "appendChild" | "shallChildROD_" | "insertBefore" | "beforeChildRemoved_" | "triggerBeforeHostChildRemoved_" | "removeChild" | "detach" | "clear" | "replaceWidget" | "replaceCavedChildren_" | "beforeParentChanged_" | "triggerBeforeHostParentChanged_" | "afterParentChanged_" | "isRealVisible" | "setVisible" | "isFocus" | "setFocus" | "zsync" | "show" | "setDomVisible_" | "beforeChildAdded_" | "triggerBeforeHostChildAdded_" | "onChildAdded_" | "triggerAfterHostChildAdded_" | "onChildRemoved_" | "triggerAfterHostChildRemoved_" | "onChildReplaced_" | "onChildVisible_" | "onChildRenderDefer_" | "setTopmost" | "setFloatZIndex_" | "getFloatZIndex_" | "getTopWidget" | "isFloating_" | "setFloating_" | "getZIndex" | "getZindex" | "setZIndex" | "setZindex" | "getScrollTop" | "getScrollLeft" | "setScrollTop" | "setScrollLeft" | "redraw" | "deferRedraw_" | "deferRedrawHTML_" | "forcerender" | "updateDomClass_" | "updateDomStyle_" | "_domTextStyle" | "getTextNode" | "domStyle_" | "domClass_" | "domAttrs_" | "domExtraAttrs_" | "domTooltiptext_" | "domTextStyleAttr_" | "replaceHTML" | "getOldWidget_" | "redrawHTML_" | "rerender" | "rerenderLater_" | "replaceChildHTML_" | "insertChildHTML_" | "getCaveNode" | "getFirstNode_" | "removeChildHTML_" | "removeHTML_" | "$service" | "$afterCommand" | "isRealElement" | "inRerendering_" | "$s" | "clearCache" | "unbindRod_" | "getPage" | "isBinding" | "rerenderNow_" | "bindMissingAncestors" | "bind" | "unbind" | "bind_" | "bindChildren_" | "unbind_" | "unbindChildren_" | "extraBind_" | "setFlexSize_" | "setFlexSizeH_" | "setFlexSizeW_" | "beforeChildReplaced_" | "beforeChildrenFlex_" | "afterChildrenFlex_" | "afterChildMinFlexChanged_" | "ignoreFlexSize_" | "ignoreChildNodeOffset_" | "beforeMinFlex_" | "beforeParentMinFlex_" | "afterChildrenMinFlex_" | "afterResetChildSize_" | "isExcludedHflex_" | "isExcludedVflex_" | "getChildMinSize_" | "getParentSize_" | "getMarginSize_" | "getContentEdgeHeight_" | "getContentEdgeWidth_" | "fixFlex_" | "fixMinFlex_" | "clearCachedSize_" | "resetSize_" | "getFlexContainer_" | "getFlexDirection_" | "afterClearFlex_" | "initDrag_" | "cleanDrag_" | "getDragNode" | "getDragOptions_" | "ignoreDrag_" | "getDrop_" | "dropEffect_" | "getDragMessage_" | "onDrop_" | "cloneDrag_" | "uncloneDrag_" | "onAfterSize" | "bindSwipe_" | "unbindSwipe_" | "bindDoubleTap_" | "unbindDoubleTap_" | "bindTapHold_" | "unbindTapHold_" | "focus" | "focus_" | "canActivate" | "smartUpdate" | "fireX" | "beforeSendAU_" | "sendAU_" | "shallIgnoreClick_" | "listen" | "unlisten" | "isListen" | "setListeners" | "setListeners0" | "setListener" | "setListener0" | "setOverride" | "setOverrides" | "doSelect_" | "doTooltipOver_" | "doTooltipOut_" | "doClick_" | "doDoubleClick_" | "doRightClick_" | "doMouseOver_" | "doMouseOut_" | "doMouseDown_" | "doMouseUp_" | "doMouseMove_" | "doKeyDown_" | "doKeyUp_" | "doKeyPress_" | "doPaste_" | "doSwipe_" | "doFocus_" | "doBlur_" | "doResizeScroll_" | "domListen_" | "domUnlisten_" | "listenOnFitSize_" | "unlistenOnFitSize_" | "fromPageCoord" | "isWatchable_" | "ignoreDescendantFloatUp_" | "getDomEvtInf_" | "shallFireSizedLaterWhenAddChd_" | "afterCompose_" | "_$binder" | "$ZKBINDER$" | "$ZKMATCHMEDIA$" | "$binder" | "z$rod0" | "_afterComposed" | "_beforeAfterComposeCallbacks" | "_disabledShadowAdjustment" | "_context" | "_popup" | "_doScrollableSyncScroll" | "_tooltip" | "_ctrlKeys" | "_parsedCtlKeys" | "getContext" | "setContext" | "getPopup" | "setPopup" | "getTooltip" | "setTooltip" | "getCtrlKeys" | "setCtrlKeys" | "_parsePopParams" | "_smartFellow" | "afterKeyDown_" | "beforeCtrlKeys_" | "_align" | "setAlign" | "getAlign" | "_name" | "getName" | "setName" | "_src" | "getSrc" | "setSrc" | "_scrolling" | "_autohide" | "isAutohide" | "setAutohide" | "getScrolling" | "setScrolling"

    • F extends any

    Parameters

    • klass: typeof ZKObject

      the class that invokes this method.

    • mtd: M

      the method name to invoke

    • Rest ...args: Parameters<F>

      any number of arguments

    Returns ReturnType<F>

    the object being returned by the method of the superclass.

    See

    zk.Object.$supers

    Since

    5.0.2

  • Invokes a method defined in the superclass with an array of arguments. It is like Function's apply() that takes an array of arguments.

    Example: ```ts multiply: function () { return this.$supers('multiply', arguments); } ```

    Type Parameters

    • M extends "$init" | "$supers" | "_$ais" | "_$supers" | "_$proxies" | "_$super" | "_importantEvts" | "afterCreated_" | "afterInit" | "$class" | "get$Class" | "$oid" | "$instanceof" | "$super" | "proxy" | "desktop" | "fire" | "onSize" | "$n" | "hide" | "toJSON" | "$weave" | "isVisible" | "scrollIntoView" | "$n_" | "z$rod" | "_rodopen" | "z_virnd" | "$button" | "$inputWidget" | "_uplder" | "_autodisable_self" | "_uploading" | "offsetWidth" | "offsetHeight" | "blankPreserved" | "getInputNode" | "z_rod" | "_z$rd" | "z$display" | "prolog" | "_rodKid" | "_node" | "_nodeSolved" | "_rmAftAnm" | "_$evproxs" | "_fellows" | "_norenderdefer" | "_rerendering" | "domExtraAttrs" | "_flexListened" | "_cssFlexApplied" | "_beforeSizeHasScroll" | "doAfterProcessRerenderArgs" | "_vflex" | "_hflex" | "_flexFixed" | "_nvflex" | "_nhflex" | "_hflexsz" | "_vflexsz" | "_binding" | "rawId" | "_$service" | "childReplacing_" | "_userZIndex" | "_zIndex" | "z_isDataHandlerBound" | "_drag" | "_preWidth" | "_preHeight" | "_action" | "_tabindex" | "_draggable" | "_asaps" | "_lsns" | "_bklsns" | "_subnodes" | "_subzcls" | "_sclass" | "_zclass" | "_width" | "_height" | "_left" | "_top" | "_tooltiptext" | "_droppable" | "_dropTypes" | "_fitSizeListened" | "_focus" | "_visible" | "_mold" | "_style" | "_renderdefer" | "_cssflex" | "actions_" | "nChildren" | "bindLevel" | "className" | "widgetName" | "autag" | "_floating" | "firstChild" | "lastChild" | "parent" | "nextSibling" | "previousSibling" | "id" | "inServer" | "uuid" | "insertingBefore_" | "effects_" | "setMold" | "getMold" | "setStyle" | "getStyle" | "setSclass" | "getSclass" | "setZclass" | "getZclass" | "setWidth" | "getWidth" | "setHeight" | "getHeight" | "setLeft" | "getLeft" | "setTop" | "getTop" | "setTooltiptext" | "getTooltiptext" | "setDroppable" | "getDroppable" | "setVflex" | "getVflex" | "isVflex" | "setHflex" | "getHflex" | "isHflex" | "getRenderdefer" | "setRenderdefer" | "getAction" | "setAction" | "getTabindex" | "setTabindex" | "getCssflex" | "isCssflex" | "setCssflex" | "setHflex_" | "setVflex_" | "afterAnima_" | "setDraggable" | "getDraggable" | "$o" | "$f" | "getId" | "setId" | "set" | "_setServerListener" | "get" | "getChildAt" | "getChildIndex" | "setChildren" | "appendChild" | "shallChildROD_" | "insertBefore" | "beforeChildRemoved_" | "triggerBeforeHostChildRemoved_" | "removeChild" | "detach" | "clear" | "replaceWidget" | "replaceCavedChildren_" | "beforeParentChanged_" | "triggerBeforeHostParentChanged_" | "afterParentChanged_" | "isRealVisible" | "setVisible" | "isFocus" | "setFocus" | "zsync" | "show" | "setDomVisible_" | "beforeChildAdded_" | "triggerBeforeHostChildAdded_" | "onChildAdded_" | "triggerAfterHostChildAdded_" | "onChildRemoved_" | "triggerAfterHostChildRemoved_" | "onChildReplaced_" | "onChildVisible_" | "onChildRenderDefer_" | "setTopmost" | "setFloatZIndex_" | "getFloatZIndex_" | "getTopWidget" | "isFloating_" | "setFloating_" | "getZIndex" | "getZindex" | "setZIndex" | "setZindex" | "getScrollTop" | "getScrollLeft" | "setScrollTop" | "setScrollLeft" | "redraw" | "deferRedraw_" | "deferRedrawHTML_" | "forcerender" | "updateDomClass_" | "updateDomStyle_" | "_domTextStyle" | "getTextNode" | "domStyle_" | "domClass_" | "domAttrs_" | "domExtraAttrs_" | "domTooltiptext_" | "domTextStyleAttr_" | "replaceHTML" | "getOldWidget_" | "redrawHTML_" | "rerender" | "rerenderLater_" | "replaceChildHTML_" | "insertChildHTML_" | "getCaveNode" | "getFirstNode_" | "removeChildHTML_" | "removeHTML_" | "$service" | "$afterCommand" | "isRealElement" | "inRerendering_" | "$s" | "clearCache" | "unbindRod_" | "getPage" | "isBinding" | "rerenderNow_" | "bindMissingAncestors" | "bind" | "unbind" | "bind_" | "bindChildren_" | "unbind_" | "unbindChildren_" | "extraBind_" | "setFlexSize_" | "setFlexSizeH_" | "setFlexSizeW_" | "beforeChildReplaced_" | "beforeChildrenFlex_" | "afterChildrenFlex_" | "afterChildMinFlexChanged_" | "ignoreFlexSize_" | "ignoreChildNodeOffset_" | "beforeMinFlex_" | "beforeParentMinFlex_" | "afterChildrenMinFlex_" | "afterResetChildSize_" | "isExcludedHflex_" | "isExcludedVflex_" | "getChildMinSize_" | "getParentSize_" | "getMarginSize_" | "getContentEdgeHeight_" | "getContentEdgeWidth_" | "fixFlex_" | "fixMinFlex_" | "clearCachedSize_" | "resetSize_" | "getFlexContainer_" | "getFlexDirection_" | "afterClearFlex_" | "initDrag_" | "cleanDrag_" | "getDragNode" | "getDragOptions_" | "ignoreDrag_" | "getDrop_" | "dropEffect_" | "getDragMessage_" | "onDrop_" | "cloneDrag_" | "uncloneDrag_" | "onAfterSize" | "bindSwipe_" | "unbindSwipe_" | "bindDoubleTap_" | "unbindDoubleTap_" | "bindTapHold_" | "unbindTapHold_" | "focus" | "focus_" | "canActivate" | "smartUpdate" | "fireX" | "beforeSendAU_" | "sendAU_" | "shallIgnoreClick_" | "listen" | "unlisten" | "isListen" | "setListeners" | "setListeners0" | "setListener" | "setListener0" | "setOverride" | "setOverrides" | "doSelect_" | "doTooltipOver_" | "doTooltipOut_" | "doClick_" | "doDoubleClick_" | "doRightClick_" | "doMouseOver_" | "doMouseOut_" | "doMouseDown_" | "doMouseUp_" | "doMouseMove_" | "doKeyDown_" | "doKeyUp_" | "doKeyPress_" | "doPaste_" | "doSwipe_" | "doFocus_" | "doBlur_" | "doResizeScroll_" | "domListen_" | "domUnlisten_" | "listenOnFitSize_" | "unlistenOnFitSize_" | "fromPageCoord" | "isWatchable_" | "ignoreDescendantFloatUp_" | "getDomEvtInf_" | "shallFireSizedLaterWhenAddChd_" | "afterCompose_" | "_$binder" | "$ZKBINDER$" | "$ZKMATCHMEDIA$" | "$binder" | "z$rod0" | "_afterComposed" | "_beforeAfterComposeCallbacks" | "_disabledShadowAdjustment" | "_context" | "_popup" | "_doScrollableSyncScroll" | "_tooltip" | "_ctrlKeys" | "_parsedCtlKeys" | "getContext" | "setContext" | "getPopup" | "setPopup" | "getTooltip" | "setTooltip" | "getCtrlKeys" | "setCtrlKeys" | "_parsePopParams" | "_smartFellow" | "afterKeyDown_" | "beforeCtrlKeys_" | "_align" | "setAlign" | "getAlign" | "_name" | "getName" | "setName" | "_src" | "getSrc" | "setSrc" | "_scrolling" | "_autohide" | "isAutohide" | "setAutohide" | "getScrolling" | "setScrolling"

    • F extends any

    Parameters

    • name: M

      the method name to invoke

    • args: Parameters<F>

      an array of arguments. In most case, you just pass arguments (the built-in variable).

    Returns ReturnType<F>

    the object being returned by the method of the superclass.

  • Invokes a method defined in the superclass with an array of arguments. It is like Function's apply() that takes an array of arguments.

    It is similar to zk.Object.$supers, but this method works even if the superclass calls back the same member method. In short, it is tedious but safer.

    Example: ```ts foo.MyClass = zk.$extends(foo.MySuper, { multiply: function () { return this.$supers(foo.MyClass, 'multiply', arguments); } ```

    Notice that the class specified in the first argument is not the super class having the method. Rather, it is the class that invokes this method.

    Type Parameters

    • M extends "$init" | "$supers" | "_$ais" | "_$supers" | "_$proxies" | "_$super" | "_importantEvts" | "afterCreated_" | "afterInit" | "$class" | "get$Class" | "$oid" | "$instanceof" | "$super" | "proxy" | "desktop" | "fire" | "onSize" | "$n" | "hide" | "toJSON" | "$weave" | "isVisible" | "scrollIntoView" | "$n_" | "z$rod" | "_rodopen" | "z_virnd" | "$button" | "$inputWidget" | "_uplder" | "_autodisable_self" | "_uploading" | "offsetWidth" | "offsetHeight" | "blankPreserved" | "getInputNode" | "z_rod" | "_z$rd" | "z$display" | "prolog" | "_rodKid" | "_node" | "_nodeSolved" | "_rmAftAnm" | "_$evproxs" | "_fellows" | "_norenderdefer" | "_rerendering" | "domExtraAttrs" | "_flexListened" | "_cssFlexApplied" | "_beforeSizeHasScroll" | "doAfterProcessRerenderArgs" | "_vflex" | "_hflex" | "_flexFixed" | "_nvflex" | "_nhflex" | "_hflexsz" | "_vflexsz" | "_binding" | "rawId" | "_$service" | "childReplacing_" | "_userZIndex" | "_zIndex" | "z_isDataHandlerBound" | "_drag" | "_preWidth" | "_preHeight" | "_action" | "_tabindex" | "_draggable" | "_asaps" | "_lsns" | "_bklsns" | "_subnodes" | "_subzcls" | "_sclass" | "_zclass" | "_width" | "_height" | "_left" | "_top" | "_tooltiptext" | "_droppable" | "_dropTypes" | "_fitSizeListened" | "_focus" | "_visible" | "_mold" | "_style" | "_renderdefer" | "_cssflex" | "actions_" | "nChildren" | "bindLevel" | "className" | "widgetName" | "autag" | "_floating" | "firstChild" | "lastChild" | "parent" | "nextSibling" | "previousSibling" | "id" | "inServer" | "uuid" | "insertingBefore_" | "effects_" | "setMold" | "getMold" | "setStyle" | "getStyle" | "setSclass" | "getSclass" | "setZclass" | "getZclass" | "setWidth" | "getWidth" | "setHeight" | "getHeight" | "setLeft" | "getLeft" | "setTop" | "getTop" | "setTooltiptext" | "getTooltiptext" | "setDroppable" | "getDroppable" | "setVflex" | "getVflex" | "isVflex" | "setHflex" | "getHflex" | "isHflex" | "getRenderdefer" | "setRenderdefer" | "getAction" | "setAction" | "getTabindex" | "setTabindex" | "getCssflex" | "isCssflex" | "setCssflex" | "setHflex_" | "setVflex_" | "afterAnima_" | "setDraggable" | "getDraggable" | "$o" | "$f" | "getId" | "setId" | "set" | "_setServerListener" | "get" | "getChildAt" | "getChildIndex" | "setChildren" | "appendChild" | "shallChildROD_" | "insertBefore" | "beforeChildRemoved_" | "triggerBeforeHostChildRemoved_" | "removeChild" | "detach" | "clear" | "replaceWidget" | "replaceCavedChildren_" | "beforeParentChanged_" | "triggerBeforeHostParentChanged_" | "afterParentChanged_" | "isRealVisible" | "setVisible" | "isFocus" | "setFocus" | "zsync" | "show" | "setDomVisible_" | "beforeChildAdded_" | "triggerBeforeHostChildAdded_" | "onChildAdded_" | "triggerAfterHostChildAdded_" | "onChildRemoved_" | "triggerAfterHostChildRemoved_" | "onChildReplaced_" | "onChildVisible_" | "onChildRenderDefer_" | "setTopmost" | "setFloatZIndex_" | "getFloatZIndex_" | "getTopWidget" | "isFloating_" | "setFloating_" | "getZIndex" | "getZindex" | "setZIndex" | "setZindex" | "getScrollTop" | "getScrollLeft" | "setScrollTop" | "setScrollLeft" | "redraw" | "deferRedraw_" | "deferRedrawHTML_" | "forcerender" | "updateDomClass_" | "updateDomStyle_" | "_domTextStyle" | "getTextNode" | "domStyle_" | "domClass_" | "domAttrs_" | "domExtraAttrs_" | "domTooltiptext_" | "domTextStyleAttr_" | "replaceHTML" | "getOldWidget_" | "redrawHTML_" | "rerender" | "rerenderLater_" | "replaceChildHTML_" | "insertChildHTML_" | "getCaveNode" | "getFirstNode_" | "removeChildHTML_" | "removeHTML_" | "$service" | "$afterCommand" | "isRealElement" | "inRerendering_" | "$s" | "clearCache" | "unbindRod_" | "getPage" | "isBinding" | "rerenderNow_" | "bindMissingAncestors" | "bind" | "unbind" | "bind_" | "bindChildren_" | "unbind_" | "unbindChildren_" | "extraBind_" | "setFlexSize_" | "setFlexSizeH_" | "setFlexSizeW_" | "beforeChildReplaced_" | "beforeChildrenFlex_" | "afterChildrenFlex_" | "afterChildMinFlexChanged_" | "ignoreFlexSize_" | "ignoreChildNodeOffset_" | "beforeMinFlex_" | "beforeParentMinFlex_" | "afterChildrenMinFlex_" | "afterResetChildSize_" | "isExcludedHflex_" | "isExcludedVflex_" | "getChildMinSize_" | "getParentSize_" | "getMarginSize_" | "getContentEdgeHeight_" | "getContentEdgeWidth_" | "fixFlex_" | "fixMinFlex_" | "clearCachedSize_" | "resetSize_" | "getFlexContainer_" | "getFlexDirection_" | "afterClearFlex_" | "initDrag_" | "cleanDrag_" | "getDragNode" | "getDragOptions_" | "ignoreDrag_" | "getDrop_" | "dropEffect_" | "getDragMessage_" | "onDrop_" | "cloneDrag_" | "uncloneDrag_" | "onAfterSize" | "bindSwipe_" | "unbindSwipe_" | "bindDoubleTap_" | "unbindDoubleTap_" | "bindTapHold_" | "unbindTapHold_" | "focus" | "focus_" | "canActivate" | "smartUpdate" | "fireX" | "beforeSendAU_" | "sendAU_" | "shallIgnoreClick_" | "listen" | "unlisten" | "isListen" | "setListeners" | "setListeners0" | "setListener" | "setListener0" | "setOverride" | "setOverrides" | "doSelect_" | "doTooltipOver_" | "doTooltipOut_" | "doClick_" | "doDoubleClick_" | "doRightClick_" | "doMouseOver_" | "doMouseOut_" | "doMouseDown_" | "doMouseUp_" | "doMouseMove_" | "doKeyDown_" | "doKeyUp_" | "doKeyPress_" | "doPaste_" | "doSwipe_" | "doFocus_" | "doBlur_" | "doResizeScroll_" | "domListen_" | "domUnlisten_" | "listenOnFitSize_" | "unlistenOnFitSize_" | "fromPageCoord" | "isWatchable_" | "ignoreDescendantFloatUp_" | "getDomEvtInf_" | "shallFireSizedLaterWhenAddChd_" | "afterCompose_" | "_$binder" | "$ZKBINDER$" | "$ZKMATCHMEDIA$" | "$binder" | "z$rod0" | "_afterComposed" | "_beforeAfterComposeCallbacks" | "_disabledShadowAdjustment" | "_context" | "_popup" | "_doScrollableSyncScroll" | "_tooltip" | "_ctrlKeys" | "_parsedCtlKeys" | "getContext" | "setContext" | "getPopup" | "setPopup" | "getTooltip" | "setTooltip" | "getCtrlKeys" | "setCtrlKeys" | "_parsePopParams" | "_smartFellow" | "afterKeyDown_" | "beforeCtrlKeys_" | "_align" | "setAlign" | "getAlign" | "_name" | "getName" | "setName" | "_src" | "getSrc" | "setSrc" | "_scrolling" | "_autohide" | "isAutohide" | "setAutohide" | "getScrolling" | "setScrolling"

    • F extends any

    Parameters

    • klass: typeof ZKObject

      the class that invokes this method.

    • name: M

      the method name to invoke

    • args: Parameters<F>

      an array of arguments. In most case, you just pass arguments (the built-in variable).

    Returns ReturnType<F>

    the object being returned by the method of the superclass.

    See

    zk.Object.$super

    Since

    5.0.2

  • Specifies a function that shall be called after the object is initialized, i.e., after zk.Object.$init is called. This method can be called only during the execution of zk.Object.$init.

    It is an advance feature that is used to allow a base class to do something that needs to wait for all deriving classes have been initialized.

    Invocation Sequence:

    • The most derived class's $init (subclass)
    • The based class's $init (if the derived class's $init invokes this.$supers('$init', arguments))
    • The first function, if any, be added with afterInit, then the second (in the same order that afterInit was called)...

    Parameters

    • func: CallableFunction

      the function to register for execution later

    Returns void

    See

    zk.Object.$init

    Deprecated

    as of 10.0 released. Using afterCreated_ instead.

  • Append a child widget. The child widget will be attached to the DOM tree automatically, if this widget has been attached to the DOM tree, unless this widget is zk.Desktop. In other words, you have to attach child widgets of zk.Desktop manually (by use of, say, replaceHTML).

    Subclass Note

    • If this widget is bound to the DOM tree, this method invoke insertChildHTML_ to insert the DOM content of the child to the DOM tree. Thus, override insertChildHTML_ if you want to insert more than the DOM content generated by redraw.
    • If a widget wants to do something when the parent is changed, overrides beforeParentChanged_ (which is called by insertBefore, removeChild and appendChild).
    • insertBefore might invoke this method (if the widget shall be the last child). To know if it is the case you can check insertingBefore_.

    Parameters

    • child: Widget<HTMLElement>

      the child widget to add

    • Optional ignoreDom: boolean

      whether not to generate DOM elements could prevent it from generating DOM element. It is usually used with rerender.

    Returns boolean

    whether the widget was added successfully. It returns false if the child is always the last child (lastChild).

  • Binds this widget. It is called to associate (aka., attach) the widget with the DOM tree.

    Notice that you rarely need to invoke this method, since it is called automatically (such as replaceHTML and appendChild).

    Notice that you rarely need to override this method, either. Rather, override bind_ instead.

    Parameters

    • Optional desktop: Desktop

      the desktop the DOM element belongs to. If not specified, ZK will decide it automatically.

    • Optional skipper: Skipper

      used if rerender is called with a non-null skipper.

    • Optional bindSelfOnly: boolean

      set to true if one doesn't want to recursively bind descendents.

    Returns this

    See

  • Recursively bind ancestors that are currently unbound (i.e., desktop is falsy). Used by ROD. Introduced by ZK-5368.

    Parameters

    • Optional desktop: Desktop

      the desktop the DOM element belongs to. If not specified, ZK will decide it automatically.

    • Optional skipper: Skipper

      used if rerender is called with a non-null skipper.

    Returns this

    Since

    9.6.4

  • Checks if this widget can be activated (gaining focus and so on).

    Parameters

    • Optional opts: Partial<{
          checkOnly: boolean;
      }>

      the options. Allowed values:

      • checkOnly: not to change focus back to modal dialog if unable to activate. If not specified, the focus will be changed back to _global_.zk#currentModal. In additions, if specified, it will ignore zk#busy, which is set if zk.AuCmd0#showBusy is called. This flag is usually set by focus, and not set if it is caused by user's activity, such as clicking.
      The reason to ignore busy is that we allow application to change focus even if busy, while the user cannot.

    Returns boolean

    Default Value

    return false if it is not a descendant of
    {@link _global_.zk#currentModal}.
  • Removes all children.

    Returns void

  • Removes this widget (from its parent). If it was attached to a DOM tree, the associated DOM elements will be removed, too.

    Returns void

  • Fire a widget event. An instance of zk.Event is created to represent the event.

    The event listeners for this event will be called one-by-one unless zk.Event#stop is called.

    If the event propagation is not stopped (i.e., zk.Event#stop not called) and inServer is true, the event will be converted to an AU request and sent to the server. Refer to ZK Client-side Reference: AU Requests: Client-side Firing for more information.

    Parameters

    • evtnm: string

      the event name, such as onClick

    • Optional data: unknown

      the data depending on the event (zk.Event).

    • Optional opts: EventOptions

      the options. Refer to zk.Event#opts

    • Optional timeout: number

      the delay before sending the non-deferrable AU request (if necessary). If not specified or negative, it is decided automatically. It is ignored if no non-deferrable listener is registered at the server.

    Returns Event<unknown>

    the event being fired.

  • Fire a widget event.

    Parameters

    • evt: Event<unknown>

      the event to fire

    • Optional timeout: number

      the delay before sending the non-deferrable AU request (if necessary). If not specified or negative, it is decided automatically. It is ignored if no non-deferrable listener is registered at the server.

    Returns Event<unknown>

    the event being fired, i.e., evt.

  • Sets the focus to this widget. This method will check if this widget can be activated by invoking canActivate first.

    Notice: don't override this method. Rather, override focus_, which this method depends on.

    Parameters

    • Optional timeout: number

      how many milliseconds before changing the focus. If not specified or negative, the focus is changed immediately,

    Returns boolean

    whether the focus is gained to this widget.

  • Forces the rendering if it is deferred. A typical way to defer the render is to specify setRenderdefer with a non-negative value. The other example is some widget might be optimized for the performance by not rendering some or the whole part of the widget. If the rendering is deferred, the corresponding DOM elements (Widget.$n) are not available. If it is important to you, you can force it to be rendered.

    Notice that this method only forces this widget to render. It doesn't force any of its children. If you want, you have invoke forcerender one-by-one

    The derived class shall override this method, if it implements the render deferring (other than setRenderdefer).

    Returns void

    Since

    5.0.2

  • Converts a coordinate related to the browser window into the coordinate related to this widget.

    Parameters

    • x: number

      the X coordinate related to the browser window

    • y: number

      the Y coordinate related to the browser window

    Returns Offset

    the coordinate related to this widget (i.e., [0, 0] is the left-top corner of the widget).

    Since

    5.0.2

  • Parameters

    • name: string

      the name of property.

    Returns unknown

    a value from the specified property.

    Since

    5.0.2

  • Type Parameters

    Returns T

    the class of the subsclass which extends from zk.Class.

    Since

    10.0.0

  • Returns undefined | string

    the client-side action.

    Since

    5.0.6

  • Returns undefined | string

    the alignment.

    Default Value

    null (use browser default).

    Deprecated

    as of release 6.0.0, use CSS instead.

  • Called by insertChildHTML_ to find the location to place the DOM element of the child. More precisely, the node returned by getCaveNode is the parent DOM element of the child's DOM element.

    Returns undefined | HTMLElement

    Default Value

    this.$n('cave') || this.$n() You can override it to return whatever DOM element you want.

    See

    insertChildHTML_

  • Type Parameters

    Parameters

    • j: number

      the index of the child widget to return. 0 means the first child, 1 for the second and so on.

    • Optional skipHidden: boolean

      whether to skip hidden child widgets, defaults to false.

    Returns undefined | T

    the child widget at the specified index or null if no such index.

    Notice this method is not good if there are a lot of children since it iterates all children one by one.

  • Returns number

    the child index of this widget. By child index we mean the order of the child list of the parent. For example, if this widget is the parent's first child, then 0 is returned.

    Notice that getChildAt is called against the parent, while this method called against the child. In other words, `w.parent.getChildAt(w.getChildIndex())` returns `w`.

    Notice this method is not good if there are a lot of children since it iterates all children one by one.

  • Returns undefined | string

    the ID of the popup (zul.wgt.Popup) that should appear when the user right-clicks on the element (aka., context menu).

    Default Value

    null (no context menu).

  • Returns boolean

    whether using css flex in this component or not.

    Since

    9.0.0

  • Returns undefined | string

    what keystrokes to intercept.

    Default Value

    null.

  • Returns HTMLElement

    the DOM element of this widget that can be dragged.

    Default Value

    it returns {@link Widget.$n}, i.e., the user can drag the widget anywhere.
    

    See

    ignoreDrag_

  • Returns string | boolean

    the identifier of a draggable type for this widget, or null if not draggable.

  • Returns undefined | string | boolean

    the identifier, or a list of identifiers of a droppable type for this widget, or null if not droppable.

  • Returns undefined | string

    the height of this widget.

    See

    getWidth

  • Returns undefined | string | boolean

    horizontal flex hint of this widget.

    See

    setHflex

  • Returns undefined | string

    the identifier of this widget, or null if not assigned. It is the same as id.

  • Returns undefined | HTMLInputElement

  • Returns undefined | string

    the left of this widget.

    See

    getTop

  • Returns string

    this widget's mold. A mold is a template to render a widget. In other words, a mold represents a visual presentation of a widget. Depending on implementation, a widget can have multiple molds.

  • Returns undefined | string

    the frame name.

    Default Value

    null (use browser default).

  • Returns undefined | Page

    the page that this widget belongs to, or null if there is no page available.

  • Returns undefined | string

    the ID of the popup (zul.wgt.Popup) that should appear when the user clicks on the element.

    Default Value

    null (no popup).

  • Returns number

    the number of milliseconds before rendering this component at the client.

    Default Value

    -1 (don't wait).

    Since

    5.0.2

  • Returns undefined | string

    the CSS class of this widget.

    See

    • setSclass
    • getZclass
    • getStyle
  • Returns number

    the scroll left of the associated DOM element of this widget. 0 is always returned if this widget is not bound to a DOM element yet.

  • Returns number

    the scroll top of the associated DOM element of this widget. 0 is always returned if this widget is not bound to a DOM element yet.

  • Returns undefined | string

    the scroll bars.

    Default Value

    "auto"

    Deprecated

    as of release 7.0.0, use CSS instead.

  • Returns undefined | string

    the src.

    Default Value

    null.

  • Returns undefined | string

    the CSS style of this widget

    See

    • setStyle
    • getSclass
    • getZclass
  • Returns undefined | number

    the tab order of this component.

    Since

    8.0.2

  • Returns undefined | HTMLElement

    the DOM element that is used to hold the text, or null if this widget doesn't show any text.

    Default Value

    return null (no text node).
    <p>For example, {@link updateDomStyle_} will change the style
    of the text node, if any, to make sure the text is displayed correctly.
    <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Component_Development/Client-side/Text_Styles_and_Inner_Tags">ZK Client-side Reference: Text Styles and Inner Tags</a>.

    See

    • domTextStyleAttr_
    • updateDomStyle_
  • Returns undefined | string

    the ID of the popup (zul.wgt.Popup) that should be used as a tooltip window when the mouse hovers over the element for a moment. The tooltip will automatically disappear when the mouse is moved away.

    Default Value

    null (no tooltip).

  • Returns undefined | string

    the tooltip text of this widget.

  • Returns undefined | string

    the top of this widget.

    See

    getLeft

  • Returns undefined | Widget<HTMLElement>

    the top widget, which is the first floating ancestor, or null if no floating ancestor.

    See

    isFloating_

  • Returns undefined | string | boolean

    vertical flex hint of this widget.

    See

    setVflex

  • Returns undefined | string

    the width of this widget.

    See

    getHeight

  • Returns string | number

    the Z index.

  • Returns string

    the ZK Cascading Style class(es) for this widget.

    See

    • setZclass
    • getSclass
    • getStyle
  • Returns string | number

  • Makes this widget invisible. It is a shortcut of setVisible(false)

    Returns this

  • Inserts a child widget before the reference widget (the sibling argument).

    Subclass Note

    • If this widget is bound to the DOM tree, this method invoke insertChildHTML_ to insert the DOM content of the child to the DOM tree. Thus, override insertChildHTML_ if you want to insert more than the DOM content generated by redraw.
    • If a widget wants to do something when the parent is changed, overrides beforeParentChanged_ (which is called by insertBefore, removeChild and appendChild).

    Parameters

    • child: Widget<HTMLElement>

      the child widget

    • Optional sibling: Widget<HTMLElement>

      the sibling widget (the 'insert' point where the new widget will be placed before). If null or omitted, it is the same as appendChild

    • Optional ignoreDom: boolean

    Returns boolean

    whether the widget was added successfully. It returns false if the child is always the last child (lastChild).

  • Returns boolean

    whether to automatically hide this component if a popup or dropdown is overlapped with it.

    Default Value

    false.

    If an iframe contains PDF or other non-HTML resource, it is possible that it obscues the popup that shall be shown above it. To resolve this, you have to specify autohide="true" to this component, and specify the following in the page: ```html