---

NSTextFieldCell

Overview

NSTextFieldCell adds to NSCell’s text display capabilities by allowing you to set the color of both the text and its background. You can also specify whether the cell draws its background at all. All of the methods declared by this class are also declared by NSTextField, which uses NSTextFieldCells to draw and edit text.

Placeholder strings, set using setPlaceholderString or setPlaceholderAttributedString, now appear in the text field cell if the actual string is null or "". They are drawn in grey on the cell and are not archived in the “pre-10.2” nib format.

Tasks

Constructors

• NSTextFieldCell

Setting the Text Color

• setTextColor
• textColor

Setting the Bezel Style

• setBezelStyle
• bezelStyle

Controlling the Background

• setBackgroundColor
• backgroundColor
• setDrawsBackground
• drawsBackground

Changing the Field Editor

• setUpFieldEditorAttributes

Managing Placeholder Strings

• setPlaceholderString
• placeholderString
• setPlaceholderAttributedString
• placeholderAttributedString

Instance Methods

backgroundColor

Returns the color of the background the receiver draws behind the text.

public NSColor backgroundColor()

See Also

• drawsBackground
• backgroundColor (NSTextField)
• setBackgroundColor

bezelStyle

Returns the receiver’s bezel style.

public int bezelStyle()

Discussion

Possible return values are described in “Constants.”

Availability

• Available in Mac OS X v10.2 and later.

See Also

• setBezelStyle

drawsBackground

Returns true if the receiver’s cell draws its background color behind its text, false if it draws no background.

public boolean drawsBackground()

See Also

• backgroundColor
• drawsBackground (NSTextField)
• setDrawsBackground

placeholderAttributedString

Returns the cell’s attributed placeholder string.

public NSAttributedString placeholderAttributedString()

Availability

• Available in Mac OS X v10.3 and later.

See Also

• setPlaceholderAttributedString
• placeholderString

placeholderString

Returns the cell’s plain text placeholder string.

public String placeholderString()

Availability

• Available in Mac OS X v10.3 and later.

See Also

• setPlaceholderString
• placeholderAttributedString

setBackgroundColor

Sets the color of the background that the receiver draws behind the text to aColor.

public void setBackgroundColor(NSColor aColor)

See Also

• setDrawsBackground
• setBackgroundColor (NSTextField)
• backgroundColor

setBezelStyle

Sets the receiver’s bezel style to be style.

public void setBezelStyle(int style)

Discussion

Possible values for style are described in “Constants.” You must have already sent setBezeled with an argument of true.

Availability

• Available in Mac OS X v10.2 and later.

See Also

• bezelStyle

setDrawsBackground

Controls whether the receiver draws its background color behind its text.

public void setDrawsBackground(boolean flag)

Discussion

If flag is true, then it does; if flag is false, then it draws nothing behind its text.

See Also

• setBackgroundColor
• setDrawsBackground (NSTextField)
• drawsBackground

setPlaceholderAttributedString

Sets the placeholder of the cell as an attributed string.

public void setPlaceholderAttributedString(NSAttributedString string)

Discussion

Note that invoking this successfully will clear out the plain text string set by setPlaceholderString.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• placeholderAttributedString
• setPlaceholderString

setPlaceholderString

Sets the placeholder of the cell as a plain text string.

public void setPlaceholderString(String string)

Discussion

Note that invoking this successfully will clear out the attributed string set by setPlaceholderAttributedString.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• placeholderString
• setPlaceholderAttributedString

setTextColor

Sets the color used to draw the receiver’s text to aColor.

public void setTextColor(NSColor aColor)

See Also

• setBackgroundColor
• setTextColor (NSTextField)
• textColor

setUpFieldEditorAttributes

public NSText setUpFieldEditorAttributes(NSText textObj)

Discussion

You never invoke this method directly; by overriding it, however, you can customize or replace the field editor. When you override this method, you should generally invoke the implementation of super and return the textObj argument. For information on field editors, see “Using the Window’s Field Editor”.

textColor

Returns the color used to draw the receiver’s text.

public NSColor textColor()

See Also

• backgroundColor
• textColor (NSTextField)
• setTextColor

Constants

The following constants are specify the bezel style of the text field, and are set using bezelStyle and setBezelStyle.

---