# 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)

- zul.Widget<HTMLIFrameElement>
  - Iframe
    - Jasperreport

#####
Index

### Constructors

constructor

### Properties

$ZKBINDER$?
$ZKMATCHMEDIA$?
$button?
$inputWidget?
$oid
$weave?
_afterComposed
_beforeAfterComposeCallbacks
_disabledShadowAdjustment
autag?
bindLevel
blankPreserved?
className
desktop?
doAfterProcessRerenderArgs
domExtraAttrs?
firstChild?
id?
inServer
lastChild?
nChildren
nextSibling?
offsetHeight?
offsetWidth?
parent?
previousSibling?
prolog?
rawId
uuid
widgetName
z$display?
z$rod?
z$rod0?
z_isDataHandlerBound
z_rod?
z_virnd?
$oid
auDelay
molds

### Accessors

$class

### Methods

$afterCommand
$binder
$f
$init
$instanceof
$n
$n_
$o
$s
$service
$super
$supers
afterAnima_
afterChildMinFlexChanged_
afterChildrenFlex_
afterChildrenMinFlex_
afterClearFlex_
afterCompose_
afterInit
afterParentChanged_
afterResetChildSize_
appendChild
beforeChildAdded_
beforeChildRemoved_
beforeChildReplaced_
beforeChildrenFlex_
beforeMinFlex_
beforeParentChanged_
beforeParentMinFlex_
beforeSendAU_
bind
bindChildren_
bindDoubleTap_
bindMissingAncestors
bindSwipe_
bindTapHold_
canActivate
cleanDrag_
clear
clearCache
clearCachedSize_
cloneDrag_
deferRedrawHTML_
deferRedraw_
detach
doBlur_
doDoubleClick_
doFocus_
doKeyPress_
doKeyUp_
doMouseDown_
doMouseMove_
doMouseOut_
doMouseOver_
doMouseUp_
doPaste_
doResizeScroll_
doSelect_
doSwipe_
domClass_
domExtraAttrs_
domListen_
domStyle_
domTextStyleAttr_
domTooltiptext_
domUnlisten_
dropEffect_
extraBind_
fire
fireX
fixFlex_
fixMinFlex_
focus
focus_
forcerender
fromPageCoord
get
get$Class
getAction
getAlign
getCaveNode
getChildAt
getChildIndex
getChildMinSize_
getContentEdgeHeight_
getContentEdgeWidth_
getContext
getCssflex
getCtrlKeys
getDomEvtInf_
getDragMessage_
getDragNode
getDragOptions_
getDraggable
getDrop_
getDroppable
getFirstNode_
getFlexContainer_
getFlexDirection_
getFloatZIndex_
getHeight
getHflex
getId
getInputNode?
getLeft
getMarginSize_
getMold
getName
getOldWidget_
getPage
getParentSize_
getPopup
getRenderdefer
getSclass
getScrollLeft
getScrollTop
getScrolling
getSrc
getStyle
getTabindex
getTextNode
getTooltip
getTooltiptext
getTop
getTopWidget
getVflex
getWidth
getZIndex
getZclass
getZindex
hide
ignoreChildNodeOffset_
ignoreDescendantFloatUp_
ignoreDrag_
ignoreFlexSize_
inRerendering_
initDrag_
insertBefore
insertChildHTML_
isAutohide
isBinding
isCssflex
isExcludedHflex_
isExcludedVflex_
isFloating_
isFocus
isHflex
isListen
isRealElement
isRealVisible
isVflex
isVisible
isWatchable_
listen
listenOnFitSize_
onAfterSize
onChildAdded_
onChildRemoved_
onChildRenderDefer_
onChildReplaced_
onChildVisible_
onDrop_
onSize
proxy
redraw
redrawHTML_
removeChild
removeChildHTML_
removeHTML_
replaceCavedChildren_
replaceChildHTML_
replaceHTML
replaceWidget
rerender
rerenderLater_
rerenderNow_
resetSize_
scrollIntoView
sendAU_
set
setAction
setAlign
setAutohide
setChildren
setContext
setCssflex
setCtrlKeys
setDomVisible_
setDraggable
setDroppable
setFlexSizeH_
setFlexSizeW_
setFlexSize_
setFloatZIndex_
setFloating_
setFocus
setHeight
setHflex
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
setVflex_
setVisible
setWidth
setZIndex
setZclass
setZindex
shallChildROD_
shallFireSizedLaterWhenAddChd_
shallIgnoreClick_
show
smartUpdate
toJSON
triggerAfterHostChildAdded_
triggerAfterHostChildRemoved_
triggerBeforeHostChildAdded_
triggerBeforeHostChildRemoved_
triggerBeforeHostParentChanged_
unbind
unbindChildren_
unbindDoubleTap_
unbindRod_
unbindSwipe_
unbindTapHold_
uncloneDrag_
unlisten
unlistenOnFitSize_
updateDomClass_
updateDomStyle_
zsync
$
disableChildCallback
enableChildCallback
getClass
getElementsById
getElementsByName
getOpenTooltip
getWidgetByUuid
isAssignableFrom
isAutoId
isInstance
newInstance
nextUuid
register
uuid

## Constructors

### constructor

- new Iframe(props?): Iframe

- #### Parameters

  - ##### `Optional` props: Record<string, unknown> | (() => void)

  #### Returns Iframe

  Inherited from Widget.constructor

## Properties

### `Optional` $ZKBINDER$

$ZKBINDER$?: boolean

Inherited from Widget.$ZKBINDER$

### `Optional` $ZKMATCHMEDIA$

$ZKMATCHMEDIA$?: string[]

Inherited from Widget.$ZKMATCHMEDIA$

### `Optional` $button

$button?: boolean

Inherited from Widget.$button

### `Optional` $inputWidget

$inputWidget?: boolean

Inherited from Widget.$inputWidget

### $oid

$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)

Inherited from Widget.$oid

### `Optional` $weave

$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.

Inherited from Widget.$weave

### _afterComposed

_afterComposed: boolean

Inherited from Widget._afterComposed

### _beforeAfterComposeCallbacks

_beforeAfterComposeCallbacks: CallableFunction[]

Inherited from Widget._beforeAfterComposeCallbacks

### _disabledShadowAdjustment

_disabledShadowAdjustment: boolean

Inherited from Widget._disabledShadowAdjustment

### `Optional` autag

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

Inherited from Widget.autag

### `Readonly` bindLevel

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.

Inherited from Widget.bindLevel

### `Optional` blankPreserved

blankPreserved?: boolean

Inherited from Widget.blankPreserved

### className

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

