Element to which window should be appended.

Buttons that should be appended to bottom of the window. See related demo for details on implementation.

Related demo:
Window buttons

Whether user can close window.

This option does not affect behaviour of API method close.

Related options:
closeOnEscape
maximizable
minimizable

Related method:
close

Related events:
beforeClose
close

Related demo:
Unclosable window

Specifies whether the dialog should close when it has focus and the user presses the escape (ESC) key.

Related option:
closable

Related method:
close

{
	confirm       : false,
	modal         : false,
	minimizable   : true,
	no            : null,
	noLocalized   : "confirmCloseNo",
	text          : null,
	textLocalized : "confirmCloseText",
	title         : null,
	titleLocalized: "confirmCloseTitle",
	yes           : null,
	yesLocalized  : "confirmCloseYes"
},

This object hold configuration for confirmClose functionality. See detailed options for more information.

Details:
confirmClose.confirm
confirmClose.modal
confirmClose.minimizable
confirmClose.no
confirmClose.noLocalized
confirmClose.text
confirmClose.textLocalized
confirmClose.title
confirmClose.titleLocalized
confirmClose.yes
confirmClose.yesLocalized

Confirm close window inherit most of it's options from parent window.

Related method:
confirmCloseWindow

Related demo:
Confirm close functionality

Specifies whether the confirmClose functionality should be on.

When it's on, a window will appear when user want to close window, asking if he's sure.

From API point of view, when confirmClose is on, calling $( ".window" ).window( "close" ) will trigger confirm close window. Calling $( ".window" ).window( "close" ) again will close window for good. Calling $( ".window" ).window( "destroy" ) will bypass confirmClose functionality.

Related demo:
Confirm close functionality

Specifies whether the confirm close window should be modal.

Related demo:
Confirm close functionality

Specifies whether the confirm close window should be minimizable.

Related demo:
Confirm close functionality

Button label for "no" button.

If both confirmClose.no and confirmClose.noLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Dictionary key for label for "no" button.

If both confirmClose.no and confirmClose.noLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Confirm close window body, typically containing question about whether user is positive about closing a window.

If both confirmClose.text and confirmClose.textLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Dictionary key for confirm close window body, typically containing question about whether user is positive about closing a window.

If both confirmClose.text and confirmClose.textLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Confirm close window title.

If both confirmClose.title and confirmClose.titleLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Dictionary key for confirm close window title.

If both confirmClose.title and confirmClose.titleLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Button label for "yes" button.

If both confirmClose.yes and confirmClose.yesLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Dictionary key for label for "yes" button.

If both confirmClose.yes and confirmClose.yesLocalized are not equal to null, the first one will be used.

Related demo:
Confirm close functionality

Defines containment for window. Three values are possible:

• "inherit" means that value of this option will be inherited from windowsContainment option value of a taskbar this window is bound to.
• "viewport" means that existing taskbars (with autoHide set to false) will define boundaries in which window will exist.
• "visible" means that existing taskbars (with autoHide set to false) will define boundaries in which window draggable handle will be accessible, giving ability to move it almost out of sight, but not to a point where is becomes unusable.

If set to true, the window will be draggable by the titlebar. Requires the jQuery UI Draggable widget to be included, otherwise draggable functionality will be skipped, but window will be initialized.

Related events:
dragStart
drag
dragStop

{
	maximize: "default",
	minimize: "default",
	restore : "default",
	show    : "default"
},

This is a object holding various animation durations. Every key in this object is responsible for duration of one particular animation. See detailed options for more information.

Note: Changing duration when animation is in progress will not change duration of this animation. This is the intended behaviour. If you need to end animation immediately, use maximize, minimize, restore, or show methods with a parameter false.

Details:
durations.maximize
durations.minimize
durations.restore
durations.show

Related demo:
Window flow

How much should window maximize take. This applies to user interactions and calling method maximize without parameters.

Related methods:
maximize
maximized
maximizing

Related demo:
Window durations

How much should window minimize take. This applies to user interactions and calling method minimize without parameters.

Related methods:
minimize
minimized
minimizing

Related demo:
Window durations

How much should window restore take. This applies to user interactions and calling method restore without parameters.

Related methods:
restore
restored
restoring

