OOTextFieldHistoryManager Class Reference

#include <OOTextFieldHistoryManager.h>

Inheritance diagram for OOTextFieldHistoryManager:

Collaboration diagram for OOTextFieldHistoryManager:

Instance Methods
(NSArray *)	- history
(void)	- setHistory:
(void)	- addToHistory:
(NSUInteger)	- historySize
(void)	- setHistorySize:
(BOOL)	- control:textView:doCommandBySelector: [implementation]
(id)	- init [implementation]
(void)	- dealloc [implementation]
(void)	- checkInvariant [implementation]
(void)	- maintainInvariant [implementation]
(void)	- moveHistoryCursorTo:fieldEditor: [implementation]
(void)	- moveHistoryCursorBy:fieldEditor: [implementation]

Private Attributes
IBOutlet NSTextField *	textField
NSMutableArray *	_history
NSUInteger	_historyMaxSize
NSUInteger	_historyCurrSize
NSUInteger	_historyCursor
NSString *	_latest

Detailed Description

Definition at line 41 of file OOTextFieldHistoryManager.h.

Method Documentation

addToHistory:

- (void) addToHistory:

(NSString *)

string

Definition at line 1 of file OOTextFieldHistoryManager.m.

                     :(NSString *)string
{
    [self checkInvariant];
    
    if (_historyCurrSize == 0 || ![string isEqual:[_history objectAtIndex:_historyCurrSize - 1]])
    {
        [_history addObject:[[string copy] autorelease]];
    }
    _historyCursor = 0;
    [_latest release];
    _latest = nil;
    
    [self maintainInvariant];
}

checkInvariant

- (void) checkInvariant

implementation

Provided by category OOTextFieldHistoryManager(Private).

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    NSAssert(_history != nil &&  // History buffer must exist
             _historyCurrSize == [_history count] &&  // Size must be correct
             ((_historyCurrSize <= _historyMaxSize) || (_historyMaxSize == 0)) &&  // Size must be in bounds
             _historyCursor <= _historyCurrSize + 1,  // Cursor must be in bounds
             @"Invalid history buffer state in OOTextFieldHistoryManager.");
}

control:textView:doCommandBySelector:

- (BOOL) control: (NSControl *) control textView: (NSTextView *) textView doCommandBySelector: (SEL) commandSelector

implementation

Definition at line 1 of file OOTextFieldHistoryManager.m.

                :(NSControl *)control textView:(NSTextView *)textView doCommandBySelector:(SEL)commandSelector
{
    if (control == textField)
    {
        if (commandSelector == @selector(moveToBeginningOfParagraph:) ||
            commandSelector == @selector(scrollPageUp:))
        {
            // Option-up arrow or page up. (For just up arrow, use moveUp:.)
            [self moveHistoryCursorBy:1 fieldEditor:textView];
            return YES;
        }
        else if (commandSelector == @selector(moveToEndOfParagraph:) ||
                 commandSelector == @selector(scrollPageDown:))
        {
            // Option-down arrow or page down. (For just down arrow, use moveDown:.)
            [self moveHistoryCursorBy:-1 fieldEditor:textView];
            return YES;
        }
    }
    return NO;
}

dealloc

- (void) dealloc

implementation

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    [_history release];
    
    [super dealloc];
}

history

- (NSArray *) history

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    return [[_history copy] autorelease];
}

historySize

- (NSUInteger) historySize

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    return _historyMaxSize;
}

init

- (id) init

implementation

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    self = [super init];
    if (self != nil)
    {
        _historyMaxSize = kDefaultHistorySize;
        _history = [[NSMutableArray alloc] initWithCapacity:kDefaultHistorySize];
        [self checkInvariant];
    }
    return self;
}

maintainInvariant

- (void) maintainInvariant

implementation

Provided by category OOTextFieldHistoryManager(Private).

Definition at line 1 of file OOTextFieldHistoryManager.m.

