NSCollectionViewMBS.backgroundColors as NSColorMBS()

This property contains an array of NSColorMBS objects, representing the colors to use when drawing the background grid. Specifying an empty array or nil causes the collection view to use the default colors returned by the controlAlternatingRowBackgroundColors method.

When a background view is specified for the collection view, the colors in this property are ignored.

NSCollectionViewMBS.Constructor

See also:

• Constructor(Handle as Integer)
• Constructor(left as double, top as double, width as double, height as double)

NSCollectionViewMBS.Constructor(Handle as Integer)

Pass a valid handle to a NSTextField to initialize.

See also:

• Constructor
• Constructor(left as double, top as double, width as double, height as double)

NSCollectionViewMBS.Constructor(left as double, top as double, width as double, height as double)

See also:

• Constructor
• Constructor(Handle as Integer)

NSCollectionViewMBS.deleteItems(indexPaths() as NSIndexPathMBS)

// remove item at index

Var index As Integer = 1

// remove from data source
MainWindow.items.RemoveAt(index)

// remove also from view
Var items() As NSIndexPathMBS
items.Append NSIndexPathMBS.indexPathForItem(index)

MainWindow.collectionView.deleteItems items

indexPaths: A set of NSIndexPathMBS objects, each of which includes a section and item index corresponding to the insertion point of a single item. Specifying nil for this parameter raises an exception.

After removing items from your data source object, use this method to synchronize those changes with the collection view. Calling this method lets the collection view know that it must update its internal data structures and possibly update its visual appearance. In response, the collection view asks the layout object to update the positions of the remaining objects. If the layout object indicates that there are changes to the visible items, the collection view animates the affected items into place.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.deleteSections(sections as NSIndexSetMBS)

sections: An index set containing the indexes of the sections that you want to delete. This parameter must not be nil.

Use this method to delete entire sections and their contained items. Always update your data source object before calling this method. Calling this method kicks off an update (and possible animations) to delete the specified sections. Specifically, the collection view asks the layout object for the final layout attributes for any deleted sections and may also ask for updated layout attributes for any remaining sections. If the layout attributes of any visible items changed, those changes are animated into place.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.deselectAll

This method works only when the selectable and allowsEmptySelection properties are both true YES. If either property is set to false, this method quietly does nothing and any connected menu item is disabled.

This method consults the delegate object regarding the selection. Specifically, it calls the delegate’s shouldDeselectItems method to see if the items should be selected. For any items that are selected, it calls the didDeselectItems method.

NSCollectionViewMBS.deselectItems(indexPaths() as NSIndexPathMBS)

indexPaths: The index paths of the items you want to deselect.

Use this method to reduce the current selection. If you want to animate the deselection of the new items, call this method on the collection view’s animator proxy object instead. This method does not call any methods of the delegate object when making the selection.

NSCollectionViewMBS.frameForItem(Index as Integer) as NSRectMBS

index: The index of the collection view item.

Return the frame calculated by the receiver where it intends to place the subview for the NSCollectionViewItem at the given index. The rectangle is returned in the collection view’s coordinate system.

You can use this method in the draggingImageForItemsAtIndexes method to determine which views are in the visible portion of the enclosing scroll view.
Overriding this method will have no effect on the collection view’s subview layout.

See also:

• frameForItem(Index as Integer, numberOfItems as Integer) as NSRectMBS

NSCollectionViewMBS.frameForItem(Index as Integer, numberOfItems as Integer) as NSRectMBS

index: The index of the collection view item.

Returns the frame calculated by the receiver where it intends to place the subview for the NSCollectionViewItem at the given index. The rectangle is returned in the collection view’s coordinate system.

You can use this method in the draggingImageForItemsAtIndexes method to determine which views are in the visible portion of the enclosing scroll view.
Overriding this method will have no effect on the collection view’s subview layout.

See also:

• frameForItem(Index as Integer) as NSRectMBS

NSCollectionViewMBS.indexPathForItem(indexPath as NSCollectionViewItemMBS) as NSIndexPathMBS

Returns the item’s index path or nil if the item is not in the collection view.

See also:

• indexPathForItem(x as double, y as double) as NSIndexPathMBS

NSCollectionViewMBS.indexPathForItem(x as double, y as double) as NSIndexPathMBS

// remove item at index

Var index As Integer = 1

// remove from data source
MainWindow.items.RemoveAt(index)

