expandcollaps

## dhtmlXWindowsSngl object API

addUserButton(id, pos, title, label)
adds a user button
File required:dhtmlxwindows.js
- id - button's id
- pos - button's position
- title - button's tooltip
- label - button's name (according to css)
allowMove()
allows a window to be moved
File required:dhtmlxwindows.js
allowPark()
allows a window to be parked
File required:dhtmlxwindows.js
allowResize()
allows a window to be resized
File required:dhtmlxwindows.js
appendObject(obj)
appends an object into a window
File required:dhtmlxwindows.js
- obj - object or object id
attachAccordion()
attaches a dhtmlxAccordion to a window
File required:dhtmlxwindows.js
attachEditor(skin)
attaches a dhtmlxEditor to a window
File required:dhtmlxwindows.js
- skin - not mandatory, editor's skin
attachFolders()
attaches a dhtmlxFolders to a window
File required:dhtmlxwindows.js
attachGrid()
attaches a dhtmlxGrid to a window
File required:dhtmlxwindows.js
attachHTMLString(str)
attaches an html string as an object into a window
File required:dhtmlxwindows.js
- str - html string
attachLayout(view, skin)
attaches a dhtmlxLayout to a window
File required:dhtmlxwindows.js
- view - layout's pattern
- skin - layout's skin
attachObject(obj, autoSize)
attaches an object into a window
File required:dhtmlxwindows.js
- obj - object or object id
- autoSize - set true to adjust a window to object's dimension
attachTabbar()
attaches a dhtmlxTabbar to a window
File required:dhtmlxwindows.js
attachTree(rootId)
attaches a dhtmlxTree to a window
File required:dhtmlxwindows.js
- rootId - not mandatory, tree super root, see dhtmlxTree documentation for details
attachURL(url, ajax)
attaches an url into a window
File required:dhtmlxwindows.js
- url
- ajax - loads an url with ajax
bringToBottom()
brings/sends a window to bottom (z-positioning)
File required:dhtmlxwindows.js
bringToTop()
brings/sends a window on top (z-positioning)
File required:dhtmlxwindows.js
center()
centers a window in the viewport
File required:dhtmlxwindows.js
centerOnScreen()
centers a window on the screen
File required:dhtmlxwindows.js
clearIcon()
clears window's header icon
File required:dhtmlxwindows.js
close()
closes a window
File required:dhtmlxwindows.js
denyMove()
denies a window from moving
File required:dhtmlxwindows.js
denyPark()
denies a window from parking
File required:dhtmlxwindows.js
denyResize()
denies a window from resizing
File required:dhtmlxwindows.js
getDimension()
returns current window's dimension
File required:dhtmlxwindows.js
getIcon()
returns current window's header icon
File required:dhtmlxwindows.js
- text
getId()
returns window's id
File required:dhtmlxwindows.js
getMaxDimension()
returns current max window's dimension
File required:dhtmlxwindows.js
getMinDimension()
returns current min window's dimension
File required:dhtmlxwindows.js
getPosition()
returns current window's position
File required:dhtmlxwindows.js
getText()
returns window's header text
File required:dhtmlxwindows.js
hide()
hides a window
File required:dhtmlxwindows.js
hideHeader()
hides window's header
File required:dhtmlxwindows.js
isHidden()
returns true if the window is hidden
File required:dhtmlxwindows.js
isMaximized()
returns true if the window is maximized
File required:dhtmlxwindows.js
isModal()
returns true if the window is modal
File required:dhtmlxwindows.js
isMovable()
returns true if the window is movable
File required:dhtmlxwindows.js
isOnBottom()
returns true if the window is on bottom
File required:dhtmlxwindows.js
isOnTop()
returns true if the window is on top
File required:dhtmlxwindows.js
isParkable()
returns true if the window is parkable
File required:dhtmlxwindows.js
isParked()
returns true if the window is parked
File required:dhtmlxwindows.js
isResizable()
returns true if the window is resizable
File required:dhtmlxwindows.js
isSticked()
returns true if the window is sticked
File required:dhtmlxwindows.js
keepInViewport(state)
keeps a window within the viewport
File required:dhtmlxwindows.js
- state - if true - window is not allowed to be placed outside the viewport
maximize()
maximizes a window
File required:dhtmlxwindows.js
minimize()
minimizes a window
File required:dhtmlxwindows.js
park()
parks a window (next action is based on window's current state)
File required:dhtmlxwindows.js
progressOff()
hides a progress indicator
File required:dhtmlxwindows.js
progressOn()
shows a progress indicator
File required:dhtmlxwindows.js
removeUserButton(id)
removes a user button
File required:dhtmlxwindows.js
- id - button's id
restoreIcon()
restores default window's header icon (based on skin)
File required:dhtmlxwindows.js
setDimension(width, height)
sets window's dimension
File required:dhtmlxwindows.js
- width
- height
setIcon(iconEnabled, iconDisabled)
sets window's header icon
File required:dhtmlxwindows.js
- iconEnabled - url to the icon for the enabled state
- iconDisabled - url to the icon for the disabled state
setMaxDimension(maxWidth, maxHeight)
sets max window's dimension
File required:dhtmlxwindows.js
- maxWidth
- maxHeight
setMinDimension(minWidth, minHeight)
sets min window's dimension
File required:dhtmlxwindows.js
- minWidth
- minHeight
setModal(state)
makes a window modal/modeless
File required:dhtmlxwindows.js
- state - true|false
setPosition(x, y)
sets window's position (moves a 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
setToFullScreen(state)
sets a window to the fullscreen mode
File required:dhtmlxwindows.js
- state - true|false
show()
shows a window
File required:dhtmlxwindows.js
showHeader()
shows window's header
File required:dhtmlxwindows.js
stick()
sticks a window
File required:dhtmlxwindows.js
unstick()
unsticks a window
File required:dhtmlxwindows.js

## dhtmlXWindowsBtn object API

disable()
disables a button
File required:dhtmlxwindows.js
enable()
enables a button
File required:dhtmlxwindows.js
hide()
hides a button
File required:dhtmlxwindows.js
isEnabled()
checks if a button is enabled
File required:dhtmlxwindows.js
Returns:true if enabled, otherwise - false
isHidden()
checks if a button is hidden
File required:dhtmlxwindows.js
Returns:true if hidden, otherwise - false
show()
shows a button
File required:dhtmlxwindows.js

## dhtmlXWindows object API

attachViewportTo(objId)
attaches a vp to an existing object on page (renders an object as a viewport)
File required:dhtmlxwindows.js
- objId - object id
createWindow(id, x, y, width, height)
creates a new window and returns its handler
File required:dhtmlxwindows.js
- id - window's 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 an object to adjust the 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 a user handler
File required:dhtmlxwindows.js
- hander (user function)
getBottommostWindow()
returns the bottommost window
File required:dhtmlxwindows.js
getEffect(efName)
returns true if the effect is enabled
File required:dhtmlxwindows.js
- efName - effect's name
getTopmostWindow(visibleOnly)
returns the topmost window
File required:dhtmlxwindows.js
isWindow(id)
returns true if the window with specified id exists
File required:dhtmlxwindows.js
- id
setEffect(efName, efValue)
sets a visual effect
File required:dhtmlxwindows.js
- efName - effect's name
- efValue - true/false to enable/disable
setImagePath(path)
sets path to the directory where used images are located
File required:dhtmlxwindows.js
- path - url to the directory where images are located
setSkin(skin)
changes window's skin
File required:dhtmlxwindows.js
- skin - skin's 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 an object and clears memory
File required:dhtmlxwindows.js
- id - button's id
window(id)
returns the window handler (dhtmlXWindowSngl object) found by id
File required:dhtmlxwindows.js
- id