Developer Documentation
PATH  Mac OS X Documentation > Application Kit Reference: Java

Table of Contents

NSActionCell


Inherits from:
NSCell : NSObject
Package:
com.apple.yellow.application


Class Description


An NSActionCell defines an active area inside a control (an instance of NSControl or one of its subclasses). As an NSControl's active area, an NSActionCell does three things: it usually performs display of text or an icon; it provides the NSControl with a target and an action; and it handles mouse (cursor) tracking by properly highlighting its area and sending action messages to its target based on cursor movement.

NSActionCell implements the target object and action method as defined by its superclass, NSCell. As a user manipulates an NSControl, NSActionCell's trackMouse method (inherited from NSCell) updates its appearance and sends the action message to the target object with the NSControl object as the only argument. See "Target and Action" below for more on this paradigm.

Usually, the responsibility for an NSControl's appearance and behavior is completely given over to a corresponding NSActionCell. (NSMatrix, and its subclass NSForm, are NSControls that don't follow this rule.)

A single NSControl may have more than one NSActionCell. To help identify it in this case, every NSActionCell has an integer tag. Note, however, that no checking is done by the NSActionCell object itself to ensure that the tag is unique. See the NSMatrix class for an example of a subclass of NSControl that contains multiple NSActionCells.

Many of the methods that define the contents and look of an NSActionCell, such as setFont and setBordered, are reimplementations of methods inherited from NSCell. They're overridden to ensure the NSActionCell is redisplayed when "visual" attributes change.


Target and Action


Target objects and action methods (or messages) are part of the mechanism by which NSControls respond to user actions and enable users to communicate their intentions to an application. A target is an object an NSControl uses as the receiver of action messages. The target's class defines an action method to enable its instances to respond to these messages, which are sent as users click or otherwise manipulate the NSControl. NSControl's sendActionToTarget asks the NSApplication object, NSApp, to send an action message to the NSControl's target object.

An action method takes only one argument: the sender. The sender may be either the NSControl that sends the action message or, on occasion, another object that the target should treat as the sender. When it receives an action message, a target can return messages to the sender requesting additional information about its status.

You can also set the target to null and allow it to be determined at run time. When the target is null, the NSApplication object must look for an appropriate receiver. It conducts its search in a prescribed order, by following the responder chain until it finds an object that can respond to the message:

NSControl provides methods for setting and using the target object and the action method. However, these methods require that an NSControl's cell (or cells) be NSActionCells or custom cells that hold action and target as instance variables and can respond to the NSControl methods.




Method Types


Constructors
NSActionCell
Configuring an NSActionCell
setAlignment
setBezeled
setBordered
setEnabled
setFloatingPointFormat
setFont
setImage
Obtaining and setting cell values
doubleValue
floatValue
intValue
stringValue
setObjectValue
Displaying the NSActionCell
controlView
Assigning target and action
setAction
action
setTarget
target
Assigning a tag
setTag
tag


Constructors



NSActionCell

public NSActionCell()

Description forthcoming.

public NSActionCell(String aString)

Description forthcoming.

public NSActionCell(NSImage anImage)

Description forthcoming.


Instance Methods



action

public NSSelector action()

Returns the NSActionCell's action-message selector.

See Also: setAction, setTarget, target



controlView

public NSView controlView()

Returns the view (normally an NSControl) in which the NSActionCell was last drawn or null if the NSActionCell has no control view (usually because it hasn't yet been placed in the view hierarchy).

doubleValue

public double doubleValue()

Returns the NSActionCell's value as a double after validating any editing of cell content. If the receiver is not a text-type cell or the cell value is not scannable, the method returns zero.

See Also: validateEditing, validateEditing (NSControl)



floatValue

public float floatValue()

Returns the NSActionCell's value as a float after validating any editing of cell content. If the receiver is not a text-type cell or the cell value is not scannable, the method returns zero.

See Also: validateEditing (NSControl)



intValue

public int intValue()

Returns the NSActionCell's value as a int after validating any editing of cell content. If the receiver is not a text-type cell or the cell value is not scannable, the method returns zero.

See Also: validateEditing (NSControl)



setAction

public void setAction(NSSelector aSelector)

Sets the selector used for the action message to aSelector.

See Also: action, setTarget, target



setAlignment

public void setAlignment(int mode)

Sets the alignment of text in the receiving NSActionCell. mode is one of five constants: LeftTextAlignment, RightTextAlignment, CenterTextAlignment, JustifiedTextAlignment, NaturalTextAlignment (the default alignment for the text). The method marks the receiving NSActionCell as needing redisplay after discarding any editing changes that were being made to cell text.

setBezeled

public void setBezeled(boolean flag)

Sets whether the NSActionCell draws itself with a bezeled border and marks it as needing redisplay. The setBezeled and setBordered methods are mutually exclusive-that is, a border can be only plain or bezeled.

setBordered

public void setBordered(boolean flag)

Sets whether the receiver draws itself outlined with a plain border and marks it as needing redisplay. The setBezeled and setBordered methods are mutually exclusive-that is, a border can be only plain or bezeled.

setEnabled

public void setEnabled(boolean flag)

Sets whether the receiver is enabled or disabled. The text of disabled cells is changed to gray. If a cell is disabled, it cannot be highlighted, does not support mouse tracking (and thus cannot participate in target/action functionality), and cannot be edited. The method marks the receiving NSActionCell as needing redisplay after discarding any editing changes that were being made to cell text.

setFloatingPointFormat

public void setFloatingPointFormat( boolean autoRange, int leftDigits, int rightDigits)

Sets the NSActionCell's floating point format as described in the NSCell class specification for the setFloatingPointFormat method. NSActionCell's implementation of the method supplements NSCell's by marking the receiving NSActionCell as needing redisplay after discarding any editing changes that were being made to cell text.

setFont

public void setFont(NSFont fontObj)

Sets the font to be used when the NSActionCell displays text. If the receiver is not a text-type cell, the method converts it to that type. If fontObj is null and the receiver is a text-type cell, the font currently held by the receiver is autoreleased. NSActionCell supplements NSCell's implementation of this method by marking the updated cell as needing redisplay. If the receiving NSActionCell was converted to a text-type cell and is selected, it also updates the field editor with fontObj.

setImage

public void setImage(NSImage image)

Sets the image to be displayed in the receiver. If image is null, the image currently displayed by the receiver is removed.

setObjectValue

public void setObjectValue(Object object)

Discards any editing of the receiving NSActionCell's text and sets its object value to object. If the object value is afterwards different from what it was before the method was invoked, the method marks the NSActionCell as needing redisplay.

setTag

public void setTag(int anInt)

Sets the receiving NSActionCell's tag to anInt.

See Also: tag



setTarget

public void setTarget(Object anObject)

Sets the receiving NSActionCell's target object to anObject.

See Also: action, setAction, target



stringValue

public String stringValue()

Returns the receiving NSActionCell's value as a string object as converted by the cell's formatter, if one exists. If no formatter exists and the value is a String, returns the value as a plain, attributed or localized formatted string. If the value is not a String or can't be converted to one, returns an empty string. The method supplements NSCell's implementation by validating and retaining any editing changes being made to cell text.

See Also: validateEditing (NSControl)



tag

public int tag()

Returns the receiving NSActionCell's tag.

See Also: setTag



target

public Object target()

Returns the receiving NSActionCell's target object.

See Also: action, setAction, setTarget




Table of Contents