在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);
以上五步完成之后,运行程序大概是这个样子:
如果我们想要自定义每行的背景色以及点击高亮色,该怎么做呢?
在OutlineItemCellView中设置背景色?那效果是这样的...
因为箭头那部分并不属于cellView,cellView的下面还有一层rowView。
这个时候我们需要自定义NSTableRowView,在OutlineRowView中设置相应样式处理,并在ViewController中实现 (NSTableRowView *)outlineView:(NSOutlineView *)outlineView rowViewForItem:(id)item方法,效果如下: