expandcollaps

dhtmlXWindowsSngl object API

addUserButton(id, pos, title, label)
adds user button

File required:dhtmlxwindows.js
  • id - button id
  • pos - button position
  • title - button tooltip
  • label - button name (according to css)
    • allowMove()
    allows window to be moved

    File required:dhtmlxwindows.js
    allowPark()
    allows window to be parked

    File required:dhtmlxwindows.js
    allowResize()
    allows window to be resized

    File required:dhtmlxwindows.js
    attachObject(objId, changeDisp)
    attaches object into window

    File required:dhtmlxwindows.js
  • objId - object id
  • changeDisp - removes style="display: none;" after adding
    • attachStatusBar(obj, show)
    attach status bar to a window

    File required:dhtmlxwindows.js
    attachURL(url)
    attaches url into window

    File required:dhtmlxwindows.js
  • url
    • attachWebMenu()
    attach dhtmlxWebMenu to a window

    File required:dhtmlxwindows.js
    attachWebToolbar()
    attach dhtmlxWebTollbar to a window

    File required:dhtmlxwindows.js
    bringToBottom()
    brings/sends window to bottom (z-positioning)

    File required:dhtmlxwindows.js
    bringToTop()
    brings/sends window on top (z-positioning)

    File required:dhtmlxwindows.js
    center()
    centring window in viewport

    File required:dhtmlxwindows.js
    clearIcon()
    clears window's header icon

    File required:dhtmlxwindows.js
    close()
    closes window

    File required:dhtmlxwindows.js
    denyMove()
    denies window from moving

    File required:dhtmlxwindows.js
    denyPark()
    denies window from parking

    File required:dhtmlxwindows.js
    denyResize()
    denies window from resizing

    File required:dhtmlxwindows.js
    getDimension()
    returns current window dimension

    File required:dhtmlxwindows.js
    getIcon()
    returns current window's header icon

    File required:dhtmlxwindows.js
  • text
    • getId()
    returns window id

    File required:dhtmlxwindows.js
    getMaxDimension()
    returns current max window dimension

    File required:dhtmlxwindows.js
    getMinDimension()
    returns current min window dimension

    File required:dhtmlxwindows.js
    getPosition()
    returns current window position

    File required:dhtmlxwindows.js
    getText()
    returns window's header text

    File required:dhtmlxwindows.js
    hide()
    hides window

    File required:dhtmlxwindows.js
    isHidden()
    returns true if window is hidden

    File required:dhtmlxwindows.js
    isMaximized()
    returns true if window is maximized

    File required:dhtmlxwindows.js
    isModal()
    returns true if window is modal

    File required:dhtmlxwindows.js
    isMovable()
    returns true if window is movable

    File required:dhtmlxwindows.js
    isOnBottom()
    returns true if window is on bottom

    File required:dhtmlxwindows.js
    isOnTop()
    returns true if window is on top

    File required:dhtmlxwindows.js
    isParkable()
    returns true if window is parkable

    File required:dhtmlxwindows.js
    isParked()
    returns true if window is parked

    File required:dhtmlxwindows.js
    isResizable()
    returns true if window is resizable

    File required:dhtmlxwindows.js
    isSticked()
    returns true if window is sticked

    File required:dhtmlxwindows.js
    keepInViewport(state)
    keeps window within viewport

    File required:dhtmlxwindows.js
  • state - if true - window is not allowed to be placed outside viewport,
    • maximize()
    maximizes window

    File required:dhtmlxwindows.js
    minimize()
    minimizes window

    File required:dhtmlxwindows.js
    park()
    parks window (next action is based on window's current state)

    File required:dhtmlxwindows.js
    progressOff()
    hide progress indicator

    File required:dhtmlxwindows.js
    progressOn()
    show progress indicator

    File required:dhtmlxwindows.js
    removeUserButton(id)
    removes user button

    File required:dhtmlxwindows.js
  • id - button id
    • restoreIcon()
    restores default window's header icon (based on skin)

    File required:dhtmlxwindows.js
    setDimension(width, height)
    sets window dimension

    File required:dhtmlxwindows.js
  • width
  • height
    • setIcon(iconEnabled, iconDisabled)
    sets window's header icon

    File required:dhtmlxwindows.js
  • iconEnabled - url to enabled icon
  • iconDisabled - url to disabled icon
    • setMaxDimension(maxWidth, maxHeight)
    sets max window dimension

    File required:dhtmlxwindows.js
  • maxWidth
  • maxHeight
    • setMinDimension(minWidth, minHeight)
    sets min window dimension

    File required:dhtmlxwindows.js
  • minWidth
  • minHeight
    • setModal(state)
    makes window modal/modeless

    File required:dhtmlxwindows.js
  • state - true|false
    • setPosition(x, y)
    sets window position (moves window to the point set by user)

    File required:dhtmlxwindows.js
  • x - x coordinate
  • y - y coordinate
    • setText(text)
    sets window's header text

    File required:dhtmlxwindows.js
  • text
    • show()
    shows window

    File required:dhtmlxwindows.js
    stick()
    sticks window

    File required:dhtmlxwindows.js
    unstick()
    unsticks window

    File required:dhtmlxwindows.js

    dhtmlXWindowsBtn object API

    disable()
    disable button

    File required:dhtmlxwindows.js
    enable()
    enable button

    File required:dhtmlxwindows.js
    hide()
    hide button

    File required:dhtmlxwindows.js
    isEnabled()
    check if button is enabled

    File required:dhtmlxwindows.js
    Returns:true if enabled, otherwise - false
    isHidden()
    check if button is hidden

    File required:dhtmlxwindows.js
    Returns:true if hidden, otherwise - false
    show()
    show button

    File required:dhtmlxwindows.js

    dhtmlXWindows object API

    createWindow(id, x, y, width, height)
    creates new window and returns its handler

    File required:dhtmlxwindows.js
  • id - window id
  • x - top-left window corner's X-coordinate
  • y - top-left window corner's Y-coordinate
  • width - window's width
  • height - window's height
    • enableAutoViewport(state)
    if true - allows object to adjust viewport automatically to document.body

    File required:dhtmlxwindows.js
  • state - true|false
    • findByText(text)
    returns array of window handlers found by header text

    File required:dhtmlxwindows.js
  • id
    • forEachWindow(handler)
    iterator - goes through all windows and calls user handler

    File required:dhtmlxwindows.js
  • hander (user function)
    • getBottommostWindow()
    returns bottommost window

    File required:dhtmlxwindows.js
    getTopmostWindow(visibleOnly)
    returns topmost window

    File required:dhtmlxwindows.js
    isWindow(id)
    returns true if window with specified id exists

    File required:dhtmlxwindows.js
  • id
    • setImagePath(path)
    sets path to the directory where used images are located

    File required:dhtmlxwindows.js
  • path - url to where images are located
    • setSkin(skin)
    changes window skin

    File required:dhtmlxwindows.js
  • skin - skin name
    • setViewport(x, y, width, height, parentObj)
    sets user-defined viewport if enableAutoViewport(false)

    File required:dhtmlxwindows.js
  • x - top-left viewport corner's X-coordinate
  • y - top-left viewport corner's Y-coordinate
  • width - viewport's width
  • height - viewport's height
    • unload()
    unloads object and clears memory

    File required:dhtmlxwindows.js
  • id - button id
    • window(id)
    returns window handler (dhtmlXWindowSngl object) found by id

    File required:dhtmlxwindows.js
  • id