Related demo:
Window durations

How much should window show take. This applies to user interactions and calling method show without parameters.

Related methods:
show
shown
showing

Related demo:
Window durations

When window contains embedded content, like iframe, Flash game, or QuickTime video, set this option to true. This will put an overlay over window when it's not on top, allowing to bring it back to top when it's clicked. Normally, click event would not be propagated from embedded content to DOM.

Styling guide has a section on this option.

Related demo:
Window "embeddedContent" option

This option allow grouping windows. Windows that share the same group option will also share a common window button on taskbar, and the button will open a menu whenever there's more than one window present in the given group.

Group name could be any string, but it's recommended that it contain only characters that can be safely used in CSS selectors (in short: use letter, numbers, hypens, and underscores, and you'll be fine).

When built-in translations are used, group name can be hidden from user, but if no translations are used, group name will be exposed in button label. Related demo contains the details on implementation.

Related demo:
Window groups

Window height. It can either be calculated automatically (best for most cases) or set explicitly.

This option value is used to set CSS height, not outerHeight.

Related options:
maxHeight
minHeight

{
	close       : "ui-icon-closethick",
	confirmClose: "ui-icon-help",
	main        : null,
	maximize    : "ui-icon-arrow-4-diag",
	minimize    : "ui-icon-minusthick",
	restore     : "ui-icon-newwin"
}

Details:
icons.close
icons.confirmClose
icons.main
icons.maximize
icons.minimize
icons.restore

Related demos:
Icons
famfamfam iconset

Icon for close button.

This option will have no visible effect if closable option is set to false.

Option that's gonna be propagated to confirmClose window icons.main option.

This option will have no visible effect confirmClose functionality is not on.

Main window icon. This icon will be visible in window titlebar and on window button or in window group menu.

Icon for maximize button for when window is not maximized.

This option will have no visible effect if maximizable option is set to false.

Icon for minimize button.

This option will have no visible effect if minimizable option is set to false.

Icon for maximize button for when window is maximized.

This option will have no visible effect if maximizable option is set to false.

Max window height. Applied to both auto-sizing capabilities (when height is set to "auto") and resizable.

This option value is used to set CSS height, not outerHeight.

Related options:
height
minHeight

Whether the window can be maximized by user.

This option does not affect behaviour of API method maximize.

Related options:
closable
minimizable
maximizedDraggable

Related methods:
maximize
maximized
maximizing

Related demo:
Unclosable window

Whether the window can be dragged when it's maximized, therefore becoming restored when drag starts.

Related option:
maximizable

Related demo:
Window "maximizedDraggable" option

Max window width. Applied to resizable.

This option value is used to set CSS width, not outerWidth.

Related options:
minWidth
width

Minimal window height. Applied to both auto-sizing capabilities (when height is set to "auto") and resizable.

This option value is used to set CSS height, not outerHeight.

Related options:
height
maxHeight

Whether the window can be minimized by user.

This option does not affect behaviour of API method minimize.

Related options:
closable
maximizable

Related methods:
minimize
minimized
minimizing

Related demo:
Unclosable window

Minimal window width. Applied to resizable.

This option value is used to set CSS width, not outerWidth.

Related options:
maxWidth
width

Whether the window is modal. Modal creates an overlay over all elements, optionally filtered by modalOverlay option and modalOverlaySetsCreated event.

Related option:
modalOverlay

Related event:
modalOverlaySetsCreated

Related method:
modalOverlay

Related demo:
Modal windows

Specifies what elements should be covered by overlay, when modal window is on top. Three values are possible:

• "all" means that all taskbars and windows will be covered.
• "viewport" means that all windows will be covered, but not taskbars.
• jQuery object acts as "all", except elements passed in jQuery Object will not be covered by modal overlay.

Related option:
modal

Related event:
modalOverlaySetsCreated

Related method:
modalOverlay

Related demo:
Modal windows

{
	my       : "center",
	at       : "center",
	of       : window,
	collision: "fit",
}

Specifies where the dialog should be displayed when opened. The dialog will handle collisions such that as much of the dialog is visible as possible.

The of property defaults to the window, but you can specify another element to position against. You can refer to the jQuery UI Position utility for more details about the available properties.

Window position will be corrected if needed to fit into whatever containment has been specified.