// remove also from view
Var items() As NSIndexPathMBS
items.Append NSIndexPathMBS.indexPathForItem(index)

MainWindow.collectionView.deleteItems items

Returns the item’s index path or nil if the item is not in the collection view.

See also:

• indexPathForItem(indexPath as NSCollectionViewItemMBS) as NSIndexPathMBS

NSCollectionViewMBS.indexPathsForVisibleItems as NSIndexPathMBS()

The set of NSIndexPathMBS objects corresponding to the currently visible items.

The index paths returned by this method belong to items that are active and currently being managed by the collection view. As a result, the returned set may include index paths for items that are outside of the collection view’s actual visible rectangle. For example, it may contain index paths for items that were recently visible but have since been scrolled out of view. To test whether an item is visible, check to see if its frame rectangle intersects the visibleRect of the collection view.

NSCollectionViewMBS.indexPathsForVisibleSupplementaryElementsOfKind(elementKind as String) as NSIndexPathMBS()

elementKind: The kind of the supplementary views you want returned. The layout object defines the kinds of supplementary views it supports. This parameter must not be nil.

Return the set of NSIndexPathMBS objects. The returned array may be empty.

The index paths returned by this method correspond to supplementary views that are active and currently being managed by the collection view. The set may include index paths for views that are outside of the collection view’s actual visible rectangle. For example, it might contain index paths for views that were recently visible but have since been scrolled out of the visible rectangle. To test whether a view is actually visible, check to see if its frame rectangle intersects the visibleRect of the collection view.

NSCollectionViewMBS.insertItems(indexPaths() as NSIndexPathMBS)

indexPaths: A set of NSIndexPathMBS objects, each of which includes a section and item index corresponding to the insertion point of a single item. Specifying nil for this parameter raises an exception.

After adding new items to your data source object, use this method to synchronize those changes with the collection view. Calling this method lets the collection view know that it must update its internal data structures and possibly update its visual appearance. In response, the collection view asks the layout object for information about the new objects. If the layout object indicates that the new items should appear onscreen, the collection view asks the data source to provide the appropriate content, animating that content into position as needed.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.insertSections(sections as NSIndexSetMBS)

sections: An index set containing the indexes at which you want to insert new sections. This parameter must not be nil.

This method tells the collection view to insert the specified sections and update itself. Always update your data source object before calling this method. Calling this method kicks off an update (and possible animations) to add the new sections. Specifically, the collection view asks the layout object for any updated layout attributes related to the new sections or any existing sections. If the layout attributes of any visible items changed, those changes are animated into place.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.item(index as Integer) as NSCollectionViewItemMBS

The item for the specified index path or nil if no item is available.

For efficiency, the collection view does not create items until they are needed, and usually it creates them only when they need to be displayed onscreen. If the collection view does not currently have an item for the specified index path, because that item would be positioned offscreen, this method returns nil.

See also:

• item(indexPath as NSIndexPathMBS) as NSCollectionViewItemMBS

NSCollectionViewMBS.item(indexPath as NSIndexPathMBS) as NSCollectionViewItemMBS

The item for the specified index path or nil if no item is available.

For efficiency, the collection view does not create items until they are needed, and usually it creates them only when they need to be displayed onscreen. If the collection view does not currently have an item for the specified index path, because that item would be positioned offscreen, this method returns nil.

See also:

• item(index as Integer) as NSCollectionViewItemMBS

NSCollectionViewMBS.layoutAttributesForItem(indexPath as NSIndexPathMBS) as NSCollectionViewLayoutAttributesMBS

The layout attributes of the item or nil if no item exists at the specified path.

This method updates the layout information as needed before returning the specified attributes. Always use this method to retrieve the layout attributes for items in the collection view. Do not query the layout object directly.

NSCollectionViewMBS.layoutAttributesForSupplementaryElementOfKind(kind as String, indexPath as NSIndexPathMBS) as NSCollectionViewLayoutAttributesMBS

kind: The kind of the supplementary view whose attributes you want. The layout object defines the kinds of supplementary views it supports. This parameter must not be nil.
indexPath: The index path of the supplementary view. Normally, this path

Returns the layout attributes of the supplementary view or nil if no item exists at the specified path.

This method updates the layout information as needed before returning the specified attributes. Always use this method to retrieve the layout attributes for supplementary views in the collection view. Do not query the layout object directly.

NSCollectionViewMBS.makeItem(indexPath as NSIndexPathMBS) as NSCollectionViewItemMBS

