cappuccino/AppKit/_CPAutocompleteMenu.j

/*
 * _CPAutocompleteMenu.j
 * AppKit
 *
 * Created by Alexander Ljungberg on May 10, 2012.
 * Copyright 2012, Alexander Ljungberg. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

@import <Foundation/CPObject.j>

@import "CPTextField.j"
@import "CPTableView.j"
@import "_CPMenuWindow.j"

@class CPScrollView


// TODO Make themable.
var _CPAutocompleteMenuMaximumHeight = 307;

/*!
    An "autocomplete" menu displayed by a text field.
*/
@implementation _CPAutocompleteMenu : CPObject
{
    CPTextField     textField @accessors;
    CPArray         contentArray @accessors;
    float           widestItemWidth;

    CPWindow        _menuWindow;
    CPScrollView    scrollView;
    CPTableView     tableView;

    CPTimer         _showCompletionsTimer;
}

- (id)initWithTextField:(CPTextField)aTextField
{
    if (self = [super init])
    {
        textField = aTextField;

        _menuWindow = [[_CPAutocompleteWindow alloc] initWithContentRect:CGRectMake(0, 0, 100, 100) styleMask:CPBorderlessWindowMask];

        [_menuWindow setLevel:CPPopUpMenuWindowLevel];
        [_menuWindow setHasShadow:YES];
        [_menuWindow setShadowStyle:CPMenuWindowShadowStyle];
        [_menuWindow setAcceptsMouseMovedEvents:YES];
        [_menuWindow setBackgroundColor:[_CPMenuWindow backgroundColorForBackgroundStyle:_CPMenuWindowPopUpBackgroundStyle]];

        var contentView = [_menuWindow contentView];

        scrollView = [[CPScrollView alloc] initWithFrame:CGRectMakeZero()];
        [scrollView setAutohidesScrollers:YES];
        [scrollView setHasHorizontalScroller:NO];
        [contentView addSubview:scrollView];

        tableView = [[_CPNonFirstResponderTableView alloc] initWithFrame:CGRectMakeZero()];

        var tableColumn = [CPTableColumn new];
        [tableColumn setResizingMask:CPTableColumnAutoresizingMask];
        [tableView addTableColumn:tableColumn];

        [tableView setDataSource:self];
        [tableView setDelegate:self];
        [tableView setTarget:self];
        [tableView setAction:@selector(complete:)];
        [tableView setAllowsMultipleSelection:NO];
        [tableView setHeaderView:nil];
        [tableView setCornerView:nil];
        [tableView setRowHeight:24.0];
        [tableView setGridStyleMask:CPTableViewGridNone];
        [tableView setBackgroundColor:[CPColor clearColor]];

        [scrollView setDocumentView:tableView];
    }

    return self;
}

/*!
    Set an array of strings to use as the available completions.
*/
- (void)setContentArray:(CPArray)anArray
{
    if (contentArray === anArray || [contentArray isEqualToArray:anArray])
        return;

    contentArray = [anArray copy];

    // Go away automatically if there are no suggestions.
    if (![contentArray count])
        [self _hideCompletions];

    widestItemWidth = CPNotFound;

    [tableView reloadData];
    [self layoutSubviews];
}

- (void)setIndexOfSelectedItem:(int)anIndex
{
    if (anIndex == CPNotFound)
        [tableView selectRowIndexes:[CPIndexSet indexSet] byExtendingSelection:NO];
    else
    {
        [tableView selectRowIndexes:[CPIndexSet indexSetWithIndex:anIndex] byExtendingSelection:NO];
        [tableView scrollRowToVisible:anIndex];
    }
}

- (int)indexOfSelectedItem
{
    return [tableView selectedRow];
}

- (CPString)selectedItem
{
    return contentArray ? contentArray[[tableView selectedRow]] : nil;
}

- (void)layoutSubviews
{
    /*
    If the textField has no window, then we simply stop to layout the
    subviews and close the _menuWindow.
    */
    if (![textField window])
    {
        [_menuWindow orderOut:self];
        return;
    }

    // TODO
    /*
    The autocompletion menu should be underneath the word/text being
    autocompleted. It should at least be wide enough to fit the widest option
    but no wider than the width of the text field. It might stick out on the
    right side, so that if the edited text is on the right of the text field
    the menu might extend a full text field width more into space on the right
    side. It should not stick out outside of the screen. The height should be
    the smallest possible to fit all options or at most ~307px (based on
    Cocoa). If the options don't fit horizontally they should be truncated
    with an ellipsis.
    */

    var frame = [textField frame],
        origin = frame.origin,
        tableColumn = [[tableView tableColumns] firstObject];

    if ([textField respondsToSelector:@selector(_completionOrigin:)])
        origin = [textField _completionOrigin:self];

    if (widestItemWidth === CPNotFound)
    {
        // This calculation could be slow for many items.

        var dataView = [tableColumn dataView],
            fontNormal = [dataView valueForThemeAttribute:@"font" inState:CPThemeStateTableDataView],
            fontSelected = [dataView valueForThemeAttribute:@"font" inStates:[CPThemeStateTableDataView, CPThemeStateSelectedDataView]],
            contentInsetNormal = [dataView valueForThemeAttribute:@"content-inset" inState:CPThemeStateTableDataView],
            contentInsetSelected = [dataView valueForThemeAttribute:@"content-inset" inStates:[CPThemeStateTableDataView, CPThemeStateSelectedDataView]];

        var mergedString = contentArray.join("\n");

        widestItemWidth = MAX([mergedString sizeWithFont:fontNormal].width + contentInsetNormal.left + contentInsetNormal.right, [mergedString sizeWithFont:fontSelected].width + contentInsetSelected.left + contentInsetSelected.right) + [tableView intercellSpacing].width + 2.0 + 5.0;  // 2.0 because we inset by 1.0 below, 5.0 mystery constant.
        // TODO Track down why mystery constant is needed to allocate enough width. Scroll view insets?
    }

    var frameOrigin = [[textField window] convertBaseToGlobal:[textField convertPointToBase:origin]],
        screenSize = [([CPPlatform isBrowser] ? [_menuWindow platformWindow] : [_menuWindow screen]) visibleFrame].size,
        availableWidth = screenSize.width - frameOrigin.x,
        availableHeight = screenSize.height - frameOrigin.y,
        width = MIN(widestItemWidth, availableWidth),
        spacingHeight = [tableView intercellSpacing].height,
        height = MIN(MIN(spacingHeight + [contentArray count] * ([tableView rowHeight] + spacingHeight), _CPAutocompleteMenuMaximumHeight), availableHeight),
        newFrame = CGRectMake(frameOrigin.x, frameOrigin.y, width, height);

    newFrame = [_menuWindow frameRectForContentRect:newFrame];
    [_menuWindow setFrame:newFrame];

    var scrollFrame = CGRectInset([[_menuWindow contentView] bounds], 1.0, 1.0);
    [scrollView setFrame:scrollFrame];

    [tableColumn setWidth:[[scrollView contentView] frame].size.width];
}

- (void)_showCompletions:(CPTimer)timer
{
    var indexOfSelectedItem = [self indexOfSelectedItem];

    [self setContentArray:[textField _completionsForSubstring:[textField _inputElement].value indexOfToken:0 indexOfSelectedItem:indexOfSelectedItem]];

    if (![contentArray count])
        return;

    // TODO Support indexOfSelectedItem. Always 0 right now.
    [self setIndexOfSelectedItem:indexOfSelectedItem];

    [textField setThemeState:CPThemeStateAutocompleting];

    [_menuWindow setPlatformWindow:[[textField window] platformWindow]];
    [[textField window] addChildWindow:_menuWindow ordered:CPWindowAbove];

    [self layoutSubviews];
}

- (void)_delayedShowCompletions
{
    var completionDelay = 0.5;

    if ([textField respondsToSelector:@selector(completionDelay)])
        completionDelay = [textField completionDelay];

    _showCompletionsTimer = [CPTimer scheduledTimerWithTimeInterval:completionDelay
                                                             target:self
                                                           selector:@selector(_showCompletions:)
                                                           userInfo:nil
                                                            repeats:NO];
}

- (void)_hideCompletions
{
    [_showCompletionsTimer invalidate];
    _showCompletionsTimer = nil;

    [textField unsetThemeState:CPThemeStateAutocompleting];
    [_menuWindow orderOut:self];
    [self layoutSubviews];
}

- (void)selectNext
{
    var index = [self indexOfSelectedItem] + 1;

    if (index >= [contentArray count])
        return;

    [self setIndexOfSelectedItem:index];
}

- (void)selectPrevious
{
    var index = [self indexOfSelectedItem] - 1;

    if (index < 0)
        return;

    [self setIndexOfSelectedItem:index];
}

- (int)numberOfRowsInTableView:(CPTableView)tableView
{
    return [contentArray count];
}

- (void)tableView:(CPTableView)tableView objectValueForTableColumn:(CPTableColumn)tableColumn row:(CPInteger)row
{
    return [contentArray objectAtIndex:row];
}

- (@action)complete:(id)sender
{
    [textField _complete:self];
}

@end

@implementation _CPAutocompleteWindow : CPPanel

- (id)initWithContentRect:(CGRect)aContentRect styleMask:(unsigned)aStyleMask
{
    if (self = [super initWithContentRect:aContentRect styleMask:aStyleMask])
        _constrainsToUsableScreen = NO;

    return self;
}

- (BOOL)becomesKeyOnlyIfNeeded
{
    return YES;
}

- (BOOL)worksWhenModal
{
    // Windows which serve as auxiliary controls should work when modal.
    return YES;
}

@end

@implementation _CPNonFirstResponderTableView : CPTableView

- (BOOL)needsPanelToBecomeKey
{
    return NO;
}

- (BOOL)acceptsFirstResponder
{
    return NO;
}

@end