Class

NSDockTile

The NSDockTile class lets you customize the visual representation for your application’s miniaturized windows and application icon as they appear in the Dock. You do not create Dock tile objects explicitly in your application. Instead, you retrieve the Dock tile for an existing window or for the application by calling that object’s dockTile method.

Overview

Typically, you do not subclass the NSDockTile class. Instead, you use the methods of the class to make the following customizations:

  • Badge the tile with a custom string.

  • Remove or show the application icon badge.

  • Draw the tile content yourself.

If you decide to draw the tile content yourself, you must provide a custom content view to handle the drawing.

Application Dock Tiles

An application Dock tile defaults to display the application’s applicationIconImage.

The application Dock tile never shows a smaller application icon badge.

Whether using the default or custom view, the application Dock tile may be badged with a short custom string.

Window Dock Tiles

A window Dock tile defaults to display a miniaturized version of the windows contents with a badge derived from the application Dock icon, including any customized application Dock icon. The default window Dock tile image may not be badged with a custom string.

A window Dock tile can use a custom view to draw the Dock icon. If a custom view is used, no application badge will be added, but the text label will be overlaid on top of the icon.

Symbols

Drawing the Tile’s Content

var contentView: NSView?

The view to use for drawing the dock tile contents.

Getting the Tile Information

var size: NSSize

The size of the tile.

var owner: AnyObject

The object represented by the dock tile.

Applying Badge Icons to the Tile

var showsApplicationBadge: Bool

A boolean showing whether the tile is badged with the application’s icon

var badgeLabel: String?

The string to be displayed in the tile’s badging area.

Updating the Dock Tile

func display()

Redraws the dock tile’s content.

Constants

Dock Tile Plug-In Support Version

The version of the AppKit framework containing support for dock tile plug-ins.

Relationships

Inherits From

Conforms To