jqzk (ZK Client Engine 9.6.4 API)

java.lang.Object
- _global_.jqzk

```
public class jqzk
extends java.lang.Object
```
Represents the object returned by the zk function, or by jq.zk. For example, zk('#id');
Refer to jq for more information.
Other Extension
- jq - the object returned by jq(...). The original jQuery API.
- jq - DOM utilities (such as, jq.innerX()
- Event - the event object passed to the event listener

Field Summary

Fields
Modifier and Type Field and Description

jq jq
The associated instance of jq, the object returned by jq(...)

Fields
Modifier and Type	Field and Description
`jq`	`jq` The associated instance of `jq`, the object returned by `jq(...)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`$()` A short cut for looking up ZK Widget from jQuery object.
`jqzk`	`absolutize()` Makes the position of the first selected element as absolute.
`void`	`beforeHideOnUnbind()` Fixes DOM elements when a widget's unbind_ is called and it will hide the DOM element (display="none" or visibility="hidden").
`int`	`borderHeight()` Returns the summation of the border height of the first matched element.
`int`	`borderWidth()` Returns the summation of the border width of the first matched element.
`int`	`cellIndex()` Retrieves the index of the first selected (table) cell in the cells collection of a (table) row.
`jqzk`	`center(Map flags)` Positions the first selected element at the particular location of the browser window.
`jq`	`cleanVisibility()` Cleans, i.e., reset, the visibility (of the CSS style) for the matched elements.
`jqzk`	`clearStyles()` Clears the CSS styles (excluding the inherited styles).
`int`	`clientHeightCeil()` Returns the actual client height rounded "up" to the closest integer.
`double`	`clientHeightDoubleValue()` Returns the client height.
`int`	`clientWidthCeil()` Returns the actual client width rounded "up" to the closest integer.
`double`	`clientWidthDoubleValue()` Returns the client width.
`Offset`	`cmOffset()` Returns the cumulative offset of the first matched element from the top left corner of the document.
`int`	`contentHeight(boolean excludeMargin)` Returns the content height of the element, which substracted the height of its CSS border or padding, unlike `revisedHeight(int, boolean)`, the contentHeight will ignore the box-sizing with border-box.
`int`	`contentWidth(boolean excludeMargin)` Returns the content width of the element, which substracted the width of its CSS border or padding, unlike `revisedWidth(int, boolean)`, the contentWidth will ignore the box-sizing with border-box.
`jqzk`	`defaultAnimaOpts(Widget wgt, Map opts, Array prop, boolean visible)` Initializes the animation with the default effect, such as firing the onSize watch.
`Array`	`detachChildren()` Detaches all child elements and return them as an array.
`Dimension`	`dimension(boolean revised)` Returns the dimension of the specified element.
`jqzk`	`disableSelection()` Disallows the user to select a portion of its content.
`jqzk`	`enableSelection()` Allows the user to select a portion of its content.
`boolean`	`focus(int timeout)` Sets the focus to the first matched element.
`java.lang.Object`	`getAnimationSpeed(java.lang.Object defaultValue)` Get the value of animation speed assigned through client attribute "data-animationspeed"
`Array`	`getSelectionRange()` Returns the selection range of the specified input-type element.
`boolean`	`hasHScroll()` Returns whether the first matched DOM element has the horizontal scrollbar
`boolean`	`hasVParent()` Check if element has virtual parent
`boolean`	`hasVScroll()` Returns whether the first matched DOM element has the vertical scrollbar
`boolean`	`isInput()` Tests if all elements are input elements (including textarea).
`boolean`	`isOverlapped(DOMElement el, int the)` Tests if the first matched element is overlapped with the specified element.
`boolean`	`isRealScrollIntoView()` Checks whether the element is shown in the current viewport (consider both native and fake scrollbar).
`boolean`	`isRealVisible(boolean strict)` Returns whether the first match element is really visible.
`boolean`	`isScrollIntoView()` Checks whether the element is shown in the current viewport.
`boolean`	`isVisible()` Returns whether the first matched element is visible.
`boolean`	`isVisible(boolean strict)` Returns whether the first matched element is visible.
`jqzk`	`makeVParent()` Creates a virtual parent for the specified element.
`int`	`marginHeight()` Returns the summation of the margin height of the first matched element.
`int`	`marginWidth()` Returns the summation of the margin width of the first matched element.
`int`	`ncols(boolean visibleOnly)` Returns the number of columns of a row.
`int`	`offsetHeight()` Returns the offset height.
`int`	`offsetHeightCeil()` Returns the actual offset height rounded "up" to the closest integer.
`double`	`offsetHeightDoubleValue()` Returns the offset height.
`int`	`offsetLeft()` Returns the offset left.
`int`	`offsetLeftCeil()` Returns the actual offset left rounded "up" to the closest integer.
`double`	`offsetLeftDoubleValue()` Returns the offset left.
`int`	`offsetTop()` Returns the offset top.
`int`	`offsetTopCeil()` Returns the actual offset top rounded "up" to the closest integer.
`double`	`offsetTopDoubleValue()` Returns the offset top.
`int`	`offsetWidth()` Returns the offset width.
`int`	`offsetWidthCeil()` Returns the actual offset width rounded "up" to the closest integer.
`double`	`offsetWidthDoubleValue()` Returns the offset width.
`int`	`padBorderHeight()` Returns the summation of the padding height and the border height of the first matched element.
`int`	`padBorderWidth()` Returns the summation of the padding width and the border width of the first matched element.
`int`	`paddingHeight()` Returns the summation of the padding height of the first matched element.
`int`	`paddingWidth()` Returns the summation of the padding width of the first matched element.
`jqzk`	`position(Dimension dim, String where, Map opts)` Position the first matched element to the specified location.
`jqzk`	`position(DOMElement dim, String where, Map opts)` Position the first matched element to the specified location.
`jqzk`	`redoCSS(int timeout)` Forces the browser to redo (re-apply) CSS of all matched elements.
`jqzk`	`redoSrc()` Forces the browser to re-load the resource specified in the `src` attribute for all matched elements.
`jqzk`	`relativize()` Makes the position of the element as relative.
`int`	`revisedHeight(int size, boolean excludeMargin)` Returns the revised (calibrated) height, which subtracted the height of its CSS border or padding, for the first matched element if the box-sizing is not in the border-box mode.
`Offset`	`revisedOffset()` Returns the revised (i.e., browser's coordinate) offset of the selected element.
`Offset`	`revisedOffset(Offset ofs)` Converts the specified offset in the element's coordinate to to the browser window's coordinateReturns the revised (calibrated) offset, i.e., the offset of the element related to the screen.
`int`	`revisedWidth(int size, boolean excludeMargin)` Returns the revised (calibrated) width, which subtracted the width of its CSS border or padding, for the first matched element if the box-sizing is not in the border-box mode.
`jqzk`	`scrollIntoView(DOMElement parent)` Causes the first matched element to scroll into view.
`Offset`	`scrollOffset()` Calculates the cumulative scroll offset of the first matched element in nested scrolling containers.
`jqzk`	`scrollTo()` Scrolls the browser window to make the first matched element visible.
`boolean`	`select(int timeout)` Selects the first matched element.
`jqzk`	`setSelectionRange(int start, int end)` Sets the selection range of the specified input-type element.
`jqzk`	`setStyles()` Deprecated. As of release 5.0.2, use jq.css(map) instead
`jqzk`	`slideDown(Widget wgt, Map opts)` Slides down (show) of the matched DOM element(s).
`jqzk`	`slideIn(Widget wgt, Map opts)` Slides in (show) of the matched DOM element(s).
`jqzk`	`slideOut(Widget wgt, Map opts)` Slides out (hide) of the matched DOM element(s).
`jqzk`	`slideUp(Widget wgt, Map opts)` Slides up (hide) of the matched DOM element(s).
`jqzk`	`submit()` Submit the selected form.
`int`	`sumStyles(String areas, Array styles)` Returns the summation of the specified styles.
`Size`	`textSize(String text)` Deprecated. Use `textWidth(_global_.String)` instead for better performance.
`double`	`textWidth(String text)` Returns the width of the text if it is placed inside the first matched element.
`Offset`	`toStyleOffset(int x, int y)` Converts an offset (x,y) from absolute coordination to the element's style coordination, such that you can assign them to the style (el.style).
`jqzk`	`undoVParent()` Undoes the creation of a virtual parent of the first matched element.
`double`	`vflexHeight()` Returns the maximal allowed height of the first matched element.
`Offset`	`viewportOffset()` Returns the X/Y coordinates of the first matched element relative to the viewport.
`DOMElement`	`vparentNode(boolean real)` Returns the virtual parent of the first matched element.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - jq
```
public jq jq
```
    The associated instance of jq, the object returned by jq(...).
- Method Detail
  - cleanVisibility
```
public jq cleanVisibility()
```
    Cleans, i.e., reset, the visibility (of the CSS style) for the matched elements. Depending on the browser, the reset visibility is either visible or inherit.
    
    Returns:
    
    jq
  - isVisible
```
public boolean isVisible(boolean strict)
```
    Returns whether the first matched element is visible. Returns false if not exist. Returns true if no style attribute.
    
    Parameters:
    
    strict - whether the visibility property must not be hidden, too. If false, only the style.display property is tested. If true, both the style.display and style.visibility properties are tested.
    
    Returns:
    
    boolean whether the first matched element is visible.
  - isVisible
```
public boolean isVisible()
```
    Returns whether the first matched element is visible. Returns false if not exist. Returns true if no style attribute.
    
    Returns:
    
    boolean whether the first matched element is visible.
  - isRealVisible
```
public boolean isRealVisible(boolean strict)
```
    Returns whether the first match element is really visible. By real visible we mean the element and all its ancestors are visible.
    
    Parameters:
    
    strict - whether the visibility property must not be hidden, too. If false, only the style.display property is tested. If true, both the style.display and style.visibility properties are tested.
    
    Returns:
    
    boolean whether the first matched element is really visible.
  - scrollTo
```
public jqzk scrollTo()
```
    Scrolls the browser window to make the first matched element visible.
    Notice that it scrolls only the browser window. If the element is obscured by another element, it is still not visible. To really make it visible, use el.scrollIntoView() instead.
    
    Returns:
    
    jqzk this object
  - scrollIntoView
```
public jqzk scrollIntoView(DOMElement parent)
```
    Causes the first matched element to scroll into view.
    
    Parameters:
    
    parent - scrolls the first matched element into the parent's view, if any. Otherwise, document.body is assumed.
    
    Returns:
    
    jqzk this object
  - isRealScrollIntoView
```
public boolean isRealScrollIntoView()
```
    Checks whether the element is shown in the current viewport (consider both native and fake scrollbar).
    
    Returns:
    
    boolean if false, it means the element is not shown.
    
    Since:
    
    7.0.6
  - hasVScroll
```
public boolean hasVScroll()
```
    Returns whether the first matched DOM element has the vertical scrollbar
    
    Returns:
    
    boolean
    
    Since:
    
    5.0.8
  - hasHScroll
```
public boolean hasHScroll()
```
    Returns whether the first matched DOM element has the horizontal scrollbar
    
    Returns:
    
    boolean
    
    Since:
    
    5.0.8
  - isOverlapped
```
public boolean isOverlapped(DOMElement el,
                            int the)
```
    Tests if the first matched element is overlapped with the specified element.
    
    Parameters:
    
    el - the element to check with
    
    the - tolerant value for the calculation
    
    Returns:
    
    boolean true if they are overlapped.
  - sumStyles
```
public int sumStyles(String areas,
                     Array styles)
```
    Returns the summation of the specified styles. For example,
```
jq(el).zk.sumStyles("lr", jq.paddings);
  //sums the style values of jq.paddings['l'] and jq.paddings['r'].
```
    Parameters:
    
    areas - the areas is abbreviation for left "l", right "r", top "t", and bottom "b". So you can specify to be "lr" or "tb" or more.
    
    styles - an array of styles, such as jq.paddings(), jq.margins() or jq.borders().
    
    Returns:
    
    int the summation
  - revisedOffset
```
public Offset revisedOffset(Offset ofs)
```
    Converts the specified offset in the element's coordinate to to the browser window's coordinateReturns the revised (calibrated) offset, i.e., the offset of the element related to the screen.
    It is calculated by subtracting the offset of the scrollbar (scrollOffset() and jq.innerX()), for the first matched element.
    
    Parameters:
    
    ofs - the offset to revise. If not specified, the first matched element's bounding rectange is assumed.
    
    Returns:
    
    Offset the revised offset
  - revisedOffset
```
public Offset revisedOffset()
```
    Returns the revised (i.e., browser's coordinate) offset of the selected element. In other words, it is the offset of the left-top corner related to the browser window.
    
    Returns:
    
    Offset the revised offset
    
    See Also:
    
    cmOffset()
  - revisedWidth
```
public int revisedWidth(int size,
                        boolean excludeMargin)
```
    Returns the revised (calibrated) width, which subtracted the width of its CSS border or padding, for the first matched element if the box-sizing is not in the border-box mode.
    It is usually used to assign the width to an element (since we have to subtract the padding).
```
el.style.width = zk(parentEL).revisedWidth(100);
```
    Parameters:
    
    size - the width to be assigned to the specified element.
    
    excludeMargin - whether to subtract the margins, too. You rarely need this unless the width is specified in term of the parent's perspective.
    
    Returns:
    
    int the revised width
    
    See Also:
    
    contentWidth(boolean)
  - revisedHeight
```
public int revisedHeight(int size,
                         boolean excludeMargin)
```
    Returns the revised (calibrated) height, which subtracted the height of its CSS border or padding, for the first matched element if the box-sizing is not in the border-box mode.
    It is usually used to assign the height to an element (since we have to subtract the padding).
```
el.style.height = zk(parentEL).revisedHeight(100);
```
    Parameters:
    
    size - # the height to be assigned to the first matched element.
    
    excludeMargin - whether to subtract the margins, too. You rarely need this unless the height is specified in term of the parent's perspective.
    
    Returns:
    
    int the revised height
    
    See Also:
    
    contentHeight(boolean)
  - contentWidth
```
public int contentWidth(boolean excludeMargin)
```
    Returns the content width of the element, which substracted the width of its CSS border or padding, unlike revisedWidth(int, boolean), the contentWidth will ignore the box-sizing with border-box.
    
    Parameters:
    
    excludeMargin - whether to subtract the margins, too.
    
    Returns:
    
    int the content width.
    
    Since:
    
    7.0.0
  - contentHeight
```
public int contentHeight(boolean excludeMargin)
```
    Returns the content height of the element, which substracted the height of its CSS border or padding, unlike revisedHeight(int, boolean), the contentHeight will ignore the box-sizing with border-box.
    
    Parameters:
    
    excludeMargin - whether to subtract the margins, too.
    
    Returns:
    
    int the content height.
    
    Since:
    
    7.0.0
  - marginWidth
```
public int marginWidth()
```
    Returns the summation of the margin width of the first matched element.
    
    Returns:
    
    int summation
    
    Since:
    
    7.0.0
  - marginHeight
```
public int marginHeight()
```
    Returns the summation of the margin height of the first matched element.
    
    Returns:
    
    int summation
    
    Since:
    
    7.0.0
  - borderWidth
```
public int borderWidth()
```
    Returns the summation of the border width of the first matched element.
    
    Returns:
    
    int summation
  - borderHeight
```
public int borderHeight()
```
    Returns the summation of the border height of the first matched element.
    
    Returns:
    
    int summation
  - paddingWidth
```
public int paddingWidth()
```
    Returns the summation of the padding width of the first matched element.
    
    Returns:
    
    int summation
  - paddingHeight
```
public int paddingHeight()
```
    Returns the summation of the padding height of the first matched element.
    
    Returns:
    
    int summation
  - padBorderWidth
```
public int padBorderWidth()
```
    Returns the summation of the padding width and the border width of the first matched element.
    
    Returns:
    
    int the summation
  - padBorderHeight
```
public int padBorderHeight()
```
    Returns the summation of the padding height and the border height of the first matched element.
    
    Returns:
    
    int the summation
  - vflexHeight
```
public double vflexHeight()
```
    Returns the maximal allowed height of the first matched element. In other words, it is the client height of the parent minus all sibling's.
    
    Returns:
    
    double the maximal allowed height
  - cellIndex
```
public int cellIndex()
```
    Retrieves the index of the first selected (table) cell in the cells collection of a (table) row.
    Note: The function fixed the problem of IE that cell.cellIndex returns a wrong index if there is a hidden cell in the table.
    
    Returns:
    
    int the index of the first selected cell
    
    See Also:
    
    ncols(boolean)
  - ncols
```
public int ncols(boolean visibleOnly)
```
    Returns the number of columns of a row. Notice that it, unlike row.cells.length, calculate colSpan, too. In addition, it can filter out invisible cells.
    
    Parameters:
    
    visibleOnly - whether not count invisible cells
    
    Returns:
    
    int the number of columns of the first selected row
    
    See Also:
    
    cellIndex()
  - toStyleOffset
```
public Offset toStyleOffset(int x,
                            int y)
```
    Converts an offset (x,y) from absolute coordination to the element's style coordination, such that you can assign them to the style (el.style).
    
    Parameters:
    
    x - the X coordinate
    
    y - the Y coordinate
    
    Returns:
    
    Offset the offset
  - center
```
public jqzk center(Map flags)
```
    Positions the first selected element at the particular location of the browser window.
```
jq(el).zk.center('left top');
jq(el).zk.center('left center');
jq(el).zk.center('left'); //not to change the Y coordinate
jq(el).zk.center(); //same as 'center'
```
    Parameters:
    
    flags - A combination of center, left, right, top and bottom. If omitted, center is assumed.
    
    Returns:
    
    jqzk this object
    
    See Also:
    
    position(_global_.DOMElement, _global_.String, _global_.Map)
  - position
```
public jqzk position(DOMElement dim,
                     String where,
                     Map opts)
```
    Position the first matched element to the specified location.
    
    Parameters:
    
    dim - the element used to get the dimension of the achor location. (by use of dimension(boolean))
    
    where - where to position. Default: overlap
    Allowed values: refer to position(Dimension,String,Map).
    
    opts - a map of addition options.
    Allowed values: refer to position(Dimension,String,Map).
    
    Returns:
    
    jqzk this object
    
    See Also:
    
    center(_global_.Map)
  - position
```
public jqzk position(Dimension dim,
                     String where,
                     Map opts)
```
    Position the first matched element to the specified location.
    Parameters:
    
    dim - the dimension of the anchor location
    where - where to position. Default: overlap
    Allowed values:
    
    before_start
    the element appears above the anchor, aligned to the left.
    
    before_center
    the element appears above the anchor, aligned to the center.
    
    before_end
    the element appears above the anchor, aligned to the right.
    
    after_start
    the element appears below the anchor, aligned to the left.
    
    after_center
    the element appears below the anchor, aligned to the center.
    
    after_end
    the element appears below the anchor, aligned to the right.
    
    start_before
    the element appears to the left of the anchor, aligned to the top.
    
    start_center
    the element appears to the left of the anchor, aligned to the middle.
    
    start_after
    the element appears to the left of the anchor, aligned to the bottom.
    
    end_before
    the element appears to the right of the anchor, aligned to the top.
    
    end_center
    the element appears to the right of the anchor, aligned to the middle.
    
    end_after
    the element appears to the right of the anchor, aligned to the bottom.
    
    overlap/top_left
    the element overlaps the anchor, with anchor and element aligned at top-left.
    
    top_center
    the element overlaps the anchor, with anchor and element aligned at top-center.
    
    overlap_end/top_right
    the element overlaps the anchor, with anchor and element aligned at top-right.
    
    middle_left
    the element overlaps the anchor, with anchor and element aligned at middle-left.
    
    middle_center
    the element overlaps the anchor, with anchor and element aligned at middle-center.
    
    middle_right
    the element overlaps the anchor, with anchor and element aligned at middle-right.
    
    overlap_before/bottom_left
    the element overlaps the anchor, with anchor and element aligned at bottom-left.
    
    bottom_center
    the element overlaps the anchor, with anchor and element aligned at bottom-center.
    
    overlap_after/bottom_right
    the element overlaps the anchor, with anchor and element aligned at bottom-right.
    
    at_pointer
    the element appears with the upper-left aligned with the mouse cursor.
    
    after_pointer
    the element appears with the top aligned with the bottom of the mouse cursor, with the left side of the element at the horizontal position of the mouse cursor.
    opts - a map of addition options. Allowed values include
    overflow
    whether to allow the element being scrolled out of the visible area (Default: false, i.e., not allowed). If not specified (or false), the popup always remains visible even if the user scrolls the anchor widget out of the visible area
    Returns:
    
    jqzk this object
    
    See Also:
    
    center(_global_.Map)
  - scrollOffset
```
public Offset scrollOffset()
```
    Calculates the cumulative scroll offset of the first matched element in nested scrolling containers. It adds the cumulative scrollLeft and scrollTop of an element and all its parents.
    It is used for calculating the scroll offset of an element that is in more than one scroll container (e.g., a draggable in a scrolling container which is itself part of a scrolling document).
    Note that all values are returned as numbers only although they are expressed in pixels.
    
    Returns:
    
    Offset the cumulative scroll offset.
    
    See Also:
    
    cmOffset(), viewportOffset(), revisedOffset(_global_.Offset)
  - cmOffset
```
public Offset cmOffset()
```
    Returns the cumulative offset of the first matched element from the top left corner of the document.
    It actually adds the cumulative offsetLeft and offsetTop of an element and all its parents.
    Note that it ignores the scroll offset. If you want the element's coordinate, use revisedOffset() instead.
    Note that all values are returned as numbers only although they are expressed in pixels.
    
    Returns:
    
    Offset the cumulative offset
    
    See Also:
    
    scrollOffset(), viewportOffset(), revisedOffset(_global_.Offset)
  - $
```
public void $()
```
    A short cut for looking up ZK Widget from jQuery object. Now the code
```
 zk.Widget.$(jq("@listbox"))
```
    could be replaced with
```
 zk("@listbox").$() 
```
  - absolutize
```
public jqzk absolutize()
```
    Makes the position of the first selected element as absolute. In addition to changing the style's position to absolute, it will store the location such that it can be restored later when relativize() is called.
```
zk('abc').absolutize();
```
    Returns:
    
    jqzk this object
    
    See Also:
    
    relativize()
  - relativize
```
public jqzk relativize()
```
    Makes the position of the element as relative. In addition to changing the style's position to relative, it tries to restore the location before calling absolutize().
    
    Returns:
    
    jqzk this object
    
    See Also:
    
    absolutize()
  - offsetWidth
```
public int offsetWidth()
```
    Returns the offset width. It is similar to el.offsetWidth, except it solves some browser's bug or limitation.
    
    Returns:
    
    int the offset width
  - offsetHeight
```
public int offsetHeight()
```
    Returns the offset height. It is similar to el.offsetHeight, except it solves some browser's bug or limitation.
    
    Returns:
    
    int the offset height
  - offsetTop
```
public int offsetTop()
```
    Returns the offset top. It is similar to el.offsetTop, except it solves some browser's bug or limitation.
    
    Returns:
    
    int the offset top
  - offsetLeft
```
public int offsetLeft()
```
    Returns the offset left. It is similar to el.offsetLeft, except it solves some browser's bug or limitation.
    
    Returns:
    
    int the offset left
  - offsetWidthDoubleValue
```
public double offsetWidthDoubleValue()
```
    Returns the offset width. The value will not be rounded.
    
    Returns:
    
    double the offset width
    
    Since:
    
    8.5.1
  - offsetHeightDoubleValue
```
public double offsetHeightDoubleValue()
```
    Returns the offset height. The value will not be rounded.
    
    Returns:
    
    double the offset height
    
    Since:
    
    8.5.1
  - clientWidthDoubleValue
```
public double clientWidthDoubleValue()
```
    Returns the client width. The value will not be rounded.
    
    Returns:
    
    double the client width
    
    Since:
    
    9.5.1
  - clientHeightDoubleValue
```
public double clientHeightDoubleValue()
```
    Returns the client height. The value will not be rounded.
    
    Returns:
    
    double the client height
    
    Since:
    
    9.5.1
  - offsetTopDoubleValue
```
public double offsetTopDoubleValue()
```
    Returns the offset top. The value will not be rounded.
    
    Returns:
    
    double the offset top
    
    Since:
    
    8.5.1
  - offsetLeftDoubleValue
```
public double offsetLeftDoubleValue()
```
    Returns the offset left. The value will not be rounded.
    
    Returns:
    
    double the offset left
    
    Since:
    
    8.5.1
  - clientWidthCeil
```
public int clientWidthCeil()
```
    Returns the actual client width rounded "up" to the closest integer.
    
    Returns:
    
    int the actual client width rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - clientHeightCeil
```
public int clientHeightCeil()
```
    Returns the actual client height rounded "up" to the closest integer.
    
    Returns:
    
    int the actual client height rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - offsetWidthCeil
```
public int offsetWidthCeil()
```
    Returns the actual offset width rounded "up" to the closest integer.
    
    Returns:
    
    int the actual offset width rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - offsetHeightCeil
```
public int offsetHeightCeil()
```
    Returns the actual offset height rounded "up" to the closest integer.
    
    Returns:
    
    int the actual offset height rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - offsetTopCeil
```
public int offsetTopCeil()
```
    Returns the actual offset top rounded "up" to the closest integer.
    
    Returns:
    
    int the actual offset top rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - offsetLeftCeil
```
public int offsetLeftCeil()
```
    Returns the actual offset left rounded "up" to the closest integer.
    
    Returns:
    
    int the actual offset left rounded "up" to the closest integer
    
    Since:
    
    9.6.3
  - viewportOffset
```
public Offset viewportOffset()
```
    Returns the X/Y coordinates of the first matched element relative to the viewport.
    
    Returns:
    
    Offset the coordinates
    
    See Also:
    
    cmOffset(), scrollOffset()
  - textWidth
```
public double textWidth(String text)
```
    Returns the width of the text if it is placed inside the first matched element.
    
    Parameters:
    
    text - the content text. The text of the first matched element if omitted
    
    Returns:
    
    double the width in px of the text
    
    Since:
    
    9.0.1
    
    See Also:
    
    Stack Overflow
  - dimension
```
public Dimension dimension(boolean revised)
```
    Returns the dimension of the specified element.
    If revised not specified (i.e., not to calibrate), the left and top are the offsetLeft and offsetTop of the element.
    
    Parameters:
    
    revised - if revised is true, revisedOffset(_global_.Offset) will be used (i.e., the offset is calibrated).
    
    Returns:
    
    Dimension the dimension
  - redoCSS
```
public jqzk redoCSS(int timeout)
```
    Forces the browser to redo (re-apply) CSS of all matched elements.
    Notice that calling this method might introduce some performance penality.
    
    Parameters:
    
    timeout - number of milliseconds to wait before really re-applying CSS. 100 is assumed if not specified , -1 means re-applying css right now.
    
    Returns:
    
    jqzk this object
  - redoSrc
```
public jqzk redoSrc()
```
    Forces the browser to re-load the resource specified in the src attribute for all matched elements.
    
    Returns:
    
    jqzk this object
  - vparentNode
```
public DOMElement vparentNode(boolean real)
```
    Returns the virtual parent of the first matched element.
    Refer to makeVParent() for more information.
    
    Parameters:
    
    real - whether to return DOM element's parentNode if no virtual parent. In other words, zk(n).vparentNode(true) is the same as zk(n).vparentNode()||n.parentNode.
    
    Returns:
    
    DOMElement
  - makeVParent
```
public jqzk makeVParent()
```
    Creates a virtual parent for the specified element. Creating a virtual parent makes the specified element able to appear above any other element (such as a menu popup). By default, the Z order of an element is decided by its parent and ancestors (if any of them has the relative or absolute position). If you want to resolve this limitation, you can create a virtual parent for it with this method.
    To undo the creation of the virtual parent, use undoVParent().
    Notice that, due to browser's limitation, creating a virtual parent is still not enough to make an element appear on top of all others in all conditions. For example, it cannot in IE6 if there is a SELECT element underneath. To really solve this, you have to create a so-called stackup, which is actually an IFRAME element. By position the iframe right under the element, you can really want it appear on top. Refer to jq.newStackup(_global_.DOMElement, _global_.String, _global_.DOMElement) for more information.
    What Really Happens
    
    This method actually moves the element to the topmost level in the DOM tree (i.e., as the child of document.body), and then the original parent (the parent before calling this method) becomes the virtual parent, which can be retrieved by vparentNode(boolean).
    When to Use
    
    When you implement a widget that appears above others, such as an overlapped window, a menu popup and a dropdown list, you can invoke this method when Widget.bind_(zk.Desktop, zk.Skipper, _global_.Array, boolean) is called. And then, restore it by calling undoVParent() when Widget.unbind_(zk.Skipper, _global_.Array, boolean) is called.
    
    Returns:
    
    jqzk this object
  - undoVParent
```
public jqzk undoVParent()
```
    Undoes the creation of a virtual parent of the first matched element.
    Refer to makeVParent() for more information.
    
    Returns:
    
    jqzk this object
  - hasVParent
```
public boolean hasVParent()
```
    Check if element has virtual parent
    
    Returns:
    
    boolean
    
    Since:
    
    7.0.3
  - focus
```
public boolean focus(int timeout)
```
    Sets the focus to the first matched element. It is the same as jq(n).focus() and n.focus, except
    - it doesn't throw any exception (rather, returns false).
    - it can set the focus later (by use of timeout).
    - it maintains zk.currentFocus.
    In general, it is suggested to use zk(n).focus(), unless n does not belong to any widget.
    Parameters:
    
    timeout - the number of milliseconds to delay before setting the focus. If omitted or negative, the focus is set immediately.
    
    Returns:
    
    boolean whether the focus is allowed to set to the element. Currently, only SELECT, BUTTON, INPUT and IFRAME is allowed.
    
    See Also:
    
    select(int)
  - select
```
public boolean select(int timeout)
```
    Selects the first matched element. It is the same as DOMElement.select, except it won't throws an exception (rather, returns false), and can delay the execution for the specified number of milliseconds.
    
    Parameters:
    
    timeout - the number of milliseconds to delay before setting the focus. If omitted or negative, the focus is set immediately.
    
    Returns:
    
    boolean whether the element supports the select method. In other words, it returns false if the object doesn't have the select method.
    
    See Also:
    
    getSelectionRange(), setSelectionRange(int, int), focus(int)
  - getSelectionRange
```
public Array getSelectionRange()
```
    Returns the selection range of the specified input-type element. The selection range is returned as a two-element array, where the first item is the starting index, and the second item is the ending index (excluding).
    If an exception occurs, [0, 0] is returned.
    
    Returns:
    
    Array a two-element array representing the selection range
    
    See Also:
    
    setSelectionRange(int, int), select(int)
  - setSelectionRange
```
public jqzk setSelectionRange(int start,
                              int end)
```
    Sets the selection range of the specified input-type element.
    
    Parameters:
    
    start - the starting index of the selection range
    
    end - the ending index of the selection rane (excluding). In other words, the text between start and (end-1) is selected.
    
    Returns:
    
    jqzk this object
  - submit
```
public jqzk submit()
```
    Submit the selected form.
    
    Returns:
    
    jqzk this object
    
    Since:
    
    5.0.4
  - disableSelection
```
public jqzk disableSelection()
```
    Disallows the user to select a portion of its content. You usually invoke this method to disable the selection for button-like widgets. By default, all elements can be selected (unless disabled with CSS -- which not all browsers support).
    If you disable the selection in Widget.bind_(zk.Desktop, zk.Skipper, _global_.Array, boolean), you shall enable it back in Widget.unbind_(zk.Skipper, _global_.Array, boolean) since this method will register a DOM-level listener for certain browsers.
    
    Returns:
    
    jqzk this object
  - enableSelection
```
public jqzk enableSelection()
```
    Allows the user to select a portion of its content. You usually invoke this method to undo disableSelection(). By default, all elements can be selected (unless disabled with CSS -- which not all browsers support).
    
    Returns:
    
    jqzk this object
  - setStyles
```
public jqzk setStyles()
```
    Deprecated. As of release 5.0.2, use jq.css(map) instead
    Sets the CSS style with a map of style names and values. For example,
```
jq(el).css({width:'100px', paddingTop: "1px", "border-left": "2px"});
jq(el).css(jq.parseStyle(jq.filterTextStle('width:100px;font-size:10pt')));
```
    To parse a style (e.g., 'width:10px;padding:2px') to a map of style names and values, use jq.parseStyle(_global_.String).
    Returns:
    
    jqzk this object
  - clearStyles
```
public jqzk clearStyles()
```
    Clears the CSS styles (excluding the inherited styles).
    
    Returns:
    
    jqzk this object
    
    Since:
    
    5.0.2
  - detachChildren
```
public Array detachChildren()
```
    Detaches all child elements and return them as an array.
    
    Returns:
    
    Array an array of DOMElement that are detached, or null if no element is selected.
    
    Since:
    
    5.0.10
  - isInput
```
public boolean isInput()
```
    Tests if all elements are input elements (including textarea).
    
    Returns:
    
    boolean
    
    Since:
    
    5.0.8
  - isScrollIntoView
```
public boolean isScrollIntoView()
```
    Checks whether the element is shown in the current viewport.
    
    Returns:
    
    boolean if false, it means the element is not shown.
    
    Since:
    
    6.5.2
  - textSize
```
public Size textSize(String text)
```
    Deprecated. Use textWidth(_global_.String) instead for better performance.
    
    Returns the size of the text if it is placed inside the first matched element.
    
    Parameters:
    
    text - the content text
    
    Returns:
    
    Size the size of the text
  - beforeHideOnUnbind
```
public void beforeHideOnUnbind()
```
    Fixes DOM elements when a widget's unbind_ is called and it will hide the DOM element (display="none" or visibility="hidden").
    For firefox, it has to reset the src attribute of iframe (Bug 3076384)
  - getAnimationSpeed
```
public java.lang.Object getAnimationSpeed(java.lang.Object defaultValue)
```
    Get the value of animation speed assigned through client attribute "data-animationspeed"
    
    Parameters:
    
    defaultValue - [optional] default value if widget doesn't have this attribute.
    Allowed values:
    
    Integer
    
    It can be any integer value
    
    String
    
    This value can be "slow" or "fast", which is the same as jQuery Animation
    
    Returns:
    
    Object this value will be Integer or String.
    
    Since:
    
    7.0.3
  - slideDown
```
public jqzk slideDown(Widget wgt,
                      Map opts)
```
    Slides down (show) of the matched DOM element(s).
    
    Parameters:
    
    wgt - the widget that owns the DOM element
    
    opts - the options. Ignored if not specified.
    
    Returns:
    
    jqzk Allowed options:
    
    anchor
    
    The anchor position which can be t, b, l, and r. Default: t.
    
    easing
    
    The name of the easing effect that you want to use (plugin required). There are two built-in values, "linear" and "swing".
    
    duration
    
    The duration of animation (unit: milliseconds). Default: 400
    
    afterAnima
    
    The function to invoke after the animation.
  - slideUp
```
public jqzk slideUp(Widget wgt,
                    Map opts)
```
    Slides up (hide) of the matched DOM element(s).
    
    Parameters:
    
    wgt - the widget that owns the DOM element
    
    opts - the options. Ignored if not specified.
    
    Returns:
    
    jqzk Allowed options:
    
    anchor
    
    The anchor position which can be t, b, l, and r. Default: t.
    
    easing
    
    The name of the easing effect that you want to use (plugin required). There are two built-in values, "linear" and "swing".
    
    duration
    
    The duration of animation (unit: milliseconds). Default: 400
    
    afterAnima
    
    The function to invoke after the animation.
  - slideOut
```
public jqzk slideOut(Widget wgt,
                     Map opts)
```
    Slides out (hide) of the matched DOM element(s).
    
    Parameters:
    
    wgt - the widget that owns the DOM element
    
    opts - the options. Ignored if not specified.
    
    Returns:
    
    jqzk Allowed options:
    
    anchor
    
    The anchor position which can be t, b, l, and r. Default: t.
    
    easing
    
    The name of the easing effect that you want to use (plugin required). There are two built-in values, "linear" and "swing".
    
    duration
    
    The duration of animation (unit: milliseconds). Default: 400
    
    afterAnima
    
    The function to invoke after the animation.
  - slideIn
```
public jqzk slideIn(Widget wgt,
                    Map opts)
```
    Slides in (show) of the matched DOM element(s).
    
    Parameters:
    
    wgt - the widget that owns the DOM element
    
    opts - the options. Ignored if not specified.
    
    Returns:
    
    jqzk Allowed options:
    
    anchor
    
    The anchor position which can be t, b, l, and r. Default: t.
    
    easing
    
    The name of the easing effect that you want to use (plugin required). There are two built-in values, "linear" and "swing".
    
    duration
    
    The duration of animation (unit: milliseconds). Default: 400
    
    afterAnima
    
    The function to invoke after the animation.
  - defaultAnimaOpts
```
public jqzk defaultAnimaOpts(Widget wgt,
                             Map opts,
                             Array prop,
                             boolean visible)
```
    Initializes the animation with the default effect, such as firing the onSize watch.
    Example:
    zk(n).defaultAnimaOpts(wgt, opts, prop, true).jq.css(css).show().animate(...);
    
    Parameters:
    
    wgt - the widget
    
    opts - the options. Ignored if not specified. It depends on the effect being taken
    
    prop - an array of properties, such ['top', 'left', 'position'].
    
    visible - whether the result of the animation will make the DOM element visible
    
    Returns:
    
    jqzk
    
    Since:
    
    5.0.6

Class jqzk

Other Extension

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jq

Method Detail

cleanVisibility

isVisible

isVisible

isRealVisible

scrollTo

scrollIntoView

isRealScrollIntoView

hasVScroll

hasHScroll

isOverlapped

sumStyles

revisedOffset

revisedOffset

revisedWidth

revisedHeight

contentWidth

contentHeight

marginWidth

marginHeight

borderWidth

borderHeight

paddingWidth

paddingHeight

padBorderWidth

padBorderHeight

vflexHeight

cellIndex

ncols

toStyleOffset

center

position

position

scrollOffset

cmOffset

$

absolutize

relativize

offsetWidth

offsetHeight

offsetTop

offsetLeft

offsetWidthDoubleValue

offsetHeightDoubleValue

clientWidthDoubleValue

clientHeightDoubleValue

offsetTopDoubleValue

offsetLeftDoubleValue

clientWidthCeil

clientHeightCeil

offsetWidthCeil

offsetHeightCeil

offsetTopCeil

offsetLeftCeil

viewportOffset

textWidth

dimension

redoCSS

redoSrc

vparentNode

makeVParent

What Really Happens

When to Use

undoVParent

hasVParent

focus

select

getSelectionRange

setSelectionRange

submit

disableSelection

enableSelection

setStyles