Table of Contents
dhtmlXWindows Object
Init/Unload
- dhtmlXWindows constructor
- unload unloads an object and clears memory
Common
- getId returns window's id
- findByText returns array of window handlers found by header text
- forEachWindow iterator - goes through all windows and calls a user handler
- setSkin changes window's skin
Effects
Events
- attachEvent attaches an event handler
- detachEvent removes an event handler
- checkEvent returns true if the event exists
Window Object
Init
- createWindow creates a new window and returns its handler
- window returns the window handler (dhtmlXWindowSngl object) found by id
- isWindow returns true if the window with specified id exists
- close closes a window
Move
Position
- setPosition sets window's position (moves a window to the point set by user)
- getPosition returns current window's position
Dimension
- setDimension sets window's dimension
- getDimension returns the current window's dimension
- setMaxDimension sets max window's dimension
- getMaxDimension returns the current max window's dimension
- setMinDimension sets min window's dimension
- getMinDimension returns the current min window's dimension
Min/Max
- maximize maximizes a window
- minimize minimizes a window
- isMaximized returns true if the window is maximized
- setToFullScreen sets a window to the fullscreen mode
Resize
- allowResize allows a window to be resized
- denyResize denies a window from resizing
- isResizable returns true if the window is resizable
Park
- park parks a window (next action is based on window's current state)
- isParked returns true if the window is parked
- allowPark allows a window to be parked
- denyPark denies a window from parking
- isParkable returns true if the window is parkable
Visibility
Z-Index
- bringToTop brings/sends a window on the top (z-positioning)
- bringToBottom brings/sends a window to the bottom (z-positioning)
- isOnTop returns true if the window is on the top
- isOnBottom returns true if the window is on the bottom
- getTopmostWindow returns the topmost window
- getBottommostWindow returns the bottommost window
Sticking
Modality
Header/Text
- showHeader shows window's header
- hideHeader hides window's header
- setText sets window's header text
- getText returns window's header text
Centring
- center centers a window in the viewport
- centerOnScreen centers a window on the screen
Icon
- setImagePath sets path to the directory where used images are located
- setIcon sets window's header icon
- getIcon returns the current window's header icon
- clearIcon clears window's header icon
- restoreIcon restores default window's header icon (based on skin)
Progress
- progressOn shows a progress indicator
- progressOff hides a progress indicator
Button Object
Add/Remove
- addUserButton adds a user button
- removeUserButton removes a user button
- button returns the button handler (dhtmlXWindowsBtn object) found by id
State
Visibility
Viewport
- attachViewportTo attaches a viewport to an existing object on page (renders an object as a viewport)
- enableAutoViewport if true - allows an object to adjust the viewport automatically to document.body
- setViewport sets user-defined viewport if enableAutoViewport(false)
- keepInViewport keeps a window within the viewport