indexPath: The index path specifying the location of the item. The data source object receives this information in its itemForRepresentedObjectAtIndexPath method and you should just pass it along.

Some examples using this method:

• /MacControls/NSCollectionView Test

NSCollectionViewMBS.makeSupplementaryViewOfKind(elementKind as String, indexPath as NSIndexPathMBS) as NSCollectionViewSectionHeaderViewMBS

elementKind: The kind of supplementary view to create. This value is defined by the layout object. This parameter must not be an empty string or nil.
identifier: The reuse identifier for the specified item. This is the identifier you specified when registering the supplementary view. This parameter must not be nil.
indexPath: The index path specifying the location of the supplementary view. The data source object receives this information in its viewForSupplementaryElementOfKind method and you should just pass it along.

Returns a view that adopts the NSCollectionViewElement protocol, e.g. a NSCollectionViewSectionHeaderViewMBS object.

This method looks for a recycled supplementary view of the specified type and returns it if one exists. If one does not exist, it creates it one.

NSCollectionViewMBS.moveItem(indexPath as NSIndexPathMBS, toIndexPath as NSIndexPathMBS)

indexPath: The index path of the item that you want to move. This parameter must not be nil.
newIndexPath: The index path of the item’s new location. This parameter must not be nil.

After rearranging items in your data source object, use this method to synchronize those changes with the collection view. Calling this method lets the collection view know that it must update its internal data structures and possibly update its visual appearance. You can move the item to a different section or to a new location in the same section. The collection view updates the layout as needed to account for the move, animating cells into position in response.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.moveSection(section as Integer, toSection as Integer)

section: The index of the section that you want to move.
newSection: The new index at which to insert the section.

Use this method to reorganize sections and their contained items. Always update your data source object before calling this method. Calling this method kicks off an update (and possible animations) to move the specified section to its new location. Specifically, the collection view asks the layout object for any updated layout attributes related to the new sections or any existing sections. If the layout attributes of any visible items changed, those changes are animated into place.

When inserting or deleting multiple sections and items, you can animate all of your changes at once using the performBatchUpdates method.

NSCollectionViewMBS.numberOfItemsInSection(section as Integer) as Integer

section: The index of the section whose item count you want. This index is 0-based.

Returns the number of items in the section.

Use this method to get the number of items currently displayed by the collection view for the specified section. Do not call the methods of the data source to get this information.

NSCollectionViewMBS.reloadData

Call this method when the data in your data source object changes or when you want to force the collection view to update its contents. When you call this method, the collection view discards any currently visible items and views and redisplays them. For efficiency, the collection view displays only the items and supplementary views that are visible after reloading the data. If the collection view’s size changes as a result of reloading the data, the collection view adjusts its scrolling offsets accordingly.
Do not call this method in the middle of animation blocks where items are being inserted or deleted. The methods used to insert and delete items automatically update the collection view’s contents.

NSCollectionViewMBS.reloadItems(indexPaths() as NSIndexPathMBS)

indexPaths: The index paths of the specific items that you want to reload. Specifying nil for this parameter raises an exception.

Call this method to update specific items in your collection view. You call this method when the underlying data for those items changes and you want to update the visual appearance of those items. When you call this method, the collection view discards the specified items and asks your data source to provide new ones. For efficiency, the collection view requests only the items that are visible.

NSCollectionViewMBS.reloadSections(sections as NSIndexSetMBS)

sections: The indexes of the sections that you want to reload. Specifying nil for this parameter raises an exception.

Call this method when the data for the specified sections changes or when you want to force the appearance of those sections to be updated. When you call this method, the collection view discards visible elements in the section along with any cached attributes for those elements. For efficiency, it then asks the layout object to provide fresh attributes for only the visible items and views and requests new views for those elements.
Do not call this method in the middle of animation blocks where items are being inserted or deleted. The methods used to insert and delete items automatically update the collection view’s contents.

NSCollectionViewMBS.scrollToItems(indexPaths() as NSIndexPathMBS, scrollPosition as Integer)

Var collectionView as NSCollectionViewMBS

Var itemPaths() As NSIndexPathMBS
itemPaths.Append NSIndexPathMBS.indexPathForItem(0)

collectionView.scrollToItems(itemPaths, NSCollectionViewMBS.NSCollectionViewScrollPositionTop)

