//初始化方法- (instancetype)initWithFrame:(NSRect)frameRect;- (nullable instancetype)initWithCoder:(NSCoder *)coder;//设置代理@property (nullable, weak) id <NSTableViewDataSource> dataSource;@property (nullable, weak) id <NSTableViewDelegate> delegate;//设置TableView的头视图 会被列头图就行覆盖@property (nullable, strong) NSTableHeaderView *headerView;//设置头图右侧视图 可以自定义图标@property (nullable, strong) NSView *cornerView;//设置是否允许列拖拽排序@property BOOL allowsColumnReordering;//设置是否允许调整列宽度@property BOOL allowsColumnResizing;//调整列宽度的风格/*typedef NS_ENUM(NSUInteger, NSTableViewColumnAutoresizingStyle) { //不可调整 NSTableViewNoColumnAutoresizing = 0, //平分 NSTableViewUniformColumnAutoresizingStyle, //从后往前调整 NSTableViewSequentialColumnAutoresizingStyle, //从前往后调整 NSTableViewReverseSequentialColumnAutoresizingStyle, //最后一列可调整 NSTableViewLastColumnOnlyAutoresizingStyle, //第一列可调整 NSTableViewFirstColumnOnlyAutoresizingStyle};*/@property NSTableViewColumnAutoresizingStyle columnAutoresizingStyle;//设置分割线风格/*typedef NS_OPTIONS(NSUInteger, NSTableViewGridLineStyle) { //无分割线 NSTableViewGridNone = 0, //竖直分割线 NSTableViewSolidVerticalGridLineMask = 1 << 0, //水平分割线 NSTableViewSolidHorizontalGridLineMask = 1 << 1, //水平虚线分割线 NSTableViewDashedHorizontalGridLineMask ,};*/@property NSTableViewGridLineStyle gridStyleMask;//设置cell之间的间隔 需要设置为NSSize对象@property NSSize intercellSpacing;//是否开启斑马纹@property BOOL usesAlternatingRowBackgroundColors;//背景色@property (copy) NSColor *backgroundColor;//设置分割线颜色@property (copy) NSColor *gridColor;//设置行尺寸风格/*typedef NS_ENUM(NSInteger, NSTableViewRowSizeStyle) { //默认 NSTableViewRowSizeStyleDefault = -1, //自定义 NSTableViewRowSizeStyleCustom = 0, //小尺寸风格 NSTableViewRowSizeStyleSmall = 1, //中等尺寸风格 NSTableViewRowSizeStyleMedium = 2, //大尺寸风格 NSTableViewRowSizeStyleLarge = 3,} NS_ENUM_AVAILABLE_MAC(10_7);*/@property NSTableViewRowSizeStyle rowSizeStyle;//行高@property CGFloat rowHeight;//获取所有列对象@property (readonly, copy) NSArray<NSTableColumn *> *tableColumns;//获取列数@property (readonly) NSInteger numberOfColumns;//获取行数@property (readonly) NSInteger numberOfRows;//添加一列- (void)addTableColumn:(NSTableColumn *)tableColumn;//移除一列- (void)removeTableColumn:(NSTableColumn *)tableColumn;//移动列- (void)moveColumn:(NSInteger)oldIndex toColumn:(NSInteger)newIndex;//根据id获取列的下标- (NSInteger)columnWithIdentifier:(NSString *)identifier;//根据id获取列对象- (nullable NSTableColumn *)tableColumnWithIdentifier:(NSString *)identifier;//滚动到指定行可见- (void)scrollRowToVisible:(NSInteger)row;//滚动到指定列可见- (void)scrollColumnToVisible:(NSInteger)column;//重新加载数据- (void)reloadData;//重新加载指定位置的数据- (void)reloadDataForRowIndexes:(NSIndexSet *)rowIndexes columnIndexes:(NSIndexSet *)columnIndexes;//获取编辑的列@property (readonly) NSInteger editedColumn;//获取编辑的行@property (readonly) NSInteger editedRow;//获取点击的列@property (readonly) NSInteger clickedColumn;//获取点击的行@property (readonly) NSInteger clickedRow;//设置列头提示图片- (void)setIndicatorImage:(nullable NSImage *)image inTableColumn:(NSTableColumn *)tableColumn;//获取列头提示图片- (nullable NSImage *)indicatorImageInTableColumn:(NSTableColumn *)tableColumn;//下面这些方法与列表拖拽有关@property BOOL verticalMotionCanBeginDrag;- (BOOL)canDragRowsWithIndexes:(NSIndexSet *)rowIndexes atPoint:(NSPoint)mouseDownPoint;- (NSImage *)dragImageForRowsWithIndexes:(NSIndexSet *)dragRows tableColumns:(NSArray<NSTableColumn *> *)tableColumns event:(NSEvent *)dragEvent offset:(NSPointPointer)dragImageOffset;- (void)setDraggingSourceOperationMask:(NSDragOperation)mask forLocal:(BOOL)isLocal;- (void)setDropRow:(NSInteger)row dropOperation:(NSTableViewDropOperation)dropOperation;//下面这些方法与列表选中有关//是否支持多选@property BOOL allowsMultipleSelection;//是否允许都不选中@property BOOL allowsEmptySelection;//是否支持选中列 如果设置为YES 点击列头会将整列选中@property BOOL allowsColumnSelection;//全选 用于子类重写- (void)selectAll:(nullable id)sender;//全不选 用于子类重写- (void)deselectAll:(nullable id)sender;//进行列选中- (void)selectColumnIndexes:(NSIndexSet *)indexes byExtendingSelection:(BOOL)extend;//进行行选中- (void)selectRowIndexes:(NSIndexSet *)indexes byExtendingSelection:(BOOL)extend;//获取所有选中列index@property (readonly, copy) NSIndexSet *selectedColumnIndexes;//获取所有选中行index@property (readonly, copy) NSIndexSet *selectedRowIndexes;//取消某列的选中- (void)deselectColumn:(NSInteger)column;//取消某行的选中- (void)deselectRow:(NSInteger)row;//判断某列是否被选中- (BOOL)isColumnSelected:(NSInteger)column;//判断某行是否被选中- (BOOL)isRowSelected:(NSInteger)row;//获取选中的列数@property (readonly) NSInteger numberOfSelectedColumns;//获取选中的行数@property (readonly) NSInteger numberOfSelectedRows;//获取某列的位置尺寸- (NSRect)rectOfColumn:(NSInteger)column;//获取某行的位置尺寸- (NSRect)rectOfRow:(NSInteger)row;//获取某个范围内的列- (NSIndexSet *)columnIndexesInRect:(NSRect)rect;//获取某个范围内的行- (NSRange)rowsInRect:(NSRect)rect;//获取包含某个点的列- (NSInteger)columnAtPoint:(NSPoint)point;//获取包含某个点的行- (NSInteger)rowAtPoint:(NSPoint)point;//获取某个cell的位置尺寸- (NSRect)frameOfCellAtColumn:(NSInteger)column row:(NSInteger)row;//获取某个位置的View，用于view-base- (nullable __kindof NSView *)viewAtColumn:(NSInteger)column row:(NSInteger)row makeIfNecessary:(BOOL)makeIfNecessary;//获取某行的视图 用于view-base- (nullable __kindof NSTableRowView *)rowViewAtRow:(NSInteger)row makeIfNecessary:(BOOL)makeIfNecessary;//获取某个View所在的行 用于view-base- (NSInteger)rowForView:(NSView *)view;//获取某个View所在的列 用于view-base- (NSInteger)columnForView:(NSView *)view;//创建一个用于渲染的View 用于view-base- (nullable __kindof NSView *)makeViewWithIdentifier:(NSString *)identifier owner:(nullable id)owner;//下面这些方法用来根据列表数据//开始更新- (void)beginUpdates NS_AVAILABLE_MAC(10_7);//结束更新- (void)endUpdates NS_AVAILABLE_MAC(10_7);//插入行- (void)insertRowsAtIndexes:(NSIndexSet *)indexes withAnimation:(NSTableViewAnimationOptions)animationOptions NS_AVAILABLE_MAC(10_7);//删除行- (void)removeRowsAtIndexes:(NSIndexSet *)indexes withAnimation:(NSTableViewAnimationOptions)animationOptions NS_AVAILABLE_MAC(10_7);//移动行- (void)moveRowAtIndex:(NSInteger)oldIndex toIndex:(NSInteger)newIndex NS_AVAILABLE_MAC(10_7);//隐藏行- (void)hideRowsAtIndexes:(NSIndexSet *)indexes withAnimation:(NSTableViewAnimationOptions)rowAnimation NS_AVAILABLE_MAC(10_11);//取消隐藏行- (void)unhideRowsAtIndexes:(NSIndexSet *)indexes withAnimation:(NSTableViewAnimationOptions)rowAnimation NS_AVAILABLE_MAC(10_11);//所有隐藏状态的行@property (readonly, copy) NSIndexSet *hiddenRowIndexes;
/*无论基于Cell还是基于View，这个方法都需要实现，用来设置列表的行数*/- (NSInteger)numberOfRowsInTableView:(NSTableView *)tableView;/*如果使用cell-base的TableView视图，这个方法是必须实现的，其为要渲染的cell提供数据*/- (nullable id)tableView:(NSTableView *)tableView objectValueForTableColumn:(nullable NSTableColumn *)tableColumn row:(NSInteger)row;/*这个函数当用户编辑了cell中的内容时会被调用，一般需要在其中进行数据源的修改*/- (void)tableView:(NSTableView *)tableView setObjectValue:(nullable id)object forTableColumn:(nullable NSTableColumn *)tableColumn row:(NSInteger)row;/*当用户修改了行排序规则时调用的回调*/- (void)tableView:(NSTableView *)tableView sortDescriptorsDidChange:(NSArray<NSSortDescriptor *> *)oldDescriptors;//下面这些方法全部与列表的数据拖拽相关- (nullable id <NSPasteboardWriting>)tableView:(NSTableView *)tableView pasteboardWriterForRow:(NSInteger)row;- (void)tableView:(NSTableView *)tableView draggingSession:(NSDraggingSession *)session willBeginAtPoint:(NSPoint)screenPoint forRowIndexes:(NSIndexSet *)rowIndexes NS_AVAILABLE_MAC(10_7);- (void)tableView:(NSTableView *)tableView draggingSession:(NSDraggingSession *)session endedAtPoint:(NSPoint)screenPoint operation:(NSDragOperation)operation NS_AVAILABLE_MAC(10_7);- (void)tableView:(NSTableView *)tableView updateDraggingItemsForDrag:(id <NSDraggingInfo>)draggingInfo NS_AVAILABLE_MAC(10_7);- (BOOL)tableView:(NSTableView *)tableView writeRowsWithIndexes:(NSIndexSet *)rowIndexes toPasteboard:(NSPasteboard *)pboard;- (NSDragOperation)tableView:(NSTableView *)tableView validateDrop:(id <NSDraggingInfo>)info proposedRow:(NSInteger)row proposedDropOperation:(NSTableViewDropOperation)dropOperation;- (BOOL)tableView:(NSTableView *)tableView acceptDrop:(id <NSDraggingInfo>)info row:(NSInteger)row dropOperation:(NSTableViewDropOperation)dropOperation;- (NSArray<NSString *> *)tableView:(NSTableView *)tableView namesOfPromisedFilesDroppedAtDestination:(NSURL *)dropDestination forDraggedRowsWithIndexes:(NSIndexSet *)indexSet;
//初始化方法，指定一个列ID- (instancetype)initWithIdentifier:(NSString *)identifier;//与此列关联的ID@property (copy) NSString *identifier;//关联的TableView@property (nullable, assign) NSTableView *tableView;//设置列宽度@property CGFloat width;//设置最小列宽度@property CGFloat minWidth;//设置最大列宽度@property CGFloat maxWidth;//设置类标题@property (copy) NSString *title;/*列标题视图 开发者可以对其进行修改需要注意，NSTableHeaderCell是继承自NSTextFieldCell*/@property (strong) __kindof NSTableHeaderCell *headerCell;//设置此列是否可以进行编辑@property (getter=isEditable) BOOL editable;//进行列尺寸的调整 以列标题视图的宽度为标准 - (void)sizeToFit;//提供了这个属性，会在列标题那里显示一个排序按钮 点击列标题后可以进行排序操作(会回调相关协议方法)@property (nullable, copy) NSSortDescriptor *sortDescriptorPrototype;//设置列尺寸的调整模式 枚举如下/*typedef NS_OPTIONS(NSUInteger, NSTableColumnResizingOptions) { NSTableColumnNoResizing = 0, //不允许进行宽度调整 //详见NSTabelView的columnAutoresizingStyle属性 NSTableColumnAutoresizingMask = ( 1 << 0 ), //使用tableView的column调整策略 NSTableColumnUserResizingMask = ( 1 << 1 ), //允许用户进行尺寸调整};*/@property NSTableColumnResizingOptions resizingMask;//设置列头的提示标题 当鼠标悬停在类标题上时 会显示此提示@property (nullable, copy) NSString *headerToolTip;//设置此列是否隐藏@property (getter=isHidden) BOOL hidden;//设置此列所有行的数据载体视图 如果不设置 默认为NSTextFieldCell@property (strong) id dataCell;//为TableView列表提供数据载体视图- (id)dataCellForRow:(NSInteger)row;
//选中的高亮风格/*typedef NS_ENUM(NSInteger, NSTableViewSelectionHighlightStyle) { //无高亮风格 NSTableViewSelectionHighlightStyleNone, //规则的高亮风格 NSTableViewSelectionHighlightStyleRegular = 0, //源列表风格 NSTableViewSelectionHighlightStyleSourceList = 1,};*/@property NSTableViewSelectionHighlightStyle selectionHighlightStyle;//是否强调@property(getter=isEmphasized) BOOL emphasized;//设置是否行组风格@property(getter=isGroupRowStyle) BOOL groupRowStyle;//是否选中状态@property(getter=isSelected) BOOL selected;//其前一行的选中状态@property(getter=isPreviousRowSelected) BOOL previousRowSelected;//其后一行的选中状态@property(getter=isNextRowSelected) BOOL nextRowSelected;//设置此行是否浮动@property(getter=isFloating) BOOL floating;//拖放拖动效果@property(getter=isTargetForDropOperation) BOOL targetForDropOperation;//拖放风格@property NSTableViewDraggingDestinationFeedbackStyle draggingDestinationFeedbackStyle;//设置拖放目标的缩进量@property CGFloat indentationForDropOperation;//背景色@property(copy) NSColor *backgroundColor;//子类重写下面方法来进行行容器视图的自定义//画背景色- (void)drawBackgroundInRect:(NSRect)dirtyRect;//画选中背景- (void)drawSelectionInRect:(NSRect)dirtyRect;//画分割线- (void)drawSeparatorInRect:(NSRect)dirtyRect;//绘制拖放时的用户反馈IU- (void)drawDraggingDestinationFeedbackInRect:(NSRect)dirtyRect;//列数@property(readonly) NSInteger numberOfColumns;//提供的访问特定视图的方法- (nullable id)viewAtColumn:(NSInteger)column;
//列表选择改变后发的通知APPKIT_EXTERN NSNotificationName NSTableViewSelectionDidChangeNotification;//列移动后发的通知APPKIT_EXTERN NSNotificationName NSTableViewColumnDidMoveNotification; //列宽度改变后发的通知APPKIT_EXTERN NSNotificationName NSTableViewColumnDidResizeNotification;//选择改变时发的通知 APPKIT_EXTERN NSNotificationName NSTableViewSelectionIsChangingNotification;
预览: