cappuccino/AppKit/CPColorWell.j

/*
 * CPColorWell.j
 * AppKit
 *
 * Created by Ross Boucher.
 * Copyright 2008, 280 North, Inc.
 *
 * 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/CPString.j>

@import "CPView.j"
@import "CPColor.j"
@import "CPColorPanel.j"


var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiveNotification";

/*! @class CPColorWell

    CPColorWell is a CPControl for selecting and displaying a single color value. An example of a CPColorWell object (or simply color well) is found in CPColorPanel, which uses a color well to display the current color selection.</p>

    <p>An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the <code>activate:</code> method with <code>NO</code> as its argument. When a mouse-down event occurs on an CPColorWell's border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also.
*/
@implementation CPColorWell : CPControl
{
    BOOL    _active;
    BOOL    _bordered;
    
    CPColor _color;
    CPView  _wellView;
}

- (id)initWithFrame:(CGRect)aFrame
{
    self = [super initWithFrame:aFrame];
    
    if (self)
    {
        _active = NO;
        _bordered = YES;
        _color = [CPColor whiteColor];
        
        [self drawBezelWithHighlight:NO];
        [self drawWellInside:CGRectInset([self bounds], 3.0, 3.0)];
        
        [self _registerForNotifications];
    }
    
    return self;
}

- (void)_registerForNotifications
{
    var defaultCenter = [CPNotificationCenter defaultCenter];

    [defaultCenter
        addObserver:self
           selector:@selector(colorWellDidBecomeExclusive:)
               name:_CPColorWellDidBecomeExclusiveNotification
             object:nil];

    [defaultCenter
        addObserver:self
           selector:@selector(colorPanelWillClose:)
               name:CPWindowWillCloseNotification
             object:[CPColorPanel sharedColorPanel]];
}

/*!
    Returns whether the color well is bordered
*/
- (BOOL)isBordered
{
    return _bordered;
}

/*!
    Sets the color well's current color.
*/
- (void)setBordered:(BOOL)bordered
{
    if (_bordered == bordered)
        return;
        
    _bordered = bordered;
    
    [self drawWellInside:CGRectInset([self bounds], 3.0, 3.0)];
}

// Managing Color From Color Wells

/*!
    Returns the color well's current color.
*/
- (CPColor)color
{
    return _color;
}

/*!
    Sets the color well's current color.
*/
- (void)setColor:(CPColor)aColor
{
    if (_color == aColor)
        return;
    
    _color = aColor;
    
    [self drawWellInside:CGRectInset([self bounds], 3.0, 3.0)];
}

/*!
    Changes the color of the well to that of <code>aSender</code>.
    @param aSender the object from which to retrieve the color
*/
- (void)takeColorFrom:(id)aSender
{
    [self setColor:[aSender color]];
}

// Activating and Deactivating Color Wells
/*!
    Activates the color well, displays the color panel, and makes the panel's current color the same as its own. 
    If exclusive is <code>YES</code>, deactivates any other CPColorWells. <code>NO</code>, keeps them active.
    @param shouldBeExclusive whether other color wells should be deactivated.
*/
- (void)activate:(BOOL)shouldBeExclusive
{
    if (shouldBeExclusive)
        // FIXME: make this queue!
        [[CPNotificationCenter defaultCenter]
            postNotificationName:_CPColorWellDidBecomeExclusiveNotification
                          object:self];


    if ([self isActive])
        return;
        
    _active = YES;
    
    [[CPNotificationCenter defaultCenter]
        addObserver:self
           selector:@selector(colorPanelDidChangeColor:)
               name:CPColorPanelColorDidChangeNotification
             object:[CPColorPanel sharedColorPanel]];
}

/*!
    Deactivates the color well.
*/
- (void)deactivate
{
    if (![self isActive])
        return;
    
    _active = NO;
    
    [[CPNotificationCenter defaultCenter]
        removeObserver:self
                  name:CPColorPanelColorDidChangeNotification
                object:[CPColorPanel sharedColorPanel]];
}

/*!
    Returns <code>YES</code> if the color well is active.
*/
- (BOOL)isActive
{
    return _active;
}

// Drawing a Color Well

- (void)drawBezelWithHighlight:(BOOL)shouldHighlight
{
}

/*!
    Draws the colored area inside the color well without borders.
    @param aRect the location at which to draw
*/
- (void)drawWellInside:(CGRect)aRect
{
    if (!_wellView)
    {
        _wellView = [[CPView alloc] initWithFrame:aRect];
        [_wellView setAutoresizingMask:CPViewWidthSizable | CPViewHeightSizable];
        
        [self addSubview:_wellView];
    }
    else
        [_wellView setFrame:aRect];
    
    [_wellView setBackgroundColor:_color];
}

- (void)colorPanelDidChangeColor:(CPNotification)aNotification
{
    [self takeColorFrom:[aNotification object]];
    
    [self sendAction:[self action] to:[self target]];
}

- (void)colorWellDidBecomeExclusive:(CPNotification)aNotification
{
    if (self != [aNotification object])
        [self deactivate];
}

- (void)colorPanelWillClose:(CPNotification)aNotification
{
    [self deactivate];
}

- (void)mouseDown:(CPEvent)anEvent
{
    [self drawBezelWithHighlight:YES];
}

- (void)mouseDragged:(CPEvent)anEvent
{
    [self drawBezelWithHighlight:CGRectContainsPoint([self bounds], [self convertPoint:[anEvent locationInWindow] fromView:nil])];
}

-(void)mouseUp:(CPEvent)anEvent
{
    [self drawBezelWithHighlight:NO];

    if (!CGRectContainsPoint([self bounds], [self convertPoint:[anEvent locationInWindow] fromView:nil]))
        return;
        
    [self activate:YES];

    var colorPanel = [CPColorPanel sharedColorPanel];
    
    [colorPanel setColor:_color];
    [colorPanel orderFront:self];
}

@end

var CPColorWellColorKey     = "CPColorWellColorKey",
    CPColorWellBorderedKey  = "CPColorWellBorderedKey";

@implementation CPColorWell (CPCoding)

/*!
    Initializes the color well by unarchiving data from <code>aCoder</code>.
    @param aCoder the coder containing the archived CPColorWell.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
    self = [super initWithCoder:aCoder];
    
    if (self)
    {
        _active = NO;
        _bordered = [aCoder decodeObjectForKey:CPColorWellBorderedKey];
        _color = [aCoder decodeObjectForKey:CPColorWellColorKey];

        [self drawBezelWithHighlight:NO];
        [self drawWellInside:CGRectInset([self bounds], 3.0, 3.0)];

        [self _registerForNotifications];
    }
    
    return self;
}

/*!
    Archives this button into the provided coder.
    @param aCoder the coder to which the color well's instance data will be written.
*/
- (void)encodeWithCoder:(CPCoder)aCoder
{
    // We do this in order to avoid encoding the _wellView, which 
    // should just automatically be created programmatically as needed.
    var actualSubviews = _subviews;
    
    _subviews = [_subviews copy];
    [_subviews removeObjectIdenticalTo:_wellView];
    
    [super encodeWithCoder:aCoder];
    
    _subviews = actualSubviews;
    
    [aCoder encodeObject:_color forKey:CPColorWellColorKey];
    [aCoder encodeObject:_bordered forKey:CPColorWellBorderedKey];
}

@end