Inherited from Widget.className

### `Optional` `Readonly` desktop

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.

Inherited from Widget.desktop

### doAfterProcessRerenderArgs

doAfterProcessRerenderArgs: undefined | unknown[]

Inherited from Widget.doAfterProcessRerenderArgs

### `Optional` domExtraAttrs

domExtraAttrs?: Record<string, string>

Inherited from Widget.domExtraAttrs

### `Optional` `Readonly` firstChild

firstChild?: Widget<HTMLElement>

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

#### See

getChildAt

Inherited from Widget.firstChild

### `Optional` `Readonly` id

id?: string

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

It is the same as getId.

To change the value, use setId.

Inherited from Widget.id

### `Readonly` inServer

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()`).

Inherited from Widget.inServer

### `Optional` `Readonly` lastChild

lastChild?: Widget<HTMLElement>

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

#### See

getChildAt

Inherited from Widget.lastChild

### `Readonly` nChildren

nChildren: number = 0

The number of children (integer).

Inherited from Widget.nChildren

### `Optional` `Readonly` nextSibling

nextSibling?: Widget<HTMLElement>

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

Inherited from Widget.nextSibling

### `Optional` offsetHeight

offsetHeight?: any

Inherited from Widget.offsetHeight

### `Optional` offsetWidth

offsetWidth?: any

Inherited from Widget.offsetWidth

### `Optional` `Readonly` parent

parent?: Widget<HTMLElement>

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

Inherited from Widget.parent

### `Optional` `Readonly` previousSibling

previousSibling?: Widget<HTMLElement>

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

Inherited from Widget.previousSibling

### `Optional` prolog

prolog?: string

Inherited from Widget.prolog

### rawId

rawId: any

Inherited from Widget.rawId

### uuid

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.

Inherited from Widget.uuid

### widgetName

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

Inherited from Widget.widgetName

### `Optional` z$display

z$display?: string

Inherited from Widget.z$display

### `Optional` z$rod

z$rod?: boolean

Inherited from Widget.z$rod

### `Optional` z$rod0

z$rod0?: false

Inherited from Widget.z$rod0

### z_isDataHandlerBound

z_isDataHandlerBound: any

Inherited from Widget.z_isDataHandlerBound

### `Optional` z_rod

z_rod?: number | boolean

Inherited from Widget.z_rod

### `Optional` z_virnd

z_virnd?: boolean

Inherited from Widget.z_virnd

### `Static` $oid

$oid: any

Inherited from Widget.$oid

### `Static` auDelay

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

Inherited from Widget.auDelay

### `Static` molds

molds: {
default(out): void;
}

#### Type declaration

- ##### default:function

  - default(out): void

  - #### Parameters

    - ##### out: string[]

    #### Returns void

Inherited from Widget.molds

## Accessors

### $class

- get $class(): typeof ZKObject

- The class that this object belongs to.

  #### Returns typeof ZKObject

  Inherited from zul.Widget.$class

## Methods

### $afterCommand

- $afterCommand(command, args?): void

- #### Parameters

  - ##### command: string

  - ##### `Optional` args: unknown[]

  #### Returns void

  Inherited from Widget.$afterCommand

### $binder

- $binder(): undefined | Binder

- #### Returns undefined | Binder

  Inherited from Widget.$binder

### $f

- $f(): undefined | Record<string, Widget<HTMLElement>>

- #### Returns undefined | Record<string, Widget<HTMLElement>>

  the map of all fellows of this widget.

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

  #### Since

  5.0.2

  Inherited from Widget.$f

- $f<T>(id, global?): undefined | T

- #### Type Parameters

  - #### T extends Widget<HTMLElement> = Widget<HTMLElement>

  #### 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.

  Inherited from Widget.$f

### $init

- $init(props?): void

- 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.

  Inherited from Widget.$init

### $instanceof

- $instanceof(...klass): boolean

- 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

  Inherited from Widget.$instanceof

### $n

- $n(): undefined | HTMLIFrameElement

- #### 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)

  Inherited from Widget.$n

- $n<T>(subId?): undefined | T

- #### 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.

  #### See

  Widget.$n

  Inherited from Widget.$n

### $n_

- $n_(): HTMLIFrameElement

- #### Returns HTMLIFrameElement

  the DOM element that this widget is bound to. (Never null)

  #### See

  Widget.$n_

  #### Since

  10.0.0

  Inherited from Widget.$n_

- $n_<T>(subId): T

- #### Type Parameters

  - #### T extends HTMLElement = HTMLElement

  #### Parameters

  - ##### subId: undefined | string

    the sub ID of the child element

  #### Returns T

  the child element of the DOM element(s) that this widget is bound to. (Never null)

  #### See

  Widget.$n_

  #### Since

  10.0.0

  Inherited from Widget.$n_

### $o

- $o<T>(): undefined | T

- #### Type Parameters

  - #### T extends Widget<HTMLElement> = Widget<HTMLElement>

  #### 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.

  Inherited from Widget.$o

### $s

- $s(subclass?): string

- #### 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

  Inherited from Widget.$s

### $service

- $service(): undefined | Service

- #### Returns undefined | Service

  the service instance from the current widget, if any.

  #### Since

  8.0.0

  Inherited from Widget.$service

### $super

- $super<M, F>(mtd, ...args): ReturnType<F>

- 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_" | "_hflexWidth" | "_$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.

  #### See

  zk.Object.$supers

  Inherited from Widget.$super

- $super<M, F>(klass, mtd, ...args): ReturnType<F>

- 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_" | "_hflexWidth" | "_$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

  Inherited from Widget.$super

### $supers

- $supers<M, F>(name, args): ReturnType<F>

- 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_" | "_hflexWidth" | "_$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.

  #### See

  zk.Object.$super

  Inherited from Widget.$supers

- $supers<M, F>(klass, name, args): ReturnType<F>

- 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_" | "_hflexWidth" | "_$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

  Inherited from Widget.$supers

### afterAnima_

- afterAnima_(visible): void

- Invoked after an animation (e.g., zjq.slideDown) has finished. You could override to clean up anything related to animation. Notice that, if you override, you have to call back this method.

  #### Parameters

  - ##### visible: boolean

    whether the result of the animation will make the DOM element visible

  #### Returns void

  #### Since

  5.0.6

  Inherited from Widget.afterAnima_

### afterChildMinFlexChanged_

- afterChildMinFlexChanged_(kid, attr): void

- #### Parameters

  - ##### kid: Widget<HTMLElement>

  - ##### attr: FlexOrient

  #### Returns void

  Inherited from Widget.afterChildMinFlexChanged_

### afterChildrenFlex_

- afterChildrenFlex_(kid?): void

- #### Parameters

  - ##### `Optional` kid: Widget<HTMLElement>

  #### Returns void

  Inherited from Widget.afterChildrenFlex_

### afterChildrenMinFlex_

- afterChildrenMinFlex_(orient): void

- #### Parameters

  - ##### orient: FlexOrient

  #### Returns void

  Inherited from Widget.afterChildrenMinFlex_

### afterClearFlex_

- afterClearFlex_(): void

- #### Returns void

  Inherited from Widget.afterClearFlex_

### afterCompose_

- afterCompose_(): void

- A callback called after a widget is composed but not yet be bound to DOM tree.

  #### Returns void

  #### Since

  10.0.0

  Inherited from Widget.afterCompose_

### afterInit

- afterInit(func): void

- 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.

  Inherited from Widget.afterInit

### afterParentChanged_

- afterParentChanged_(oldparent?): void

- A callback called after the parent has been changed.

  #### Parameters

  - ##### `Optional` oldparent: Widget<HTMLElement>

    the previous parent (null if it was not attached) The current parent can be found by parent.

  #### Returns void

  #### Since

  5.0.4

  #### See

  beforeParentChanged_

  Inherited from Widget.afterParentChanged_

### afterResetChildSize_

- afterResetChildSize_(attr): void

- #### Parameters

  - ##### attr: string

  #### Returns void

  Inherited from Widget.afterResetChildSize_

### appendChild

- appendChild(child, ignoreDom?): boolean

- 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).

  #### See

  insertBefore

  Inherited from Widget.appendChild

### beforeChildAdded_

- beforeChildAdded_(child, insertBefore?): boolean

- Called before adding a child. If a widget accepts only certain types of children, it shall override this method and return false for an illegal child.

  #### Parameters

  - ##### child: Widget<HTMLElement>

    the child to be added (never null).

  - ##### `Optional` insertBefore: Widget<HTMLElement>

    another child widget that the new child will be inserted before it. If null, the new child will be the last child.

  #### Returns boolean

  whether the widget was able to added.

  #### Since

  10.0.0

  Inherited from Widget.beforeChildAdded_

### beforeChildRemoved_

- beforeChildRemoved_(child): void

- A callback called before removing a child.

  #### Parameters

  - ##### child: Widget<HTMLElement>

    the child being removed.

  #### Returns void

  #### Since

  10.0.0

  Inherited from Widget.beforeChildRemoved_

### beforeChildReplaced_

- beforeChildReplaced_(oldc, newc): void

- #### Parameters

  - ##### oldc: Widget<HTMLElement>

  - ##### newc: Widget<HTMLElement>

  #### Returns void

  Inherited from Widget.beforeChildReplaced_

### beforeChildrenFlex_

- beforeChildrenFlex_(kid): boolean

- #### Parameters

  - ##### kid: Widget<HTMLElement>

  #### Returns boolean

  Inherited from Widget.beforeChildrenFlex_

### beforeMinFlex_

- beforeMinFlex_(attr): undefined | number

- #### Parameters

  - ##### attr: FlexOrient

  #### Returns undefined | number

  Inherited from Widget.beforeMinFlex_

### beforeParentChanged_

- beforeParentChanged_(newparent?): void

- A callback called before the parent is changed.

  #### Parameters

  - ##### `Optional` newparent: Widget<HTMLElement>

    the new parent (null if it is removed) The previous parent can be found by parent.

  #### Returns void

  #### See

  - onChildAdded_
  - onChildRemoved_
  - afterParentChanged_

  Inherited from Widget.beforeParentChanged_

### beforeParentMinFlex_

- beforeParentMinFlex_(attr): void

- #### Parameters

  - ##### attr: FlexOrient

  #### Returns void

  Inherited from Widget.beforeParentMinFlex_

### beforeSendAU_

- beforeSendAU_(wgt, evt): void

- Callback before sending an AU request. It is called by sendAU_.

  #### Parameters

  - ##### wgt: Widget<HTMLElement>

    the widget that causes the AU request to be sent. It will be the target widget when the server receives the event.

  - ##### evt: Event<unknown>

    the event to be sent back to the server. Its content will be cloned to the AU request.

  #### Returns void

  #### Default Value

      this method will stop the event propagation
      and prevent the browser's default handling
      (by calling {@link zk.Event#stop}),
      if the event is onClick, onRightClick or onDoubleClick.
      <p>Notice that {@link sendAU_} is called against the widget sending the AU request
      to the server, while {@link beforeSendAU_} is called against the event's
      target (evt.target).

      <p>Notice that since this method will stop the event propagation for onClick,
      onRightClick and onDoubleClick, it means the event propagation is stopped
      if the server registers a listener. However, it doesn't stop if
      only a client listener is registered (and, in this case, {@link zk.Event#stop}
      must be called explicitly if you want to stop).

  #### See

  sendAU_

  #### Since

  5.0.2

  Inherited from Widget.beforeSendAU_

### bind

- bind(desktop?, skipper?, bindSelfOnly?): this

- 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

  - bind_
  - unbind

  Inherited from Widget.bind

### bindChildren_

- bindChildren_(desktop?, skipper?, after?): void

- Binds the children of this widget. It is called by bind_ to invoke child's bind_ one-by-one.

  #### 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` after: CallableFunction[]

    an array of function (Function) that will be invoked after bind_ has been called. For example,

  #### Returns void

  #### Since

  5.0.5

  Inherited from Widget.bindChildren_