indexPaths: The index paths of the items. The layout attributes of these items define the bounding box that needs to be scrolled onscreen.
scrollPosition: The options for scrolling the bounding box of the specified items into view. You may combine one vertical and one horizontal scrolling option when calling this method. Specifying more than one option for either the vertical or horizontal directions raises an exception.

To animate the scrolling operation, call this method on the collection view’s animator proxy object instead.

NSCollectionViewMBS.selectAll

This method works only when the selectable and allowsMultipleSelection properties are both true. If either property is set to false, this method quietly does nothing and any connected menu item is disabled.

This method consults the delegate object regarding the selection. Specifically, it calls the delegate’s shouldSelectItems method to see if the items should be selected. For any items that are selected, it calls the didSelectItems method.

NSCollectionViewMBS.selection as NSIndexPathMBS()

This property reflects the index paths of the currently selected items, where each index path contains a section number and an index number for the item in that section. This property is updated automatically when the user selects items interactively. You can also change the selection programmatically by assigning a new value to this property. To animate changes to the selection, call this method on the collection view’s animator proxy object instead.
It is a programmer error to specify an index path that does not refer to a valid item in the data source. If you specify an invalid index path, this method raises an exception.
This property is key-value observable. Other methods that modify the selection automatically update this property.

NSCollectionViewMBS.selectItems(indexPaths() as NSIndexPathMBS, scrollPosition as Integer)

indexPaths: The index paths of the items you want to select.
scrollPosition: The options for scrolling the newly selected items into view. You may combine one vertical and one horizontal scrolling option when calling this method. Specifying more than one option for either the vertical or horizontal directions raises an exception.

Use this method to extend the current selection. If you want to animate the selection of the new items, call this method on the collection view’s animator proxy object instead. This method does not call any methods of the delegate object when making the selection.

NSCollectionViewMBS.setBackgroundColors(Colors() as NSColorMBS = nil)

This property contains an array of NSColorMBS objects, representing the colors to use when drawing the background grid. Specifying an empty array or nil causes the collection view to use the default colors returned by the controlAlternatingRowBackgroundColors method.

When a background view is specified for the collection view, the colors in this property are ignored.

NSCollectionViewMBS.setDraggingSourceOperationMask(mask as integer, local as boolean)

mask: The types of drag operations allowed.
isLocal: If true, mask applies when the drag destination object is in the same application as the receiver; if false, mask applies when the destination object is outside the receiver's application.

By default, draggingSourceOperationMaskForLocal returns NSDragOperationEvery when isLocal is true and NSDragOperationNone when isLocal is false.

Available in Mac OS X v10.5 and later.

NSCollectionViewMBS.setSelection(indexPaths() as NSIndexPathMBS)

NSCollectionViewMBS.supplementaryViewForElementKind(elementKind as String, indexPath as NSIndexPathMBS) as NSCollectionViewSectionHeaderViewMBS

elementKind: The kind of the supplementary views you want returned. The layout object defines the kinds of supplementary views it supports. This parameter must not be nil.
indexPath: The index path whose supplementary view you want.

Returns the view for the specified index path or nil if no view is available.

For efficiency, the collection view does not create supplementary views until they are needed. Typically, views are created only when they need to be displayed onscreen. If the collection view does not currently have a supplementary view for the specified index path, because that view would be positioned offscreen, this method returns nil.

NSCollectionViewMBS.toggleSectionCollapse(sender as NSViewMBS)

Please pass the button clicked as sender.

NSCollectionViewMBS.visibleItems as NSCollectionViewItemMBS()

An array of NSCollectionViewItemMBS objects. The returned array may be empty.

The items returned by this method represent the ones that are active and currently being managed by the collection view. This array may contain items that are outside of the collection view’s actual visible rectangle. For example, it may contain items that were recently visible but have since been scrolled out of view. To test whether an item is actually visible, check to see if its frame rectangle intersects the visibleRect of the collection view.

NSCollectionViewMBS.visibleSupplementaryViewsOfKind(elementKind as String) as NSViewMBS()

elementKind: The kind of the supplementary views you want returned. The layout object defines the kinds of supplementary views it supports. This parameter must not be nil.

Returns an array of view objects. The returned array may be empty.

The views returned by this method represent the ones that are active and are currently being managed by the collection view. The array may contain supplementary views that are outside of the collection view’s actual visible rectangle. For example, it might contain views that were recently visible but have since been scrolled out of the visible rectangle. To test whether a view is actually visible, check to see if its frame rectangle intersects the visibleRect of the collection view.