SCCollectionDelegate Class Reference

Collections events handling class. More...

#import <SCCollectionDelegate.h>

Inheritance diagram for SCCollectionDelegate:

Processing Objects
(void)	- processObject:collection:

Handling Collection Errors
(BOOL)	- collection:didDetectException:

Adding Objects Events Handlers
(void)	- collection:willAddObject:
(void)	- collection:willInsertObject:atIndex:
(void)	- collection:willSetObject:forKey:
(void)	- collection:willSetValue:forKey:
(void)	- collection:didFinishAddingObject:
(void)	- collection:didFinishInsertingObject:atIndex:
(void)	- collection:didFinishSettingObject:forKey:
(void)	- collection:didFinishSettingValue:forKey:

Removing Objects Events Handlers
(void)	- willRemoveAllObjectsFromCollection:
(void)	- collection:willRemoveObjectsOfClassName:
(void)	- collection:willRemoveObject:
(void)	- collection:willRemoveObjectAtIndex:
(void)	- collection:willRemoveObjectForKey:
(void)	- didFinishRemovingAllObjectsFromCollection:
(void)	- collection:didFinishRemovingObjectsOfClassName:
(void)	- collection:didFinishRemovingObject:
(void)	- collection:didFinishRemovingObjectAtIndex:
(void)	- collection:didFinishRemovingObjectForKey:

Sorting Objects Events Handlers
(void)	- collection:willSortAscending:sorter:
(void)	- collection:didFinishSortingAscending:sorter:

Replacing Objects Events Handlers
(void)	- collection:willReplaceObjectAtIndex:withObject:
(void)	- collection:willReplaceObjectsInRange:withCollection:
(void)	- collection:willReplaceObject:withObject:
(void)	- collection:didFinishReplacingObjectAtIndex:withObject:
(void)	- collection:didFinishReplacingObjectsInRange:withCollection:
(void)	- collection:didFinishReplacingObject:withObject:

Copying and Moving Objects Events Handlers
(void)	- collection:willExchangeObjectAtIndex:withObjectAtIndex:
(void)	- collection:didFinishExchangingObjectAtIndex:withObjectAtIndex:

Additional Inherited Members
Instance Methods inherited from SCObject
(id)	- initWithCoder:
(id)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(id)	- initWithDataDictionary:
(id)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(id)	- initWithStream:
(id)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(id< SCCollectioning >)	- copyObject
(SCComparisonResult)	- compareWithObject:
(BOOL)	- isEqual:
Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>
Instance Methods inherited from <SCCollectionDelegate>

Detailed Description

Collections events handling class.

Since

version 1.1.3

Implements the methods which are declared in the SCCollectionDelegate protocol.

Method Documentation

- (BOOL) collection:		(SCCollection *)	collection
didDetectException:		(SCCollectionException *)	exception

Tells the delegate that the collection detects the specified exception.

Parameters

collection	- erroneous collection
exception	- detected exception

Returns

YES if the collection must ignored the exception, otherwise NO

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishAddingObject:		(id)	object

Tells the delegate that the collection is finishing the adding the specified object.

Parameters

collection	- collection instance
object	- added object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishExchangingObjectAtIndex:		(SCIndex)	index
withObjectAtIndex:		(SCIndex)	destination

Tells the delegate that the collection is finished the exchanging objects at the specified indexes.

Parameters

collection	- collection instance
index	- index of the first string
destination	- index of the second string

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishInsertingObject:		(id)	object
atIndex:		(SCIndex)	index

Tells the delegate that the collection is finishing the inserting object at the specified index.

Parameters

collection	- collection instance
object	- inserted object
index	- index at which to insert object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishRemovingObject:		(id)	object

Tells the delegate that the collection is finishing the removing the specified object.

Parameters

collection	- collection instance
object	- removed string

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishRemovingObjectAtIndex:		(SCIndex)	index

Tells the delegate that the collection is finishing the removing object at the specified index.

Parameters

collection	- collection instance
index	- index of the removed object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishRemovingObjectForKey:		(NSString *)	key

Tells the delegate that the collection is finishing removing the object with the specified key.

Parameters

collection	- collection instance
key	- key of removed object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishRemovingObjectsOfClassName:		(NSString *)	name

Tells the delegate that the collection is finishing the removing all objects of the specified class name.

Parameters

collection	- collection instance
name	- class name

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishReplacingObject:		(id)	replaced
withObject:		(id)	object

Tells the delegate that the collection is finished the replacing specified object by using a given another object.

Parameters

collection	- collection instance
replaced	- replacing object
object	- replace the object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishReplacingObjectAtIndex:		(SCIndex)	index
withObject:		(id)	object

Tells the delegate that the collection is finished the replacing object at the specified index by using the specified object.

Parameters

