纯代码NSOutlineView

在mac开发中,常常需要用类似列表的结构来展示数据,最好还有层级,类似于树,比如族谱、菜单等层级结构数据。这个时候NSTableView已经不能够很好的满足我们了,NSOutlineView则给我们提供了更好的选择。

NSOutlineView是NSTableView的子类,但是他比NSTableView多了分组的功能,使用层级的数据结构。

现在NSOutlineView的教程还不是很多,不够全面,大多都是使用Storyboard/xib开发,下面以一个Demo为例介绍纯代码实现使用NSOutlineView显示层级数据结构的过程。

首先创建一个OS X项目工程,创建一个NSViewController,在ViewController中添加NSOutlineView对象(outlineView)并实现NSOutlineViewDataSource和NSOutlineViewDelegate相应的方法。

第一步,我们需要初始化outlineView并设置相关属性。

(需要注意的是,outlineView必须放在scrollView上才可以显示,所以我们在初始化outlineView的时候,需要将outlineView作为scrollView的documentView展示。)

NSTableColumn *tableColumn = [[NSTableColumn alloc] init];

tableColumn.resizingMask = NSTableColumnAutoresizingMask;

NSOutlineView *outlineView = [[NSOutlineView alloc] init];

outlineView.allowsColumnResizing = YES;

outlineView.headerView = nil;

outlineView.columnAutoresizingStyle = NSTableViewFirstColumnOnlyAutoresizingStyle;

outlineView.usesAlternatingRowBackgroundColors = YES;//背景颜色的交替,一行白色,一行灰色。

[outlineView addTableColumn:tableColumn];

NSScrollView *scrollView = [[NSScrollView alloc] init];

scrollView.documentView = outlineView;

scrollView.hasVerticalScroller = YES;

scrollView.autohidesScrollers = YES;

self.view = scrollView;

另外需要注意的一点是,我们需要实现loadView方法。

第二步,我们需要准备好用于展示的数据。

如果在项目中,数据可以通过model的形式从外部直接传过来,demo里我们就直接初始化。这里需要注意,outlinView需要的数据是一种类型的(父子节点数据是同种类型)。

-(void)initData {

//第一级根节点

_dataModel  = [[OutlineViewDataModel alloc] init];

_dataModel.name = @"root";

//2级节点

OutlineViewDataModel *level1Node = [[OutlineViewDataModel alloc]init];

level1Node.name = @"节点1";

OutlineViewDataModel *level2Node = [[OutlineViewDataModel alloc]init];

level2Node.name = @"节点2";

OutlineViewDataModel *level3Node = [[OutlineViewDataModel alloc]init];

level3Node.name = @"节点3";

//1

OutlineViewDataModel *level11Node = [[OutlineViewDataModel alloc]init];

level11Node.name = @"节点1-1";

OutlineViewDataModel *level12Node = [[OutlineViewDataModel alloc]init];

level12Node.name = @"节点1-2";

OutlineViewDataModel *level111Node = [[OutlineViewDataModel alloc]init];

level111Node.name = @"节点1-1-1";

OutlineViewDataModel *level112Node = [[OutlineViewDataModel alloc]init];

level112Node.name = @"节点1-1-2";

level11Node.childNodes = @[level111Node,level112Node];

level1Node.childNodes = @[level11Node,level12Node];

//2

OutlineViewDataModel *level21Node = [[OutlineViewDataModel alloc]init];

level21Node.name = @"节点2-1";

OutlineViewDataModel *level22Node = [[OutlineViewDataModel alloc]init];

level22Node.name = @"节点2-2";

level2Node.childNodes = @[level21Node,level22Node];

//3

OutlineViewDataModel *level31Node = [[OutlineViewDataModel alloc]init];

level31Node.name = @"节点3-1";

OutlineViewDataModel *level311Node = [[OutlineViewDataModel alloc]init];

level311Node.name = @"节点3-1-1";

OutlineViewDataModel *level312Node = [[OutlineViewDataModel alloc]init];

level312Node.name = @"节点3-1-2";

level31Node.childNodes = @[level311Node,level312Node];

level3Node.childNodes = @[level31Node];

_dataModel.childNodes = @[level1Node,level2Node,level3Node];

}

其中model的数据结构:

@property(nonatomic, strong) NSString *name;

@property(nonatomic, strong) NSArray *childNodes;

第三步,根据需要自定义NSTableCellView。

除了自定义布局和样式,还需要在自定义的cellview中实现数据的展示:

//  OutlineItemCellView.m

-(void)setObjectValue:(id)objectValue {

    [super setObjectValue:objectValue];

    if (self.objectValue) {

        if ([self.objectValue isKindOfClass:[OutlineViewDataModel class]]) {

            OutlineViewDataModel *model = (OutlineViewDataModel *)self.objectValue;

            [self updateControlsForDataObject:model.name];

        }

    }

}

-(void)updateControlsForDataObject:(NSString *)name {

    self.textField.stringValue = name;

    self.textField.textColor = [NSColor whiteColor];

}

第四步,根据需要自定义NSTableHeaderCell。

类似于NSTableCellView,自定义样式和数据展示即可。

第五步,在viewController中实现NSOutlineViewDataSource和NSOutlineViewDelegate的方法。

下面介绍一下几个NSOutlineViewDataSource方法,根据需要选择性实现:

1.每一层级节点包含的下一级节点的数量。

-(NSInteger)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item {

    //当item为空时表示根节点.

    if (item != nil && [item isKindOfClass:[OutlineViewDataModel class]]) {

        return ((OutlineViewDataModel *)item).childNodes.count;

    }

    return _dataModel.childNodes.count;

}

2.每一层级节点的模型对象为item时,根据item获取子节点模型。item为nil空时表示获取顶级节点模型。

-(id)outlineView:(NSOutlineView *)outlineView child:(NSInteger)index ofItem:(id)item {

    if(!item) {

        return _dataModel.childNodes[index];

    }else {

        OutlineViewDataModel *model = item;

        return model.childNodes[index];

    }

}

3.节点是否可以打开/关闭。

-(BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item {

    //count 大于0表示有子节点,需要允许Expandable

    if(!item) {

        return [_dataModel.childNodes count]>0 ;

    }else {

        OutlineViewDataModel *model = item;

        return [model.childNodes count]>0;

    }

}

4.设置每个数据载体对应的具体数据,根据节点模型对象item,更新节点视图。

-(id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item {

    //    return ([item isKindOfClass:OutlineViewDataModel.class] ? [item name] : item);

    return item;

}

这个地方用于向自定义的cellView传递数据,如果return item.name,则那边接收到的“self.objectValue”就是item.name。

5.展开的节点是否自动保存

-(id)outlineView:(NSOutlineView *)outlineView itemForPersistentObject:(id)object ;

6.自定义row

-(NSTableRowView *)outlineView:(NSOutlineView *)outlineView rowViewForItem:(id)item ;

下面是NSOutlineViewDelegate的几个方法:

1.根据tableColumn定义的cell的唯一标示identifier,调用makeViewWithIdentifier创建result视图,更新item模型中数据到result视图元素中。

-(NSView *)outlineView:(NSOutlineView *)outlineView viewForTableColumn:(NSTableColumn *)tableColumn item:(id)item {

    OutlineItemCellView *cellView = [outlineView makeViewWithIdentifier:@"cellView" owner:nil];

    if (cellView == nil) {

        cellView = [[OutlineItemCellView alloc] init];

        cellView.identifier = @"cellView";

    }

    return cellView;

}

这里需要注意cellView一开始要复用是没有的,所以要初始化一下。storyboard实现outlineView不需要这个操作,所以纯代码实现的时候容易忽略这点。

2.是否绘制“组行”样式

-(BOOL)outlineView:(NSOutlineView *)outlineView isGroupItem:(id)item {

    if (item && [item isKindOfClass:OutlineViewDataModel.class] && ((OutlineViewDataModel *)item).childNodes) {

        return true;

    }else {

        return false;

    }

}

3.设置每一行的高度

-(CGFloat)outlineView:(NSOutlineView *)outlineView heightOfRowByItem:(id)item ;

4.获取到选择节点后的通知

-(void)outlineViewSelectionDidChange:(NSNotification *)notification ;

这里可以获取点击节点的相关信息,根据需要作出相应处理。比如打印节点name:

NSOutlineView *treeView = notification.object;

NSInteger row = [treeView selectedRow];

OutlineViewDataModel*model = (OutlineViewDataModel*)[treeView itemAtRow:row];

NSLog(@"name = %@",model.name);

以上五步完成之后,运行程序大概是这个样子:


图1

如果我们想要自定义每行的背景色以及点击高亮色,该怎么做呢?

在OutlineItemCellView中设置背景色?那效果是这样的...


图2

因为箭头那部分并不属于cellView,cellView的下面还有一层rowView。

这个时候我们需要自定义NSTableRowView,在OutlineRowView中设置相应样式处理,并在ViewController中实现 (NSTableRowView *)outlineView:(NSOutlineView *)outlineView rowViewForItem:(id)item方法,效果如下:

图3
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容