If set to true, the window will be resizable. Requires the jQuery UI Resizable widget to be included, otherwise resizable functionality will be skipped, but window will be initialized.

Related events:
resizeStart
resize
resizeStop

Taskbar the window should be bound to.

When invalid option value is passed—selector not matching taskbar instance, or jQuery object not containing taskbar instance—there are two scenarios:

• On window initialization, window will not be created from an element and taskbarNotFound event will be triggered.
• After window initialization, when setter is used ($( ".window" ).window( "option", "taskbar", $() );), window will not be bound to new taskbar.

Related event:
taskbarNotFound

Related method
taskbar

Title of the window. Title will be visible in window titlebar and on window button or in window group menu.

If both title and titleLocalized are not equal to null, the first one will be used.

Related option:
titleLocalized

Related method:
title

Dictionary key for title of the window. Title will be visible in window titlebar and on window button or in window group menu.

If both title and titleLocalized are not equal to null, the first one will be used.

Related option:
titleLocalized

Related method:
title

Class that gonna be added to window widget (a parent of element that window() method was called on).

Related method:
widget

Window width. It can only be set explicitly.

This option value is used to set CSS width, not outerWidth.

Related options:
maxWidth
minWidth

{
	// widget instance; it's the same
	// object jQuery widget instance()
	// method returns since jQuery 1.11
	instance: { ... },
	// instance of taskbar this window is
	// bound to; it's the same
	// object jQuery widget instance()
	// method returns since jQuery 1.11
	taskbar : { ... },
	// jQuery object containing element
	// the window() method was called on
	$window : $window,
	// jQuery object containing window
	// widget (parent of the element
	// the window() method was called on)
	$widget : $widget,
	// jQuery object containing taskbar
	$taskbar: $taskbar
}

In addition to event-specific properties, every UI object contains additional properties, as shown on the left.

instance is a jQuery UI window widget instance. It's the same object that jQuery UI instance() method return since jQuery UI 1.11.

taskbar is a jQuery UI widget instance of taskbar the window is bound to. It's the same object that jQuery UI instance() method return since jQuery UI 1.11.

$window is a jQuery object fo DOM element on which window() was called.

$window is a jQuery object fo DOM element that serves as window widget (in short, parent of element on which window() was called).

$taskbar is a jQuery object fo DOM element of taskbar the window is bound to.

{}

Triggered when window is about to be closed.

This event will not be triggered when destroy method was called.

Related option:
closable

Related event:
close

Related method:
close

{}

Triggered after window is destroyed and closed.

Related option:
closable

Related event:
beforeClose

Related method:
close

{}

This event if triggered when window widget is successfully created.

This event if triggered only once.

If this event fails to fire, taskbarNotFound likely fired.

This event will not be triggered if widget creation failed. If that happens, set taskbar's debug.environment to true and check the output of debugLogAdd event.

{
	// window current offset
	offset: {
		left  : 0,
		top   : 400,
	},
	// window original offset
	originalOffset: {
		left  : 0,
		top   : 300,
	},
	// window original position
	originalPosition: {
		left  : 0,
		top   : 400,
	},
	// window current position
	position: {
		left  : 0,
		top   : 400,
	}
}

Triggered when window draggable starts.

This event caries properties from ui object of jQuery UI Draggable start event.

Original draggable start event object is passed.

Related demo:
Window interactions

{
	// window current offset
	offset: {
		left  : 38,
		top   : 456,
	},
	// window original offset
	originalOffset: {
		left  : 0,
		top   : 300,
	},
	// window original position
	originalPosition: {
		left  : 0,
		top   : 300,
	},
	// window current position
	position: {
		left  : 38,
		top   : 456,
	}
}

Triggered when window draggable in in progress.

This event caries properties from ui object of jQuery UI Draggable drag event.

Original draggable drag event object is passed.

Related demo:
Window interactions

{
	// window current offset
	offset: {
		left  : 862,
		top   : 304,
	},
	// window original offset
	originalOffset: {
		left  : 0,
		top   : 300,
	},
	// window original position
	originalPosition: {
		left  : 1240,
		top   : 29,
	},
	// window current position
	position: {
		left  : 862,
		top   : 204,
	}
}

