NGridProxyDataSource Protocol Reference

Conforms to NSObject
Declared in NGridProxyDataSource.h

Overview

The NGridProxyDataSource protocol defines methods that should be implemented to provide the data and behavior to grid. Proxy data source is used as the data mediator. It is responsible for sorting, filtering, formatting etc.

– gridView:cellWithCoordinate: required method

Asks the proxy data source to return the cell by the coordinate in the grid view.

- (NGridCell *)gridView:(NGridView *)gridView cellWithCoordinate:(NGridCellCoordinate *)cellCoordinate

Parameters

gridView

Related grid view object.
cellCoordinate

Coordinate of the needed cell.

Declared In

NGridProxyDataSource.h

– gridViewRowCount: required method

Asks the proxy data source to return the row count in the grid view.

- (NSInteger)gridViewRowCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewColumnCount: required method

Asks the proxy data source to return the column count in the grid view.

- (NSInteger)gridViewColumnCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewRowHeaderCount: required method

Asks the proxy data source to return the row header count (count of header columns).

- (NSInteger)gridViewRowHeaderCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewColumnHeaderCount: required method

Asks the proxy data source to return the column header count (count of header rows).

- (NSInteger)gridViewColumnHeaderCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:cellKeyByCoordinate: required method

Asks the proxy data source to convert the cell coordinate to the cell key.

- (NGridCellKey *)gridView:(NGridView *)gridView cellKeyByCoordinate:(NGridCellCoordinate *)cellCoordinate

Parameters

gridView

Related grid view object.
cellCoordinate

Coordinate of the cell.

Declared In

NGridProxyDataSource.h

– gridView:rowKeyByCoordinate: required method

Asks the proxy data source to convert the row key to the row coordinate.

- (NSInteger)gridView:(NGridView *)gridView rowKeyByCoordinate:(NSInteger)rowCoordinate

Parameters

gridView

Related grid view object.
rowCoordinate

Coordinate of the row in the grid view.

Declared In

NGridProxyDataSource.h

– gridView:columnKeyByCoordinate: required method

Asks the proxy data source to convert the column key to the column coordinate.

- (NSInteger)gridView:(NGridView *)gridView columnKeyByCoordinate:(NSInteger)columnCoordinate

Parameters

gridView

Related grid view object.
columnCoordinate

Coordinate of column in the grid view.

Declared In

NGridProxyDataSource.h

– gridView:cellCoordinateByKey: required method

Asks the proxy data source to convert the cell key to the cell coordinate.

- (NGridCellCoordinate *)gridView:(NGridView *)gridView cellCoordinateByKey:(NGridCellKey *)cellKey

Parameters

gridView

Related grid view object.
cellKey

Key of the cell.

Declared In

NGridProxyDataSource.h

– gridView:rowCoordinateByKey: required method

Asks the proxy data source to convert the row coordinate to the row key.

- (NSInteger)gridView:(NGridView *)gridView rowCoordinateByKey:(NSInteger)rowKey

Parameters

gridView

Related grid view object.
rowKey

Key of the row in the data source.

Declared In

NGridProxyDataSource.h

– gridView:columnCoordinateByKey: required method

Asks the proxy data source to convert the column coordinate to the row key.

- (NSInteger)gridView:(NGridView *)gridView columnCoordinateByKey:(NSInteger)columnKey

Parameters

gridView

Related grid view object.
columnKey

Key of the column in the data source.

Declared In

NGridProxyDataSource.h

– dataSource required method

Asks the proxy data source to return the general data source. This data source is used as data provider to proxy data source. See NGridDataSource protocol specifications.

- (id<NGridDataSource>)dataSource

Declared In

NGridProxyDataSource.h

– setDataSource: required method

Asks the proxy data source to set general data source. This data source is used as data provider to proxy data source. See NGridDataSource protocol specifications.

- (void)setDataSource:(id<NGridDataSource>)dataSource

Parameters

dataSource

Data source object.

Declared In

NGridProxyDataSource.h

– cellUnionSetForGridView:

Asks the proxy data source to return the cell union set.

- (NGridCellUnionSet *)cellUnionSetForGridView:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewCanSelectRowsAndColumns:

Asks the proxy data source whether selection is allowed in the grid view. Return YES to enable selection.

- (BOOL)gridViewCanSelectRowsAndColumns:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewExpandAllRows:

Asks the proxy data source to expand all rows in the grid view.

- (void)gridViewExpandAllRows:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewCollapseAllRows:

Asks the proxy data source to collapse all rows in the grid view.

- (void)gridViewCollapseAllRows:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewExpandAllColumns:

