A controller that manages a window, usually a window stored in a nib file.
- macOS 10.0+
Managing a window entails:
Loading and displaying the window
Closing the window when appropriate
Customizing the window’s title
Storing the window’s frame (size and location) in the defaults database
Cascading the window in relation to other document windows of the app
A window controller can manage a window by itself or as a role player in AppKit’s document-based architecture, which also includes
NSDocument objects. In this architecture, a window controller is created and managed by a “document” (an instance of an
NSDocument subclass) and, in turn, keeps a reference to the document.
The relationship between a window controller and a nib file is important. Although a window controller can manage a programmatically created window, it usually manages a window in a nib file. The nib file can contain other top-level objects, including other windows, but the window controller’s responsibility is this primary window. The window controller is usually the owner of the nib file, even when it is part of a document-based app. Regardless of who is the file’s owner, the window controller is responsible for freeing all top-level objects in the nib file it loads.
For simple documents—that is, documents with only one nib file containing a window—you need do little directly with
NSWindow AppKit creates one for you. However, if the default window controller is not sufficient, you can create a custom subclass of
NSWindow. For documents with multiple windows or panels, your document must create separate instances of
NSWindow (or of custom subclasses of
NSWindow), one for each window or panel. An example is a CAD app that has different windows for side, top, and front views of drawn objects. What you do in your
NSDocument subclass determines whether the default
NSWindow or separately created and configured
NSWindow objects are used.
You should create a subclass of
NSWindow when you want to augment the default behavior, such as to give the window a custom title or to perform some setup tasks before the window is loaded. In your class’s initialization method, be sure to invoke on
super either one of the
init initializers or the
init(window:) initializer. The initializer you choose depends on whether the window object originates in a nib file or is programmatically created.
You can also implement an
NSWindow subclass to avoid requiring client code to get the corresponding nib's filename and pass it to
init(window when instantiating the window controller. The best way to do this is to override
window to return the nib's filename and instantiate the window controller by passing
init(window:). Using the
init(window:) designated initializer simplifies compliance with Swift initializer requirements.
Typically, you override one of the methods listed in Table 1.
You can also override
load to get different nib-searching or nib-loading behavior, although there is usually no need to do this.