### bindDoubleTap_

- bindDoubleTap_(): void

- Bind double click event to the widget on tablet device. It is called if the widget is listen to onDoubleClick event.

  You rarely need to override this method, unless you want to implement double click behavior differently.

  #### Returns void

  #### See

  doDoubleClick_

  #### Since

  6.5.0

  Inherited from Widget.bindDoubleTap_

### bindMissingAncestors

- bindMissingAncestors(desktop?, skipper?): this

- 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

  Inherited from Widget.bindMissingAncestors

### bindSwipe_

- bindSwipe_(): void

- Bind swipe event to the widget on tablet device. It is called if HTML 5 data attribute (data-swipeable) is set to true.

  You rarely need to override this method, unless you want to bind swipe behavior differently.

  #### Returns void

  #### Default Value

      use {@link zk.Swipe} to implement swipe event.

  #### See

  doSwipe_

  #### Since

  6.5.0

  Inherited from Widget.bindSwipe_

### bindTapHold_

- bindTapHold_(): void

- Bind right click event to the widget on tablet device. It is called if the widget is listen to onRightClick event.

  You rarely need to override this method, unless you want to implement right click behavior differently.

  #### Returns void

  #### See

  doRightClick_

  #### Since

  6.5.1

  Inherited from Widget.bindTapHold_