{
    _historyCurrSize = [_history count];
    
    if (_historyMaxSize && (_historyMaxSize < _historyCurrSize))
    {
        [_history removeObjectsInRange:NSMakeRange(0, _historyCurrSize - _historyMaxSize)];
        _historyCurrSize = _historyMaxSize;
    }
    
    [self checkInvariant];
}

moveHistoryCursorBy:fieldEditor:

- (void) moveHistoryCursorBy: (NSInteger) offset fieldEditor: (NSTextView *) fieldEditor

implementation

Provided by category OOTextFieldHistoryManager(Private).

Definition at line 1 of file OOTextFieldHistoryManager.m.

                            :(NSInteger)offset fieldEditor:(NSTextView *)fieldEditor
{
    // Range check
    if (((offset < 0) && (_historyCursor < (NSUInteger)-offset))    // Destination < 0
        || (_historyCurrSize < (offset + _historyCursor)))  // Destination > _historyCurrSize
    {
        NSBeep();
        return;
    }
    [self moveHistoryCursorTo:_historyCursor + offset fieldEditor:fieldEditor];
}

moveHistoryCursorTo:fieldEditor:

- (void) moveHistoryCursorTo: (NSUInteger) newCursor fieldEditor: (NSTextView *) fieldEditor

implementation

Provided by category OOTextFieldHistoryManager(Private).

Definition at line 1 of file OOTextFieldHistoryManager.m.

                            :(NSUInteger)newCursor fieldEditor:(NSTextView *)fieldEditor
{
    NSString                    *value = nil;
    NSTextStorage               *textStorage = nil;
    
    if (_historyCurrSize < newCursor)
    {
        NSBeep();
        return;
    }
    
    [self checkInvariant];
    textStorage = [fieldEditor textStorage];
    
    if (newCursor > 0)
    {
        NSUInteger index = _historyCurrSize - newCursor;
        value = [_history objectAtIndex:index];
        if (_historyCursor == 0)  _latest = [[textStorage string] copy];
    }
    else
    {
        value = [_latest autorelease];
        _latest = nil;
    }
    
    _historyCursor = newCursor;
    
    [textStorage setString:value];
    [textField selectText:self];
    
    [self checkInvariant];
}

setHistory:

- (void) setHistory:

(NSArray *)

history

Definition at line 1 of file OOTextFieldHistoryManager.m.

                   :(NSArray *)history
{
    if (history == nil)  [_history removeAllObjects];
    else
    {
        _history = [history mutableCopy];
        _historyCursor = 0;
        [self maintainInvariant];
    }
    [self checkInvariant];
}

setHistorySize:

- (void) setHistorySize:

(NSUInteger)

size

Definition at line 1 of file OOTextFieldHistoryManager.m.

                       :(NSUInteger)size
{
    _historyMaxSize = size;
    [self maintainInvariant];
}

Member Data Documentation

_history

- (NSMutableArray*) _history

private

Definition at line 46 of file OOTextFieldHistoryManager.h.

_historyCurrSize

- (NSUInteger) _historyCurrSize

private

Definition at line 48 of file OOTextFieldHistoryManager.h.

_historyCursor

- (NSUInteger) _historyCursor

private

Definition at line 49 of file OOTextFieldHistoryManager.h.

_historyMaxSize

- (NSUInteger) _historyMaxSize

private

Definition at line 47 of file OOTextFieldHistoryManager.h.

_latest

- (NSString*) _latest

private

Definition at line 50 of file OOTextFieldHistoryManager.h.

textField

- (IBOutlet NSTextField*) textField

private

Definition at line 44 of file OOTextFieldHistoryManager.h.

---

The documentation for this class was generated from the following files:

• Mac-specific/DebugBundle/Source/OOTextFieldHistoryManager.h
• Mac-specific/DebugBundle/Source/OOTextFieldHistoryManager.m