collection	- collection instance
index	- index of replaced string
object	- replacing object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishReplacingObjectsInRange:		(NSRange)	range
withCollection:		(id)	source

Tells the delegate that the collection is finished the replacing objects in the specified range by using the objects from the specified collection.

Parameters

collection	- collection instance
range	- replaced objects range
source	- collection with the replacement objects

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishSettingObject:		(id)	object
forKey:		(NSString *)	key

Tells the delegate that the collection is finishing the setting the specified object with the specified key.

Parameters

collection	- collection instance
object	- added object
key	- key of the added object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishSettingValue:		(id)	value
forKey:		(NSString *)	key

Tells the delegate that the collection is finishing the setting the specified value with the specified key.

Parameters

collection	- collection instance
value	- added value
key	- key for the added value

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
didFinishSortingAscending:		(BOOL)	ascending
sorter:		(id<SCSorter>)	sorter

Tells the delegate that the collection is finished the sorting objects.

Parameters

collection	- collection instance
ascending	- YES for ascending direction, otherwise NO
sorter	- used data sorter

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willAddObject:		(id)	object

Tells the delegate that the collection is about to add the specified object.

Parameters

collection	- collection instance
object	- adding object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willExchangeObjectAtIndex:		(SCIndex)	index
withObjectAtIndex:		(SCIndex)	destination

Tells the delegate that the collection is about to exchange objects at the specified indexes.

Parameters

collection	- collection instance
index	- index of the first object
destination	- index of the second object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willInsertObject:		(id)	object
atIndex:		(SCIndex)	index

Tells the delegate that the collection is about to insert the object at the specified index.

Parameters

collection	- collection instance
object	- inserting object
index	- index at which to insert object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willRemoveObject:		(id)	object

Tells the delegate that the collection is about to remove the specified object.

Parameters

collection	- collection instance
object	- removing object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willRemoveObjectAtIndex:		(SCIndex)	index

Tells the delegate that the collection is about to remove the object at the specified index.

Parameters

collection	- collection instance
index	- index of the removing string

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willRemoveObjectForKey:		(NSString *)	key

Tells the delegate that the collection is about to remove the object with the specified key.

Parameters

collection	- collection instance
key	- key of the removed object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willRemoveObjectsOfClassName:		(NSString *)	name

Tells the delegate that the collection is about to remove all objects of the class with the specified name.

Parameters

collection	- collection instance
name	- class name

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willReplaceObject:		(id)	replaced
withObject:		(id)	object

Tells the delegate that the collection is about to replacing the specified object by using a given another object.

Parameters

collection	- collection instance
replaced	- replacing object
object	- replace the object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willReplaceObjectAtIndex:		(SCIndex)	index
withObject:		(id)	object

Tells the delegate that the collection is about to replace object with the specified index by using the specified object.

Parameters

collection	- collection instance
index	- index of replaced object
object	- replacement object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willReplaceObjectsInRange:		(NSRange)	range
withCollection:		(id)	source

Tells the delegate that the collection is about to replace the objects in the specified range by using the objects from the specified collection.

Parameters

collection	- collection instance
range	- replaced objects range
source	- collection with the replacement objects

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willSetObject:		(id)	object
forKey:		(NSString *)	key

Tells the delegate that the collection is about to set the specified object with the specified key.

Parameters

collection	- collection instance
object	- adding object
key	- key of the adding object

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willSetValue:		(id)	value
forKey:		(NSString *)	key

Tells the delegate that the collection is about to set the specified value with the specified key.

Parameters

collection	- collection instance
value	- setting value
key	- key of the setting value

Reimplemented from <SCCollectionDelegate>.

- (void) collection:		(SCCollection *)	collection
willSortAscending:		(BOOL)	ascending
sorter:		(id<SCSorter>)	sorter

Tells the delegate that the collection is about to sorting the objects.

Parameters

collection	- collection instance
ascending	- YES for ascending direction, otherwise NO
sorter	- using data sorter

Reimplemented from <SCCollectionDelegate>.

- (void) didFinishRemovingAllObjectsFromCollection:

(SCCollection *)

collection

Tells the delegate that the collection is finishing the deleting all objects.

Parameters

collection

- collection instance

Reimplemented from <SCCollectionDelegate>.

- (void) processObject:		(id)	object
collection:		(SCCollection *)	collection

Tells the delegate for the specified object from the specified collection.

Parameters

object	- current object
collection	- collection instance

Reimplemented from <SCCollectionDelegate>.

- (void) willRemoveAllObjectsFromCollection:

(SCCollection *)

collection

Tells the delegate that the collection is about to remove all objects.

Parameters

collection

- collection instance

Reimplemented from <SCCollectionDelegate>.

---

The documentation for this class was generated from the following files:

• SCCollectionDelegate.h
• SCCollectionDelegate.m