### canActivate

- canActivate(opts?): boolean

- 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}.

  Inherited from Widget.canActivate

### cleanDrag_

- cleanDrag_(): void

- Cleans up the widget to make it un-draggable. It is called if getDraggable is cleaned (or unbound).

  You rarely need to override this method, unless you want to handle drag-and-drop differently.

  #### Returns void

  #### See

  cleanDrag_

  Inherited from Widget.cleanDrag_

### clear

- clear(): void

- Removes all children.

  #### Returns void

  Inherited from Widget.clear

### clearCache

- clearCache(): void

- Clears the cached nodes (by Widget.$n).

  #### Returns void

  Inherited from Widget.clearCache

### clearCachedSize_

- clearCachedSize_(): void

- #### Returns void

  Inherited from Widget.clearCachedSize_

### cloneDrag_

- cloneDrag_(drag, ofs): HTMLElement

- Called to create the visual effect representing what is being dragged. In other words, it creates the DOM element that will be moved with the mouse pointer when the user is dragging.

  This method is called if getDragMessage_ returns null. If getDragMessage_ returns a string (empty or not), a small popup containing the message is created to represent the widget being dragged.

  You rarely need to override this method, unless you want a different visual effect.

  #### Parameters

  - ##### drag: Draggable

    the draggable controller

  - ##### ofs: Offset

    the offset of the returned element (left/top)

  #### Returns HTMLElement

  #### See

  uncloneDrag_

  Inherited from Widget.cloneDrag_

### deferRedrawHTML_

- deferRedrawHTML_(out): void

- Renders a fake DOM element that will replace with the correct element after the deferring time is up. The method is designed for some widgets to override, such as Treeitem, Listitem, and Row, whose HTML tag is created inside a table.

  By default, the Div tag is assumed.

  #### Parameters

  - ##### out: string[]

    an array to output the HTML fragments.

  #### Returns void

  #### Since

  5.0.6

  Inherited from Widget.deferRedrawHTML_

### deferRedraw_

- deferRedraw_(out): boolean

- Utilities for handling the so-called render defer (setRenderdefer). This method is called automatically by redraw, so you only need to use it if you override redraw.

  A typical usage is as follows. ```ts redraw: function (out) { if (!this.deferRedraw_(out)) { out.push(...); //redraw } } ```

  #### Parameters

  - ##### out: undefined | string[]

    an array to output the HTML fragments.

  #### Returns boolean

  #### Since

  5.0.2

  Inherited from Widget.deferRedraw_

### detach

- detach(): 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

  #### See

  removeChild

  Inherited from Widget.detach

### doBlur_

- doBlur_(evt): void

- A utility to simplify the listening of `onBlur`. Unlike other doXxx_ (such as doClick_), a widget needs to listen the onBlur event explicitly if it might gain and lose the focus.

  For example, ```ts var fn = this.$n('focus'); this.domListen_(fn, 'onFocus', 'doFocus_'); this.domListen_(fn, 'onBlur', 'doBlur_'); ```

  Of course, you can listen it with jQuery DOM-level utilities, if you pefer to handle it differently.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doBlur_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  doFocus_

  Inherited from Widget.doBlur_

### doDoubleClick_

- doDoubleClick_(evt): void