Triggered when window draggable stops.

This event caries properties from ui object of jQuery UI Draggable stop event.

Original draggable stop event object is passed.

Related demo:
Window interactions

{}

Triggered when window is focused.

{}

Triggered when window is about to be maximized.

Canceling this event will prevent window from maximizing.

Related event:
maximize

Related methods:
maximize
maximized
maximizing

{}

Triggered when window has been fully maximized.

Related event:
beforeMaximize

Related methods:
maximize
maximized
maximizing

{
	// whether taskbar's "minimizeAll"
	// method was called and is in progress
	minimizeAllInProgress: true
}

Triggered when window is about to be minimized.

Canceling this event will prevent window from minimizing.

Related event:
minimize

Related methods:
minimize
minimized
minimizing

{
	// whether taskbar's "minimizeAll"
	// method was called and is in progress
	minimizeAllInProgress: true
}

Triggered when window has been fully minimized.

Related event:
beforeMinimize

Related methods:
minimize
minimized
minimizing

{
	// jQuery object containing
	// elements that gonna be covered
	// by modal overlay
	$setCover: $setCover,
	// jQuery object containing
	// elements that's will be explicitly
	// excluded from being covered
	// by modal overlay
	$setNoCover: $setNoCover
}

Triggered when modal overlay sets are created, based on modal and modalOverlay options. Both sets can be modified in this event. See related demo for details on how to do this.

Related options:
modal
modalOverlay

Related method:
modalOverlay

Related demo:
Modal windows

{}

Triggered when window was on top and is moved to background, therefore becoming a not active window.

Related methods:
moveToTop
blurWindows – taskbar method

{}

Triggered when window was not on top and is moved to top, therefore becoming active window.

Related methods:
moveToTop
blurWindows – taskbar method

{
	// original position
	// before resize started
	originalPosition: {
		left: 950,
		top: 82
	},
	// original size before
	// resize started
	originalSize: {
		left: 338,
		width: 299
	},
	// current position
	position: {
		left: 950,
		top: 82
	},
	// current size
	size: {
		left: 338,
		width: 299
	}
}

Triggered when window resize starts.

This event caries properties from ui object of jQuery UI Resizable start event.

Original resizable start event object is passed.

Related demo:
Window interactions

{
	// original position
	// before resize started
	originalPosition: {
		left: 950,
		top: 82
	},
	// original size before
	// resize started
	originalSize: {
		left: 338,
		width: 299
	},
	// current position
	position: {
		left: 943,
		top: 77
	},
	// current size
	size: {
		left: 343,
		width: 306
	}
}

Triggered during window resize.

This event caries properties from ui object of jQuery UI Resizable resize event.

Original resizable resize event object is passed.

Related demo:
Window interactions

{
	// original position
	// before resize started
	originalPosition: {
		left: 950,
		top: 82
	},
	// original size before
	// resize started
	originalSize: {
		left: 338,
		width: 299
	},
	// current position
	position: {
		left: 943,
		top: 77
	},
	// current size
	size: {
		left: 343,
		width: 306
	}
}

Triggered when window resize stops.

This event caries properties from ui object of jQuery UI Resizable stop event.

Original resizable stop event object is passed.

Related demo:
Window interactions

{}

Triggered when window is about to be restored.

Canceling this event will prevent window from restoring.

Related event:
restore

Related methods:
restore
restored
restoring

{}

Triggered when window has been fully restored.

Related event:
beforeRestore

Related methods:
restore
restored
restoring

{}

Triggered when window is about to be shown.

showing Canceling this event will prevent window from showing.

Related event:
show

Related methods:
show
shown
showing

{}

Triggered when window has been fully shown.

Related event:
beforeShow

Related methods:
show
shown
showing

{
	// whether it's the initialization
	// or taskbar was about to be
	// changed via setter
	initial: true,
	// error message
	message: "...",
	// original value of taskbar option
	// before resize started
	taskbar: taskbar,
	// jQuery object internally created
	// from taskbar option
	$taskbar: $taskbar,
}

Triggered when taskbar passed in taskbar option was not found, either on initialization or after initialization.

Related option:
taskbar

Related method
taskbar

Returns button connected to a window, or empty jQuery object if window is not bound to taskbar.

Closes the window. If confirmClose.confirm is set to true and confirm close window is not present, first call on close() method will open confirm close window. Second call will close confirm close window and the window it was called upon.

Related option:
closable

Related events:
beforeClose
close

Related method:
destroy

Returns confirm close window if confirm close window is currently opened, or empty jQuery object otherwise.

Related option:
confirmClose

Returns real window containment, either "visible" or "viewport".

That is different from getter for containment option, that could also return "inherit", if containment is inherited from taskbar's windowsContainment option.

Related option:
containment

Removes the window functionality completely. This will return the element back to its pre-init state.

Related method:
close

Available since jQuery UI 1.11.

Retrieves the window's instance object. If the element does not have an associated instance, undefined is returned.

Maximizes window. If window is already maximized, nothing will happen.

Related events:
beforeMaximize
maximize

Related methods:
maximized
maximizing

Related demo:
Window flow

Returns true if window is fully maximized, false otherwise.

Related events:
beforeMaximize
maximize

Related methods:
maximize
maximizing

Returns true if window is currently maximizing, that is, the animation is in progress, and false otherwise.

Related events:
beforeMaximize
maximize

Related methods:
maximize
maximized

Minimizes window. If window is already minimized, nothing will happen.

Related events:
beforeMinimize
minimize

Related methods:
minimized
minimizing

Related demo:
Window flow

Returns true if window is fully minimized, false otherwise.

Related events:
beforeMinimize
minimize

Related methods:
minimize
minimizing

Returns true if window is currently minimizing, that is, the animation is in progress, and false otherwise.

Related events:
beforeMinimize
minimize

Related methods:
minimize
minimized

Returns jQuery element representing modal overlay, or empty jQuery object if modal overlay is not present.

Related options:
confirmClose
modal
modalOverlay

Related event:
modalOverlaySetsCreated

Move window to top, making it an active window. If modal window is present and current window is not modal, window will not be moved to top.

This method only moves window to top if this window is not minimized or minimizing. You might want to check for that before using this method.

Related events:
moveToTop
moveToBackground

Related method:
blurWindows – taskbar method

Serves as getter or a setter for options.

When only option name is passed, this method act as getter.

 // initialize window with default settings
$( ".window" ).window();

// modal will be false, because that's the default option value
var modal = $( ".window" ).window( "option", "modal" );

When option name and option value is passed, a new option value is set.

 // initialize window with default settings
$( ".window" ).window();

// modal will from now on be true
$( ".window" ).window( "option", "modal", true );

Alternatively, an object can be passed as option name, acting as a setter:

$( ".window" ).window( "option", {
	containment: "visible",
	closable: false
});

This will set both containment and closable options.

Refreshes position and dimension of window.

Internally, this method is called whenever it's needed to reposition window, or change it's dimension.

On occasions this method should be called from your application, for example, when you have a window with height set to auto and window has some new content, or old content is removed, and you want height to be recalculated.

Restores window. If window is already restored, nothing will happen.

Related events:
beforeRestore
restore

Related methods:
restored
restoring

Returns true if window is fully restored, false otherwise.

Related events:
beforeRestore
restore

Related methods:
restored
restoring

Returns true if window is currently restoring, that is, the animation is in progress, and false otherwise.

Related events:
beforeRestore
restore

Related methods:
restored
restoring

Shows window. If window is already shown, nothing will happen.

Related events:
beforeShow
show

Related methods:
shown
showing

Returns true if window is fully shown, false otherwise.

Related events:
beforeShow
show

Related methods:
shown
showing

Returns true if window is currently showing, that is, the animation is in progress, and false otherwise.

Related events:
beforeShow
show

Related methods:
shown
showing

Returns taskbar the window is bound to, or empty jQuery object if window is not bound to taskbar.

Related option:
taskbar

Returns real window title, that is the title currently shown on titlebar.

Related options:
title
titleLocalized

Returns parent of element on which taskbar() method was called. That's the jQuery object containing original element, titlebar, and, optionally, container for custom buttons.

Related option:
widgetClass

Changes the default window setup, and optionally propagate changes to existing window instances. See related demo for details on usage.

Related demo:
$.simone.taskbarSetup and $.simone.windowSetup methods