Asks the proxy data source to expand all columns in the grid view.

- (void)gridViewExpandAllColumns:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewCollapseAllColumns:

Asks the proxy data source to collapse all columns in the grid view.

- (void)gridViewCollapseAllColumns:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:expandRowWithCoordinate:

Asks the proxy data source to prepare data source to expand the row with a key.

- (void)gridView:(NGridView *)gridView expandRowWithCoordinate:(NSInteger)rowCoordinate

Parameters

gridView

Related grid view object.
rowCoordinate

Coordinate of the row to expand.

Declared In

NGridProxyDataSource.h

– gridView:collapseRowWithCoordinate:

Asks the proxy data source to prepare data source to collapse the row with a key.

- (void)gridView:(NGridView *)gridView collapseRowWithCoordinate:(NSInteger)rowCoordinate

Parameters

gridView

Related grid view object.
rowCoordinate

Coordinate of the row to collapse.

Declared In

NGridProxyDataSource.h

– gridView:expandColumnWithCoordinate:

Asks the proxy data source to prepare data source to expand the column with a key.

- (void)gridView:(NGridView *)gridView expandColumnWithCoordinate:(NSInteger)columnCoordinate

Parameters

gridView

Related grid view object.
columnCoordinate

Coordinate of the column to expand.

Declared In

NGridProxyDataSource.h

– gridView:collapseColumnWithCoordinate:

Asks the proxy data source to prepare data source to collapse the column with a key.

- (void)gridView:(NGridView *)gridView collapseColumnWithCoordinate:(NSInteger)columnCoordinate

Parameters

gridView

Related grid view object.
columnCoordinate

Coordinate of the column to collapse.

Declared In

NGridProxyDataSource.h

– gridView:isRowWithKeyExpanded:

Asks the proxy data source if the row with key is expanded.

- (BOOL)gridView:(NGridView *)gridView isRowWithKeyExpanded:(NSInteger)rowKey

Parameters

gridView

Related grid view object.
rowKey

Key of the row.

Declared In

NGridProxyDataSource.h

– gridView:isColumnWithKeyExpanded:

Asks the proxy data source if the column with key is expanded.

- (BOOL)gridView:(NGridView *)gridView isColumnWithKeyExpanded:(NSInteger)columnKey

Parameters

gridView

Related grid view object.
columnKey

Key of the column.

Declared In

NGridProxyDataSource.h

– gridViewIsRowSparklinesShown:

Asks the proxy data source to return the row sparkline visibility.

- (BOOL)gridViewIsRowSparklinesShown:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewIsColumnSparklinesShown:

Asks the proxy data source to return the column sparkline visibility.

- (BOOL)gridViewIsColumnSparklinesShown:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:setRowSpartlinesShown:

Asks the proxy data source to set the row sparkline visibility.

- (void)gridView:(NGridView *)gridView setRowSpartlinesShown:(BOOL)isShown

Parameters

gridView

Related grid view object.
isShown

YES if you want to show the row sparklines.

Declared In

NGridProxyDataSource.h

– gridView:setColumnSpartlinesShown:

Asks the proxy data source to set the column sparkline visibility.

- (void)gridView:(NGridView *)gridView setColumnSpartlinesShown:(BOOL)isShown

Parameters

gridView

Related grid view object.
isShown

YES if you want to show the column sparklines.

Declared In

NGridProxyDataSource.h

– gridView:freezeRowWithKey:

Asks the proxy data source to freeze the row by the key.

- (void)gridView:(NGridView *)gridView freezeRowWithKey:(NSInteger)rowKey

Parameters

gridView

Related grid view object.
rowKey

Key of the row to freeze.

Declared In

NGridProxyDataSource.h

– gridView:freezeColumnWithKey:

Asks the proxy data source to freeze the column by the key.

- (void)gridView:(NGridView *)gridView freezeColumnWithKey:(NSInteger)columnKey

Parameters

gridView

Related grid view object.
columnKey

Key of the column to freeze.

Declared In

NGridProxyDataSource.h

– gridView:freezeRowWithKey:toIndex:

Asks the proxy data source to freeze row by the key.

- (void)gridView:(NGridView *)gridView freezeRowWithKey:(NSInteger)rowKey toIndex:(NSInteger)index

Parameters

gridView

Related grid view object.
rowKey

Key of row to freeze.
index

Specified the index of frozen row.

Declared In

NGridProxyDataSource.h

– gridView:freezeColumnWithKey:toIndex:

Asks the proxy data source to freeze column by the key.

- (void)gridView:(NGridView *)gridView freezeColumnWithKey:(NSInteger)columnKey toIndex:(NSInteger)index