- Called when the user double-clicks on a widget or a child widget. A widget doesn't need to listen the dblclick DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and call parent's
      doDoubleClick_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>Note: if {@link shallIgnoreClick_} returns true, {@link fireX} won't be
      called and this method invokes the parent's {@link doDoubleClick_} instead
      (unless {@link zk.Event#stopped} is set).
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doClick_
  - doRightClick_

  Inherited from Widget.doDoubleClick_

### doFocus_

- doFocus_(evt): void

- A utility to simplify the listening of `onFocus`. Unlike other doXxx_ (such as doClick_), a widget needs to listen the onFocus event explicitly if it might gain and lose the focus.

  For example, ```ts var fn = this.$n('focus'); this.domListen_(fn, 'onFocus', 'doFocus_'); this.domListen_(fn, 'onBlur', 'doBlur_'); ```

  Of course, you can listen it with jQuery DOM-level utilities, if you pefer to handle it differently.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doFocus_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  doBlur_

  Inherited from Widget.doFocus_

### doKeyPress_

- doKeyPress_(evt): void

- Called when the user presses a key when this widget has the focus (focus).

  Notice that not every widget can have the focus. A widget doesn't need to listen the keypress DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doKeyPress_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doKeyDown_
  - doKeyUp_

  Inherited from Widget.doKeyPress_

### doKeyUp_

- doKeyUp_(evt): void

- Called when the user presses up a key when this widget has the focus (focus).

  Notice that not every widget can have the focus. A widget doesn't need to listen the keyup DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doKeyUp_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doKeyDown_
  - doKeyPress_

  Inherited from Widget.doKeyUp_

### doMouseDown_

- doMouseDown_(evt): void

- Called when the user presses down the mouse button on this widget (or one of its child widget). A widget doesn't need to listen the mousedown DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doMouseDown_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doMouseMove_
  - doMouseOver_
  - doMouseOut_
  - doMouseUp_
  - doClick_

  Inherited from Widget.doMouseDown_

### doMouseMove_

- doMouseMove_(evt): void

- Called when the user moves the mouse pointer over this widget (or one of its child widget). A widget doesn't need to listen the mousemove DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doMouseMove_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doMouseOver_
  - doMouseOut_
  - doMouseDown_
  - doMouseUp_

  Inherited from Widget.doMouseMove_

### doMouseOut_

- doMouseOut_(evt): void

- Called when the user moves the mouse pointer out of a widget (or one of its child widget). A widget doesn't need to listen the mouseout DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

    See also ZK Client-side Reference: Notifications

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doMouseOut_ if the event propagation is not stopped ({@link zk.Event#stopped}).

  #### See

  - doMouseMove_
  - doMouseOver_
  - doMouseDown_
  - doMouseUp_
  - doTooltipOut_

  Inherited from Widget.doMouseOut_

### doMouseOver_

- doMouseOver_(evt): void

- Called when the user moves the mouse pointer on top of a widget (or one of its child widget). A widget doesn't need to listen the mouseover DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doMouseOver_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doMouseMove_
  - doMouseOver_
  - doMouseOut_
  - doMouseDown_
  - doMouseUp_
  - doTooltipOver_

  Inherited from Widget.doMouseOver_

### doMouseUp_

- doMouseUp_(evt): void

- Called when the user presses up the mouse button on this widget (or one of its child widget). A widget doesn't need to listen the mouseup DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doMouseUp_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doMouseMove_
  - doMouseOver_
  - doMouseOut_
  - doMouseDown_
  - doClick_

  Inherited from Widget.doMouseUp_

### doPaste_

- doPaste_(evt): void

- Called when the user paste text to this widget which has been the focused (focus).

  Notice that not every widget can have the focus. A widget doesn't need to listen the paste DOM event. Rather, it shall override this method if necessary.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doPaste_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.
      <p>See also <a href="http://books.zkoss.org/wiki/ZK_Client-side_Reference/Notifications">ZK Client-side Reference: Notifications</a>

  #### See

  - doKeyDown_
  - doKeyUp_
  - doKeyPress_

  Inherited from Widget.doPaste_

### doResizeScroll_

- doResizeScroll_(): void

- Resize zul.Scrollbar size after child added/removed or hide/show.

  #### Returns void

  #### Since

  6.5.0

  Inherited from Widget.doResizeScroll_

### doSelect_

- doSelect_(evt): void

- Called when the user clicks or right-clicks on widget or a child widget. It is called before doClick_ and doRightClick_.

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event. The original DOM event and target can be retrieved by zk.Event#domEvent and zk.Event#domTarget

  #### Returns void

  #### Default Value

      does nothing but invokes the parent's {@link doSelect_}.
      Notice that it does not fire any event.
      <p>Deriving class that supports selection (such as {@link zul.sel.ItemWidget})
      shall override this to handle the selection.
      <p>Technically, the selection can be handled in {@link doClick_}.
      However, it is better to handle here since this method is invoked first
      such that the widget will be selected before one of its descendant widget
      handles {@link doClick_}.
      <p>Notice that calling {@link zk.Event#stop} will stop the invocation of
      parent's {@link doSelect_} and {@link doClick_}/{@link doRightClick_}.
      If you just don't want to call parent's {@link doSelect_}, simply
      not to invoke super's doSelect_.

  #### See

  - doClick_
  - doRightClick_

  #### Since

  5.0.1

  Inherited from Widget.doSelect_

### doSwipe_

- doSwipe_(evt): void

- Called when the user swipe left/right/up/down this widget.

  For example, ```ts var opts = evt.opts, dir = opts.dir; switch (dir) { case 'left': doSwipeLeft(); break; case 'right': doSwipeRight(); break; case 'up': doSwipeUp(); break; case 'down': doSwipeDown(); break; } ``` To define swipe direction rather than default condition, ```ts var opts = evt.opts, start = opts.start, stop = opts.stop, dispT = stop.time - start.time, deltaX = start.coords[0] - stop.coords[0], deltaY = start.coords[1] - stop.coords[1], dispX = Math.abs(deltaX), dispY = Math.abs(deltaY);

  //if swipe time is less than 500ms, it is considered as swipe event if (dispT < 500) { //if horizontal displacement is larger than 30px and vertical displacement is smaller than 75px, it is considered swipe left/right if (dispX > 30 && dispY < 75) //swipe left if deltaX > 0

  //if vertical displacement is large than 30px and horizontal displacement is smaller than 75px, it is considered swipe up/down else if (dispY > 30 && dispX < 75) //swipe up if deltaY > 0 } ```

  #### Parameters

  - ##### evt: Event<unknown>

    the widget event.

  #### Returns void

  #### Default Value

      fire the widget event ({@link fireX}), and
      call parent's doSwipe_ if the event propagation is not stopped ({@link zk.Event#stopped}).
      It is the so-called event propagation.

  #### Since

  6.5.0

  Inherited from Widget.doSwipe_

### domClass_

- domClass_(no?): string

- #### Parameters

  - ##### `Optional` no: DomClassOptions

    [options] the style class to exclude (i.e., to turn off). If omitted, it means none (i.e., all included). For example, you don't want sclass to generate, call `domClass_({sclass:1})`. Notice, though a bit counter-intuition, specify 1 (or true) to denote exclusion. Allowed value (subclass might support more options):

    - sclass - exclude getSclass
    - zclass - exclude getZclass

  #### Returns string

  the class name(s) used for the DOM element of this widget, such as `"z-button foo"`

  #### Default Value

      a concatenation of {@link getZclass} and {@link getSclass}.

  #### See

  - domStyle_
  - domAttrs_

  Inherited from Widget.domClass_

### domExtraAttrs_

- domExtraAttrs_(): string

- #### Returns string

  Inherited from Widget.domExtraAttrs_

### domListen_

- domListen_(node, evtnm, fn?, keyword?): this

- Registers an DOM event listener for the specified DOM element (aka., node). You can use jQuery to listen the DOM event directly, or use this method instead.

      bind_: function () {
        this.$supers('bind_', arguments);
        this.domListen_(this.$n(), "onChange"); //fn is omitted, so _doChange is assumed
        this.domListen_(this.$n("foo"), "onSelect", "_doFooSelect"); //specify a particular listener
      },
      unbind_: function () {
        this.domUnlisten_(this.$n(), "onChange"); //unlisten
        this.domUnlisten_(this.$n("foo"), "onSelect", "_doFooSelect");
        this.$supers('unbind_', arguments);
      },
      _doChange_: function (evt) { //evt is an instance of zk.Event
        //event listener
      },
      _doFooSelect: function (evt) {
      }

  See also ZK Client-side Reference: Notifications

  ### Design Mode

  If a widget is created and controlled by ZK Weaver for visual design, we call the widget is in design mode (Widget.$weave). Furthermore, this method does nothing if the widget is in the design mode. Thus, if you want to listen a DOM event (jq.Event), you have to use jQuery directly.

  #### Parameters

  - ##### node: HTMLElement | JQuery<HTMLElement>

    a node of this widget. It is usually retrieved by Widget.$n.

  - ##### evtnm: string

    the event name to register, such as onClick.

  - ##### `Optional` fn: string | CallableFunction

    the name (String) of the member method to handle the event, or the function (Function). It is optional. If omitted, _doEvtnm is assumed, where evtnm is the value passed thru the `evtnm` argument. For example, if the event name is onFocus, then the method is assumed to be _doFocus.

  - ##### `Optional` keyword: unknown

    the extra argumenet for the function, which is passed into the callback function. (since 7.0)

  #### Returns this

  #### See

  domUnlisten_

  Inherited from Widget.domListen_

### domStyle_

- domStyle_(no?): string

- #### Parameters

  - ##### `Optional` no: DomStyleOptions

    [options] the style to exclude (i.e., to turn off). If omitted, it means none (i.e., all included). For example, you don't want width to generate, call `domStyle_({width:1})`. Notice, though a bit counter-intuition, specify 1 (or true) to denote exclusion. Allowed value (subclass might support more options):

    - style - exclude getStyle
    - width - exclude getWidth
    - height - exclude getHeight
    - left - exclude getLeft
    - top - exclude getTop
    - zIndex - exclude getZIndex
    - visible - exclude isVisible

  #### Returns string

  the style used for the DOM element of this widget, such as `"width:100px;z-index:1;"`

  #### Default Value

      a concatenation of style, width, visible and so on.

  #### See

  - domClass_
  - domAttrs_

  Inherited from Widget.domStyle_

### domTextStyleAttr_

- domTextStyleAttr_(): undefined | string

- #### Returns undefined | string

  the style attribute that contains only the text related CSS styles. For example, it returns style="font-size:12pt;font-weight:bold" if #getStyle is border:none;font-size:12pt;font-weight:bold.

  It is usually used with getTextNode to ZK Client-side Reference: Text Styles and Inner Tags.

  #### See

  getTextNode

  Inherited from Widget.domTextStyleAttr_

### domTooltiptext_

- domTooltiptext_(): undefined | string

- #### Returns undefined | string

  the tooltiptext for generating the title attribute of the DOM element.

  #### Default Value

      return {@link getTooltiptext}.
      <p>Deriving class might override this method if the parent widget
      is not associated with any DOM element, such as treerow's parent: treeitem.

  #### Since

  5.0.2

  Inherited from Widget.domTooltiptext_

### domUnlisten_

- domUnlisten_(n, evtnm, fn?, keyword?): this

- Un-registers an event listener for the specified DOM element (aka., node).

  Refer to domListen_ for more information.

  #### Parameters

  - ##### n: HTMLElement | JQuery<HTMLElement>

  - ##### evtnm: string

    the event name to register, such as onClick.

  - ##### `Optional` fn: string | CallableFunction

    the name (String) of the member method to handle the event, or the function (Function). It is optional. If omitted, _doEvtnm is assumed, where evtnm is the value passed thru the `evtnm` argument. For example, if the event name is onFocus, then the method is assumed to be _doFocus.

  - ##### `Optional` keyword: unknown

    the extra argumenet for the function, which is passed into the callback function. (since 7.0)

  #### Returns this

  #### See

  domListen_

  Inherited from Widget.domUnlisten_

### dropEffect_

- dropEffect_(over?): void

- Called to have some visual effect when the user is dragging a widget over this widget and this widget is droppable. Notice it is the effect to indicate a widget is droppable.

  #### Parameters

  - ##### `Optional` over: boolean

    whether the user is dragging over (or out, if false)

  #### Returns void

  #### Default Value

      it adds the CSS class named 'z-drag-over' if over is true, and remove it if over is false.

  Inherited from Widget.dropEffect_

### extraBind_

- extraBind_(uuid, add): void

- Associates UUID with this widget.

  Notice that uuid is automatically associated (aka., bound) to this widget. Thus, you rarely need to invoke this method unless you want to associate with other identifiers.

  For example, ZK Google Maps uses this method since it has to bind the anchors manually.

  #### Parameters

  - ##### uuid: string

    the UUID to assign to the widgtet

  - ##### add: boolean

    whether to bind. Specify true if you want to bind; false if you want to unbind.

  #### Returns void

  Inherited from Widget.extraBind_

### fire

- fire(evtnm, data?, opts?, timeout?): Event<unknown>

- 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.

  #### See

  - fire
  - listen

  Inherited from Widget.fire

### fireX

- fireX(evt, timeout?): Event<unknown>

- 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.

  #### See

  - fire
  - listen

  Inherited from Widget.fireX

### fixFlex_

- fixFlex_(): void

- #### Returns void

  Inherited from Widget.fixFlex_

### fixMinFlex_

- fixMinFlex_(n, orient): number

- #### Parameters

  - ##### n: HTMLElement

  - ##### orient: FlexOrient

  #### Returns number

  Inherited from Widget.fixMinFlex_

### focus

- focus(timeout?): boolean

- 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.

  Inherited from Widget.focus

### focus_

- focus_(timeout?): boolean

- Called by focus to set the focus.

  #### 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.

  #### Default Value

  call child widget's focus until it returns true, or no child at all.

  ### Subclass Note

  - If a widget is able to gain focus, it shall override this method to invoke _global_.jqzk#focus.
  - It is called only if the DOM element is real visible (so you don't need to check again)
  ```ts focus_: function (timeout) { zk(this.$n('foo').focus(timeout); return true; } ```

  #### Since

  5.0.5

  Inherited from Widget.focus_

### forcerender

- forcerender(): void

- 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

  Inherited from Widget.forcerender

### fromPageCoord

- fromPageCoord(x, y): Offset

- 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

  Inherited from Widget.fromPageCoord

### get

- get(name): unknown

- #### Parameters

  - ##### name: string

    the name of property.

  #### Returns unknown

  a value from the specified property.

  #### Since

  5.0.2

  Inherited from Widget.get

### get$Class

- get$Class<T>(): T

- #### Type Parameters

  - #### T extends typeof ZKObject

  #### Returns T

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

  #### Since

  10.0.0

  Inherited from Widget.get$Class

### getAction

- getAction(): undefined | string

- #### Returns undefined | string

  the client-side action.

  #### Since

  5.0.6

  Inherited from Widget.getAction

### getAlign

- getAlign(): undefined | string

- #### Returns undefined | string

  the alignment.

  #### Default Value

  `null` (use browser default).

  #### Deprecated

  as of release 6.0.0, use CSS instead.

### getCaveNode

- getCaveNode(): undefined | HTMLElement

- 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_

  Inherited from Widget.getCaveNode

### getChildAt

- getChildAt<T>(j, skipHidden?): undefined | T

- #### Type Parameters

  - #### T extends Widget<HTMLElement>

  #### 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.

  #### See

  getChildIndex

  Inherited from Widget.getChildAt

### getChildIndex

- getChildIndex(): number

- #### 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.

  Inherited from Widget.getChildIndex

### getChildMinSize_

- getChildMinSize_(attr, wgt): number

- #### Parameters

  - ##### attr: FlexOrient

  - ##### wgt: Widget<HTMLElement>

  #### Returns number

  Inherited from Widget.getChildMinSize_

### getContentEdgeHeight_

- getContentEdgeHeight_(height): number

- #### Parameters

  - ##### height: number

  #### Returns number

  Inherited from Widget.getContentEdgeHeight_

### getContentEdgeWidth_

- getContentEdgeWidth_(width): number

- #### Parameters

  - ##### width: number

  #### Returns number

  Inherited from Widget.getContentEdgeWidth_

### getContext

- getContext(): undefined | string

- #### 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).

  Inherited from Widget.getContext

### getCssflex

- getCssflex(): boolean

- #### Returns boolean

  whether using css flex in this component or not.

  #### Since

  9.0.0

  Inherited from Widget.getCssflex

### getCtrlKeys

- getCtrlKeys(): undefined | string

- #### Returns undefined | string

  what keystrokes to intercept.

  #### Default Value

  `null`.

  Inherited from Widget.getCtrlKeys

### getDomEvtInf_

- getDomEvtInf_(wgt, evtnm, fn?, keyword?): [string, JQueryEventHandler]

- #### Parameters

  - ##### wgt: Widget<HTMLElement>

  - ##### evtnm: string

  - ##### `Optional` fn: string | CallableFunction

  - ##### `Optional` keyword: unknown

  #### Returns [string, JQueryEventHandler]

  Inherited from Widget.getDomEvtInf_

### getDragMessage_

- getDragMessage_(): undefined | string

- #### Returns undefined | string

  the message to show when an user is dragging this widget, or null if it prefers to clone the widget with cloneDrag_.

  #### Default Value

      it return the inner text if if {@link Widget.$n} returns a TR, TD, or TH element. Otherwise, it returns null and {@link cloneDrag_} will be called to create a DOM element to indicate dragging.
      <p>Notice that the text would be encoded for XSS issue since 8.0.4.2. It should be considered when overriding.

  Inherited from Widget.getDragMessage_

### getDragNode

- getDragNode(): HTMLElement

- #### 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_

  Inherited from Widget.getDragNode

### getDragOptions_

- getDragOptions_(map): DraggableOptions

- #### Parameters

  - ##### map: DraggableOptions

    the default implementation

  #### Returns DraggableOptions

  the options used to instantiate zk.Draggable.

  #### Default Value

  it does nothing but returns the `map` parameter, i.e., the default options.

  Though rarely used, you can override any option passed to zk.Draggable, such as the start effect, ghosting and so on.

  Inherited from Widget.getDragOptions_

### getDraggable

- getDraggable(): string | boolean

- #### Returns string | boolean

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

  Inherited from Widget.getDraggable

### getDrop_

- getDrop_(dragged): undefined | Widget<HTMLElement>

- #### Parameters

  - ##### dragged: Widget<HTMLElement>

    the widget being dragged (never null).

  #### Returns undefined | Widget<HTMLElement>

  the widget if it allows to drop the specified widget (being dragged), or null if not allowed. It is called when the user is dragging a widget on top a widget.

  #### Default Value

      it check if the values of droppable and draggable match. It will check the parent ({@link parent}), parent's parent, and so on until matched, or none of them are matched.
      <p>Notice that the widget to test if droppable might be the same as the widget being dragged (i.e., this == dragged). By default, we consider them as non-matched.

  Inherited from Widget.getDrop_

### getDroppable

- getDroppable(): undefined | string | boolean

- #### Returns undefined | string | boolean

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

  Inherited from Widget.getDroppable

### getFirstNode_

- getFirstNode_(): undefined | HTMLElement

- #### Returns undefined | HTMLElement

  the first DOM element of this widget. If this widget has no corresponding DOM element, this method will look for its siblings.

  This method is designed to be used with insertChildHTML_ for retrieving the DOM element of the `before` widget.

  Inherited from Widget.getFirstNode_

### getFlexContainer_

- getFlexContainer_(): undefined | HTMLElement

- #### Returns undefined | HTMLElement

  Inherited from Widget.getFlexContainer_

### getFlexDirection_

- getFlexDirection_(): undefined | string

- #### Returns undefined | string

  Inherited from Widget.getFlexDirection_

### getFloatZIndex_

- getFloatZIndex_(node): string | number

- #### Parameters

  - ##### node: HTMLElement

    the element whose z-index needs to be set. It is the value specified in `opts.node` when setFloating_ is called. If not specified, it is the same as Widget.$n.

  #### Returns string | number

  the z-index of a floating widget. It is called by setTopmost to decide the topmost z-index, and called only if setFloating_ is ever called.

  #### Since

  5.0.3

  #### See

  setFloating_

  Inherited from Widget.getFloatZIndex_

### getHeight

- getHeight(): undefined | string

- #### Returns undefined | string

  the height of this widget.

  #### See

  getWidth

  Inherited from Widget.getHeight

### getHflex

- getHflex(): undefined | string | boolean

- #### Returns undefined | string | boolean

  horizontal flex hint of this widget.

  #### See

  setHflex

  Inherited from Widget.getHflex

### getId

- getId(): undefined | string

- #### Returns undefined | string

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

  Inherited from Widget.getId

### `Optional` getInputNode

- getInputNode(): undefined | HTMLInputElement

- #### Returns undefined | HTMLInputElement

  Inherited from Widget.getInputNode

### getLeft

- getLeft(): undefined | string

- #### Returns undefined | string

  the left of this widget.

  #### See

  getTop

  Inherited from Widget.getLeft

### getMarginSize_

- getMarginSize_(attr): number

- #### Parameters

  - ##### attr: FlexOrient

  #### Returns number

  Inherited from Widget.getMarginSize_

### getMold

- getMold(): string

- #### 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.

  Inherited from Widget.getMold

### getName

- getName(): undefined | string

- #### Returns undefined | string

  the frame name.

  #### Default Value

  `null` (use browser default).

### getOldWidget_

- getOldWidget_(n): undefined | Widget<HTMLElement>

- #### Parameters

  - ##### n: string | HTMLElement

    the DOM element to match the widget.

  #### Returns undefined | Widget<HTMLElement>

  the widget associated with the given node element. It is used by replaceHTML and replaceChildHTML_ to retrieve the widget associated with the note.

  It is similar to Widget.$ but it gives the widget a chance to handle extreme cases. For example, Treeitem doesn't associate a DOM element (or you can say Treeitem and Treerow shares the same DOM element), so `zk.Widget.$(n)` will return Treerow, not Treeitem. If it is the case, you can override it to make replaceHTML works correctly.

  #### Since

  5.0.3

  Inherited from Widget.getOldWidget_

### getPage

- getPage(): undefined | Page

- #### Returns undefined | Page

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

  Inherited from Widget.getPage

### getParentSize_

- getParentSize_(p): {
  height: number;
  width: number;
  }

- #### Parameters

  - ##### p: HTMLElement

  #### Returns {
  height: number;
  width: number;
  }

  - ##### height: number

  - ##### width: number

  Inherited from Widget.getParentSize_

### getPopup

- getPopup(): undefined | string

- #### 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).

  Inherited from Widget.getPopup

### getRenderdefer

- getRenderdefer(): number

- #### Returns number

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

  #### Default Value

  `-1` (don't wait).

  #### Since

  5.0.2

  Inherited from Widget.getRenderdefer

### getSclass

- getSclass(): undefined | string

- #### Returns undefined | string

  the CSS class of this widget.

  #### See

  - setSclass
  - getZclass
  - getStyle

  Inherited from Widget.getSclass

### getScrollLeft

- getScrollLeft(): number

- #### 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.

  Inherited from Widget.getScrollLeft

### getScrollTop

- getScrollTop(): number

- #### 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.

  Inherited from Widget.getScrollTop

### getScrolling

- getScrolling(): undefined | string

- #### Returns undefined | string

  the scroll bars.

  #### Default Value

  `"auto"`

  #### Deprecated

  as of release 7.0.0, use CSS instead.

### getSrc

- getSrc(): undefined | string

- #### Returns undefined | string

  the src.

  #### Default Value

  `null`.

### getStyle

- getStyle(): undefined | string

- #### Returns undefined | string

  the CSS style of this widget

  #### See

  - setStyle
  - getSclass
  - getZclass

  Inherited from Widget.getStyle

### getTabindex

- getTabindex(): undefined | number

- #### Returns undefined | number

  the tab order of this component.

  #### Since

  8.0.2

  Inherited from Widget.getTabindex

### getTextNode

- getTextNode(): undefined | HTMLElement

- #### 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_

  Inherited from Widget.getTextNode

### getTooltip

- getTooltip(): undefined | string

- #### 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).

  Inherited from Widget.getTooltip

### getTooltiptext

- getTooltiptext(): undefined | string

- #### Returns undefined | string

  the tooltip text of this widget.

  Inherited from Widget.getTooltiptext

### getTop

- getTop(): undefined | string

- #### Returns undefined | string

  the top of this widget.

  #### See

  getLeft

  Inherited from Widget.getTop

### getTopWidget

- getTopWidget(): undefined | Widget<HTMLElement>

- #### Returns undefined | Widget<HTMLElement>

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

  #### See

  isFloating_

  Inherited from Widget.getTopWidget

### getVflex

- getVflex(): undefined | string | boolean

- #### Returns undefined | string | boolean

  vertical flex hint of this widget.

  #### See

  setVflex

  Inherited from Widget.getVflex

### getWidth

- getWidth(): undefined | string

- #### Returns undefined | string

  the width of this widget.

  #### See

  getHeight

  Inherited from Widget.getWidth

### getZIndex

- getZIndex(): string | number

- #### Returns string | number

  the Z index.

  Inherited from Widget.getZIndex

### getZclass

- getZclass(): string

- #### Returns string

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

  #### See

  - setZclass
  - getSclass
  - getStyle

  Inherited from Widget.getZclass

### getZindex

- getZindex(): string | number

- #### Returns string | number

  Inherited from Widget.getZindex

### hide

- hide(): this

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

  #### Returns this

  Inherited from Widget.hide

### ignoreChildNodeOffset_

- ignoreChildNodeOffset_(attr): boolean

- #### Parameters

  - ##### attr: FlexOrient

  #### Returns boolean

  Inherited from Widget.ignoreChildNodeOffset_

### ignoreDescendantFloatUp_

- ignoreDescendantFloatUp_(des): boolean

- A widget call this function of its ancestor if it wants to know whether its ancestor prefer ignore float up event of it self.

  #### Parameters

  - ##### des: Widget<HTMLElement>

  #### Returns boolean

  #### Default Value

  `false`.

  #### Since

  6.0.0

  Inherited from Widget.ignoreDescendantFloatUp_

### ignoreDrag_

- ignoreDrag_(pt, evt?, drag?): boolean

- #### Parameters

  - ##### pt: Offset

  - ##### `Optional` evt: Event<unknown>

  - ##### `Optional` drag: Draggable

  #### Returns boolean

  if the location that an user is trying to drag is allowed, i.e., whether to ignore.

  #### Default Value

      it always returns false.
      If the location that an user can drag is static, override {@link getDragNode},
      which is easier to implement.

  Inherited from Widget.ignoreDrag_

### ignoreFlexSize_

- ignoreFlexSize_(attr): boolean

- #### Parameters

  - ##### attr: FlexOrient

  #### Returns boolean

  Inherited from Widget.ignoreFlexSize_

### inRerendering_

- inRerendering_(): boolean

- #### Returns boolean

  whether the widget is in re-rendering phases.

  #### Since

  10.0.0

  Inherited from Widget.inRerendering_

### initDrag_

- initDrag_(): void

- Initializes the widget to make it draggable. It is called if getDraggable is set (and bound).

  You rarely need to override this method, unless you want to handle drag-and-drop differently.

  #### Returns void

  #### Default Value

      use {@link zk.Draggable} to implement drag-and-drop,
      and the handle to drag is the element returned by {@link getDragNode}

  #### See

  cleanDrag_

  Inherited from Widget.initDrag_

### insertBefore

- insertBefore(child, sibling?, ignoreDom?): boolean

- 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).

  #### See

  appendChild

  Inherited from Widget.insertBefore

### insertChildHTML_

- insertChildHTML_(child, before?, desktop?): void

- Inserts the HTML content generated by the specified child widget before the reference widget (the before argument). It is called by insertBefore and appendChild to handle the DOM tree.

  Deriving classes might override this method to modify the HTML content, such as enclosing with TD.

  Notice that when inserting the child (without the before argument), this method will call getCaveNode 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. The default implementation of getCaveNode is to look for a sub-node named uuid$cave. In other words, it tried to place the child inside the so-called cave sub-node, if any. Otherwise, Widget.$n is assumed.

  #### Parameters

  - ##### child: Widget<HTMLElement>

    the child widget to insert

  - ##### `Optional` before: Widget<HTMLElement>

    the child widget as the reference to insert the new child before. If null, the HTML content will be appended as the last child. The implementation can use before.getFirstNode_() (getFirstNode_) to retrieve the DOM element

  - ##### `Optional` desktop: Desktop

  #### Returns void

  #### See

  getCaveNode

  Inherited from Widget.insertChildHTML_

### isAutohide

- isAutohide(): boolean

- #### 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