Parameters

gridView

Related grid view object.
columnKey

Key of column to freeze.
index

Specified the index of frozen column.

Declared In

NGridProxyDataSource.h

– gridView:unfreezeRowWithKey:

Asks the proxy data source to unfreeze the row by the key.

- (void)gridView:(NGridView *)gridView unfreezeRowWithKey:(NSInteger)rowKey

Parameters

gridView

Related grid view object.
rowKey

Key of the row to unfreeze.

Declared In

NGridProxyDataSource.h

– gridView:unfreezeColumnWithKey:

Asks the proxy data source to unfreeze the column by the key.

- (void)gridView:(NGridView *)gridView unfreezeColumnWithKey:(NSInteger)columnKey

Parameters

gridView

Related grid view object.
columnKey

Key of the column to unfreeze.

Declared In

NGridProxyDataSource.h

– gridView:isRowWithKeyFrozen:

Asks the proxy data source if the row with key is frozen.

- (BOOL)gridView:(NGridView *)gridView isRowWithKeyFrozen:(NSInteger)rowKey

Parameters

gridView

Related grid view object.
rowKey

Key of the row.

Declared In

NGridProxyDataSource.h

– gridView:isColumnWithKeyFrozen:

Asks the proxy data source if the column with key is frozen.

- (BOOL)gridView:(NGridView *)gridView isColumnWithKeyFrozen:(NSInteger)columnKey

Parameters

gridView

Related grid view object.
columnKey

Key of the column.

Declared In

NGridProxyDataSource.h

– gridView:keyForFrozenRowWithIndex:

Asks the proxy data source to return the key of the frozen row.

- (NSInteger)gridView:(NGridView *)gridView keyForFrozenRowWithIndex:(NSInteger)index

Parameters

gridView

Related grid view object.
index

Index of the frozen row.

Declared In

NGridProxyDataSource.h

– gridView:keyForFrozenColumnWithIndex:

Asks the proxy data source to return the key of the frozen column.

- (NSInteger)gridView:(NGridView *)gridView keyForFrozenColumnWithIndex:(NSInteger)index

Parameters

gridView

Related grid view object.
index

Index of the frozen column.

Declared In

NGridProxyDataSource.h

– gridViewFrozenRowCount:

Asks the proxy data source to return the number of the frozen row.

- (NSInteger)gridViewFrozenRowCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewFrozenColumnCount:

Asks the proxy data source to return the number of the frozen column.

- (NSInteger)gridViewFrozenColumnCount:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:setSortSettings:

Asks the proxy data source to set the sort settings.

- (void)gridView:(NGridView *)gridView setSortSettings:(id<NGridSortSettingsProtocol>)settings

Parameters

gridView

Related grid view object.
settings

Sort settings.

Declared In

NGridProxyDataSource.h

– gridViewSortSettings:

Asks the proxy data source to return the sort settings.

- (id<NGridSortSettingsProtocol>)gridViewSortSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewRemoveSortSettings:

Asks the proxy data source to remove the sort settings.

- (void)gridViewRemoveSortSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:setFilterSettings:

Asks the proxy data source to set the filter settings.

- (void)gridView:(NGridView *)gridView setFilterSettings:(id<NGridFilterSettingsProtocol>)settings

Parameters

gridView

Related grid view object.
settings

Filter settings.

Declared In

NGridProxyDataSource.h

– gridViewFilterSettings:

Asks the proxy data source to return the filter settings.

- (id<NGridFilterSettingsProtocol>)gridViewFilterSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewRemoveFilterSettings:

Asks the proxy data source to remove the filter settings.

- (void)gridViewRemoveFilterSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridView:setHighlightSettings:

Asks the proxy data source to set the highlight settings.

- (void)gridView:(NGridView *)gridView setHighlightSettings:(id<NGridHighlightSettingsProtocol>)settings

Parameters

gridView

Related grid view object.
settings

Highlight settings.

Declared In

NGridProxyDataSource.h

– gridViewHighlightSettings:

Asks the proxy data source to return the highlight settings.

- (id<NGridHighlightSettingsProtocol>)gridViewHighlightSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewRemoveHighlightSettings:

Asks the proxy data source to remove the highlight settings.

- (void)gridViewRemoveHighlightSettings:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewWillReloadData:

Sent to the proxy data source just before the grid view begins reloading data.

- (void)gridViewWillReloadData:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h

– gridViewDidReloadData:

Sent to the proxy data source after the grid view reloads data.

- (void)gridViewDidReloadData:(NGridView *)gridView

Parameters

gridView

Related grid view object.

Declared In

NGridProxyDataSource.h