org.rococoa.cocoa.appkit
Class NSArrayController

java.lang.Object
  org.rococoa.cocoa.foundation.NSObject
      org.rococoa.cocoa.appkit.NSController
          org.rococoa.cocoa.appkit.NSObjectController
              org.rococoa.cocoa.appkit.NSArrayController

All Implemented Interfaces:

NSCoding, NSObject, ObjCObject

Direct Known Subclasses:

NSDictionaryController

public abstract class NSArrayController
extends NSObjectController

This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static class	NSArrayController.__arrayControllerFlags
static class	NSArrayController._class_

Nested classes/interfaces inherited from class org.rococoa.cocoa.appkit.NSObjectController

NSObjectController.__objectControllerFlags

Nested classes/interfaces inherited from class org.rococoa.cocoa.appkit.NSController

NSController.__bindingsControllerFlags

Nested classes/interfaces inherited from interface org.rococoa.cocoa.foundation.protocols.NSCoding

NSCoding._static_

Nested classes/interfaces inherited from interface org.rococoa.cocoa.foundation.protocols.NSObject

NSObject._static_

Constructor Summary

NSArrayController()

Method Summary

abstract void	add(ObjCObject sender) overridden to add a new object to the content objects and to the arranged objects Original signature : -(void)add:(id) native declaration : NSArrayController.h:101
abstract void	addObject(ObjCObject object) overridden to add to the content objects and to the arranged objects if all filters currently applied are matched Original signature : -(void)addObject:(id) native declaration : NSArrayController.h:110
abstract void	addObjects(NSArray objects) Original signature : -(void)addObjects:(NSArray*) native declaration : NSArrayController.h:111
abstract boolean	addSelectedObjects(NSArray objects) Original signature : -(BOOL)addSelectedObjects:(NSArray*) native declaration : NSArrayController.h:98
abstract boolean	addSelectionIndexes(NSIndexSet indexes) Original signature : -(BOOL)addSelectionIndexes:(NSIndexSet*) native declaration : NSArrayController.h:93
static NSArrayController	alloc()
abstract boolean	alwaysUsesMultipleValuesMarker() Original signature : -(BOOL)alwaysUsesMultipleValuesMarker native declaration : NSArrayController.h:84
abstract NSObject	arrangedObjects() array of all displayed objects (after sorting and potentially filtering) Original signature : -(id)arrangedObjects native declaration : NSArrayController.h:71
abstract NSArray	arrangeObjects(NSArray objects) returns objects to be arranged in the user interface for the content object array objects - method can be overridden to use a different kind of sort mechanism or to filter the display objects Original signature : -(NSArray*)arrangeObjects:(NSArray*) native declaration : NSArrayController.h:70
abstract boolean	automaticallyRearrangesObjects() Original signature : -(BOOL)automaticallyRearrangesObjects native declaration : NSArrayController.h:51
abstract NSArray	automaticRearrangementKeyPaths() computes the array of key paths that trigger automatic rearranging from the sort descriptors and filter predicates; subclasses may override this method to customize the default behavior (for example if additional arrangement criteria are used in custom implementations of -rearrangeObjects) Original signature : -(NSArray*)automaticRearrangementKeyPaths native declaration : NSArrayController.h:53
abstract boolean	avoidsEmptySelection() Original signature : -(BOOL)avoidsEmptySelection native declaration : NSArrayController.h:74
abstract boolean	canInsert() can be used in bindings controlling the enabling of buttons, for example Original signature : -(BOOL)canInsert native declaration : NSArrayController.h:104
abstract boolean	canSelectNext() Original signature : -(BOOL)canSelectNext native declaration : NSArrayController.h:107
abstract boolean	canSelectPrevious() Original signature : -(BOOL)canSelectPrevious native declaration : NSArrayController.h:108
abstract boolean	clearsFilterPredicateOnInsertion() Original signature : -(BOOL)clearsFilterPredicateOnInsertion native declaration : NSArrayController.h:67
abstract void	didChangeArrangementCriteria() invoked by the controller itself when any criteria for arranging objects change (sort descriptors or filter predicates) to reset the key paths for automatic rearranging; subclasses should invoke this method if additional arrangement criteria are used in custom implementations of -rearrangeObjects and those criteria change Original signature : -(void)didChangeArrangementCriteria native declaration : NSArrayController.h:54
abstract NSPredicate	filterPredicate() Original signature : -(NSPredicate*)filterPredicate native declaration : NSArrayController.h:62
static NSArrayController._class_	getNSClass()
abstract void	insert(ObjCObject sender) Original signature : -(void)insert:(id) native declaration : NSArrayController.h:103
abstract void	insertObject_atArrangedObjectIndex(ObjCObject object, NSUInteger index) inserts into the content objects and the arranged objects (as specified by index in the arranged objects) - will raise an exception if the object does not match all filters currently applied Original signature : -(void)insertObject:(id) atArrangedObjectIndex:(NSUInteger) native declaration : NSArrayController.h:112
abstract void	insertObjects_atArrangedObjectIndexes(NSArray objects, NSIndexSet indexes) Original signature : -(void)insertObjects:(NSArray*) atArrangedObjectIndexes:(NSIndexSet*) native declaration : NSArrayController.h:113
static NSArrayController	new_()
abstract boolean	preservesSelection() Original signature : -(BOOL)preservesSelection native declaration : NSArrayController.h:76
abstract void	rearrangeObjects() triggers rearranging the content objects for the user interface, including sorting and filtering; subclasses can override and invoke this method if any parameter that affects the arranged objects changes Original signature : -(void)rearrangeObjects native declaration : NSArrayController.h:47
abstract void	remove(ObjCObject sender) overridden to remove the selected objects Original signature : -(void)remove:(id) native declaration : NSArrayController.h:102
abstract void	removeObject(ObjCObject object) removes from the content objects and the arranged objects (if currently contained) Original signature : -(void)removeObject:(id) native declaration : NSArrayController.h:116
abstract void	removeObjectAtArrangedObjectIndex(NSUInteger index) removes from the content objects and the arranged objects (as specified by index in the arranged objects) Original signature : -(void)removeObjectAtArrangedObjectIndex:(NSUInteger) native declaration : NSArrayController.h:114
abstract void	removeObjects(NSArray objects) Original signature : -(void)removeObjects:(NSArray*) native declaration : NSArrayController.h:117
abstract void	removeObjectsAtArrangedObjectIndexes(NSIndexSet indexes) Original signature : -(void)removeObjectsAtArrangedObjectIndexes:(NSIndexSet*) native declaration : NSArrayController.h:115
abstract boolean	removeSelectedObjects(NSArray objects) Original signature : -(BOOL)removeSelectedObjects:(NSArray*) native declaration : NSArrayController.h:99
abstract boolean	removeSelectionIndexes(NSIndexSet indexes) Original signature : -(BOOL)removeSelectionIndexes:(NSIndexSet*) native declaration : NSArrayController.h:94
abstract NSArray	selectedObjects() Original signature : -(NSArray*)selectedObjects native declaration : NSArrayController.h:97
abstract NSUInteger	selectionIndex() Original signature : -(NSUInteger)selectionIndex native declaration : NSArrayController.h:92
abstract NSIndexSet	selectionIndexes() Original signature : -(NSIndexSet*)selectionIndexes native declaration : NSArrayController.h:90
abstract void	selectNext(ObjCObject sender) Original signature : -(void)selectNext:(id) native declaration : NSArrayController.h:105
abstract void	selectPrevious(ObjCObject sender) Original signature : -(void)selectPrevious:(id) native declaration : NSArrayController.h:106
abstract boolean	selectsInsertedObjects() Original signature : -(BOOL)selectsInsertedObjects native declaration : NSArrayController.h:78
abstract void	setAlwaysUsesMultipleValuesMarker(boolean flag) Indicates whether the controller should indicate all multiple selections through the NSMultipleValuesMarker, whether the selected values are equal or not (by default, the controller will only use the NSMultipleValuesMarker if the selected objects actually have different values) - this may act as a performance enhancement in certain applications.
abstract void	setAutomaticallyRearrangesObjects(boolean flag) default: NO Original signature : -(void)setAutomaticallyRearrangesObjects:(BOOL) native declaration : NSArrayController.h:50
abstract void	setAvoidsEmptySelection(boolean flag) default: YES Original signature : -(void)setAvoidsEmptySelection:(BOOL) native declaration : NSArrayController.h:73
abstract void	setClearsFilterPredicateOnInsertion(boolean flag) Indicates whether the controller should nil out its filter predicate before inserting (or adding) new objects.
abstract void	setFilterPredicate(NSPredicate filterPredicate) Original signature : -(void)setFilterPredicate:(NSPredicate*) native declaration : NSArrayController.h:61
abstract void	setPreservesSelection(boolean flag) default: YES Original signature : -(void)setPreservesSelection:(BOOL) native declaration : NSArrayController.h:75
abstract boolean	setSelectedObjects(NSArray objects) Original signature : -(BOOL)setSelectedObjects:(NSArray*) native declaration : NSArrayController.h:96
abstract boolean	setSelectionIndex(NSUInteger index) Original signature : -(BOOL)setSelectionIndex:(NSUInteger) native declaration : NSArrayController.h:91
abstract boolean	setSelectionIndexes(NSIndexSet indexes) All selection modification methods returning a BOOL indicate through that flag whether changing the selection was successful (changing the selection might trigger an commitEditing call which fails and thus deny's the selection change).
abstract void	setSelectsInsertedObjects(boolean flag) default: YES Original signature : -(void)setSelectsInsertedObjects:(BOOL) native declaration : NSArrayController.h:77
abstract void	setSortDescriptors(NSArray sortDescriptors) Original signature : -(void)setSortDescriptors:(NSArray*) native declaration : NSArrayController.h:57
abstract NSArray	sortDescriptors() Original signature : -(NSArray*)sortDescriptors native declaration : NSArrayController.h:58

Methods inherited from class org.rococoa.cocoa.appkit.NSObjectController

as_NSObjectController_NSManagedController, automaticallyPreparesContent, canAdd, canRemove, content, createWithContent, initWithContent, isEditable, newObject, objectClass, prepareContent, selection, setAutomaticallyPreparesContent, setContent, setEditable, setObjectClass, validateUserInterfaceItem

Methods inherited from class org.rococoa.cocoa.appkit.NSController

commitEditing, commitEditingWithDelegate_didCommitSelector_contextInfo, discardEditing, isEditing, objectDidBeginEditing, objectDidEndEditing

Methods inherited from class org.rococoa.cocoa.foundation.NSObject

as_NSObject_NSAccessibility, as_NSObject_NSAccessibilityAdditions, as_NSObject_NSApplicationScriptingDelegation, as_NSObject_NSArchiverCallback, as_NSObject_NSClassDescriptionPrimitives, as_NSObject_NSCoderMethods, as_NSObject_NSColorPanelResponderMethod, as_NSObject_NSComparisonMethods, as_NSObject_NSControlSubclassNotifications, as_NSObject_NSCopyLinkMoveHandler, as_NSObject_NSDelayedPerforming, as_NSObject_NSDeprecatedKeyValueCoding, as_NSObject_NSDeprecatedKeyValueObservingCustomization, as_NSObject_NSDeprecatedMethods, as_NSObject_NSDictionaryControllerKeyValuePair, as_NSObject_NSDistributedObjects, as_NSObject_NSDraggingDestination, as_NSObject_NSDraggingSource, as_NSObject_NSDraggingSourceDeprecated, as_NSObject_NSEditor, as_NSObject_NSEditorRegistration, as_NSObject_NSErrorRecoveryAttempting, as_NSObject_NSFileManagerFileOperationAdditions, as_NSObject_NSFontManagerDelegate, as_NSObject_NSFontManagerResponderMethod, as_NSObject_NSFontPanelValidationAdditions, as_NSObject_NSKeyValueBindingCreation, as_NSObject_NSKeyValueCoding, as_NSObject_NSKeyValueObserverNotification, as_NSObject_NSKeyValueObserverRegistration, as_NSObject_NSKeyValueObserving, as_NSObject_NSKeyValueObservingCustomization, as_NSObject_NSMenuValidation, as_NSObject_NSNibAwaking, as_NSObject_NSPasteboardOwner, as_NSObject_NSPlaceholders, as_NSObject_NSScriptClassDescription, as_NSObject_NSScripting, as_NSObject_NSScriptingComparisonMethods, as_NSObject_NSScriptKeyValueCoding, as_NSObject_NSScriptObjectSpecifiers, as_NSObject_NSThreadPerformAdditions, as_NSObject_NSURLClient, as_NSObject_NSURLConnectionDelegate, as_NSObject_NSURLDownloadDelegate, copy, create, dealloc, description, doesNotRecognizeSelector, finalize, forwardingTargetForSelector, forwardInvocation, init, isKindOfClass, isKindOfClass, methodForSelector, methodSignatureForSelector, mutableCopy, release, retain, retainCount

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rococoa.cocoa.foundation.protocols.NSCoding

encodeWithCoder, initWithCoder

Methods inherited from interface org.rococoa.ObjCObject

id

Methods inherited from interface org.rococoa.cocoa.foundation.protocols.NSObject

autorelease, class_, conformsToProtocol, hash, isEqual, isMemberOfClass, isProxy, performSelector_withObject_withObject, performSelector_withObject, performSelector, respondsToSelector, self, superclass, zone

Constructor Detail

NSArrayController

public NSArrayController()

Method Detail

rearrangeObjects

public abstract void rearrangeObjects()

triggers rearranging the content objects for the user interface, including sorting and filtering; subclasses can override and invoke this method if any parameter that affects the arranged objects changes
Original signature : -(void)rearrangeObjects
native declaration : NSArrayController.h:47

setAutomaticallyRearrangesObjects

public abstract void setAutomaticallyRearrangesObjects(boolean flag)

default: NO
Original signature : -(void)setAutomaticallyRearrangesObjects:(BOOL)
native declaration : NSArrayController.h:50

automaticallyRearrangesObjects

public abstract boolean automaticallyRearrangesObjects()

Original signature : -(BOOL)automaticallyRearrangesObjects
native declaration : NSArrayController.h:51

automaticRearrangementKeyPaths

public abstract NSArray automaticRearrangementKeyPaths()

computes the array of key paths that trigger automatic rearranging from the sort descriptors and filter predicates; subclasses may override this method to customize the default behavior (for example if additional arrangement criteria are used in custom implementations of -rearrangeObjects)
Original signature : -(NSArray*)automaticRearrangementKeyPaths
native declaration : NSArrayController.h:53

didChangeArrangementCriteria

public abstract void didChangeArrangementCriteria()

invoked by the controller itself when any criteria for arranging objects change (sort descriptors or filter predicates) to reset the key paths for automatic rearranging; subclasses should invoke this method if additional arrangement criteria are used in custom implementations of -rearrangeObjects and those criteria change
Original signature : -(void)didChangeArrangementCriteria
native declaration : NSArrayController.h:54

setSortDescriptors

public abstract void setSortDescriptors(NSArray sortDescriptors)

Original signature : -(void)setSortDescriptors:(NSArray*)
native declaration : NSArrayController.h:57

sortDescriptors

public abstract NSArray sortDescriptors()

Original signature : -(NSArray*)sortDescriptors
native declaration : NSArrayController.h:58

setFilterPredicate

public abstract void setFilterPredicate(NSPredicate filterPredicate)

Original signature : -(void)setFilterPredicate:(NSPredicate*)
native declaration : NSArrayController.h:61

filterPredicate

public abstract NSPredicate filterPredicate()

Original signature : -(NSPredicate*)filterPredicate
native declaration : NSArrayController.h:62

setClearsFilterPredicateOnInsertion

public abstract void setClearsFilterPredicateOnInsertion(boolean flag)

Indicates whether the controller should nil out its filter predicate before inserting (or adding) new objects. When set to yes, this eliminates the problem of inserting a new object into the array that would otherwise immediately be filtered out of the array of arranged objects.
default: YES
Original signature : -(void)setClearsFilterPredicateOnInsertion:(BOOL)
native declaration : NSArrayController.h:66

clearsFilterPredicateOnInsertion

public abstract boolean clearsFilterPredicateOnInsertion()

Original signature : -(BOOL)clearsFilterPredicateOnInsertion
native declaration : NSArrayController.h:67

arrangeObjects

public abstract NSArray arrangeObjects(NSArray objects)

returns objects to be arranged in the user interface for the content object array objects - method can be overridden to use a different kind of sort mechanism or to filter the display objects
Original signature : -(NSArray*)arrangeObjects:(NSArray*)
native declaration : NSArrayController.h:70

arrangedObjects

public abstract NSObject arrangedObjects()

array of all displayed objects (after sorting and potentially filtering)
Original signature : -(id)arrangedObjects
native declaration : NSArrayController.h:71

setAvoidsEmptySelection

public abstract void setAvoidsEmptySelection(boolean flag)

default: YES
Original signature : -(void)setAvoidsEmptySelection:(BOOL)
native declaration : NSArrayController.h:73

avoidsEmptySelection

public abstract boolean avoidsEmptySelection()

Original signature : -(BOOL)avoidsEmptySelection
native declaration : NSArrayController.h:74

setPreservesSelection

public abstract void setPreservesSelection(boolean flag)

default: YES
Original signature : -(void)setPreservesSelection:(BOOL)
native declaration : NSArrayController.h:75

preservesSelection

public abstract boolean preservesSelection()

Original signature : -(BOOL)preservesSelection
native declaration : NSArrayController.h:76

setSelectsInsertedObjects

public abstract void setSelectsInsertedObjects(boolean flag)

default: YES
Original signature : -(void)setSelectsInsertedObjects:(BOOL)
native declaration : NSArrayController.h:77

selectsInsertedObjects

public abstract boolean selectsInsertedObjects()

Original signature : -(BOOL)selectsInsertedObjects
native declaration : NSArrayController.h:78

setAlwaysUsesMultipleValuesMarker

public abstract void setAlwaysUsesMultipleValuesMarker(boolean flag)

Indicates whether the controller should indicate all multiple selections through the NSMultipleValuesMarker, whether the selected values are equal or not (by default, the controller will only use the NSMultipleValuesMarker if the selected objects actually have different values) - this may act as a performance enhancement in certain applications.
Original signature : -(void)setAlwaysUsesMultipleValuesMarker:(BOOL)
native declaration : NSArrayController.h:83

alwaysUsesMultipleValuesMarker

public abstract boolean alwaysUsesMultipleValuesMarker()

Original signature : -(BOOL)alwaysUsesMultipleValuesMarker
native declaration : NSArrayController.h:84

setSelectionIndexes

public abstract boolean setSelectionIndexes(NSIndexSet indexes)

All selection modification methods returning a BOOL indicate through that flag whether changing the selection was successful (changing the selection might trigger an commitEditing call which fails and thus deny's the selection change).
to deselect all: empty index set, to select all: index set with indexes [0...count - 1]
Original signature : -(BOOL)setSelectionIndexes:(NSIndexSet*)
native declaration : NSArrayController.h:89

selectionIndexes

public abstract NSIndexSet selectionIndexes()

Original signature : -(NSIndexSet*)selectionIndexes
native declaration : NSArrayController.h:90

setSelectionIndex

public abstract boolean setSelectionIndex(NSUInteger index)

Original signature : -(BOOL)setSelectionIndex:(NSUInteger)
native declaration : NSArrayController.h:91

selectionIndex

public abstract NSUInteger selectionIndex()

Original signature : -(NSUInteger)selectionIndex
native declaration : NSArrayController.h:92

addSelectionIndexes

public abstract boolean addSelectionIndexes(NSIndexSet indexes)

Original signature : -(BOOL)addSelectionIndexes:(NSIndexSet*)
native declaration : NSArrayController.h:93

removeSelectionIndexes

public abstract boolean removeSelectionIndexes(NSIndexSet indexes)

Original signature : -(BOOL)removeSelectionIndexes:(NSIndexSet*)
native declaration : NSArrayController.h:94

setSelectedObjects

public abstract boolean setSelectedObjects(NSArray objects)

Original signature : -(BOOL)setSelectedObjects:(NSArray*)
native declaration : NSArrayController.h:96

selectedObjects

public abstract NSArray selectedObjects()

Original signature : -(NSArray*)selectedObjects
native declaration : NSArrayController.h:97

Specified by:

selectedObjects in class NSObjectController

addSelectedObjects

public abstract boolean addSelectedObjects(NSArray objects)

Original signature : -(BOOL)addSelectedObjects:(NSArray*)
native declaration : NSArrayController.h:98

removeSelectedObjects

public abstract boolean removeSelectedObjects(NSArray objects)

Original signature : -(BOOL)removeSelectedObjects:(NSArray*)
native declaration : NSArrayController.h:99

add

public abstract void add(ObjCObject sender)

overridden to add a new object to the content objects and to the arranged objects
Original signature : -(void)add:(id)
native declaration : NSArrayController.h:101

Specified by:

add in class NSObjectController

remove

public abstract void remove(ObjCObject sender)

overridden to remove the selected objects
Original signature : -(void)remove:(id)
native declaration : NSArrayController.h:102

Specified by:

remove in class NSObjectController

insert

public abstract void insert(ObjCObject sender)

Original signature : -(void)insert:(id)
native declaration : NSArrayController.h:103

canInsert

public abstract boolean canInsert()

can be used in bindings controlling the enabling of buttons, for example
Original signature : -(BOOL)canInsert
native declaration : NSArrayController.h:104

selectNext

public abstract void selectNext(ObjCObject sender)

Original signature : -(void)selectNext:(id)
native declaration : NSArrayController.h:105

selectPrevious

public abstract void selectPrevious(ObjCObject sender)

Original signature : -(void)selectPrevious:(id)
native declaration : NSArrayController.h:106

canSelectNext

public abstract boolean canSelectNext()

Original signature : -(BOOL)canSelectNext
native declaration : NSArrayController.h:107

canSelectPrevious

public abstract boolean canSelectPrevious()

Original signature : -(BOOL)canSelectPrevious
native declaration : NSArrayController.h:108

addObject

public abstract void addObject(ObjCObject object)

overridden to add to the content objects and to the arranged objects if all filters currently applied are matched
Original signature : -(void)addObject:(id)
native declaration : NSArrayController.h:110

Specified by:

addObject in class NSObjectController

addObjects

public abstract void addObjects(NSArray objects)

Original signature : -(void)addObjects:(NSArray*)
native declaration : NSArrayController.h:111

insertObject_atArrangedObjectIndex

public abstract void insertObject_atArrangedObjectIndex(ObjCObject object,
                                                        NSUInteger index)

inserts into the content objects and the arranged objects (as specified by index in the arranged objects) - will raise an exception if the object does not match all filters currently applied
Original signature : -(void)insertObject:(id) atArrangedObjectIndex:(NSUInteger)
native declaration : NSArrayController.h:112

insertObjects_atArrangedObjectIndexes

public abstract void insertObjects_atArrangedObjectIndexes(NSArray objects,
                                                           NSIndexSet indexes)

Original signature : -(void)insertObjects:(NSArray*) atArrangedObjectIndexes:(NSIndexSet*)
native declaration : NSArrayController.h:113

removeObjectAtArrangedObjectIndex

public abstract void removeObjectAtArrangedObjectIndex(NSUInteger index)

removes from the content objects and the arranged objects (as specified by index in the arranged objects)
Original signature : -(void)removeObjectAtArrangedObjectIndex:(NSUInteger)
native declaration : NSArrayController.h:114

removeObjectsAtArrangedObjectIndexes

public abstract void removeObjectsAtArrangedObjectIndexes(NSIndexSet indexes)

Original signature : -(void)removeObjectsAtArrangedObjectIndexes:(NSIndexSet*)
native declaration : NSArrayController.h:115

removeObject

public abstract void removeObject(ObjCObject object)

removes from the content objects and the arranged objects (if currently contained)
Original signature : -(void)removeObject:(id)
native declaration : NSArrayController.h:116

Specified by:

removeObject in class NSObjectController

removeObjects

public abstract void removeObjects(NSArray objects)

Original signature : -(void)removeObjects:(NSArray*)
native declaration : NSArrayController.h:117

alloc

public static NSArrayController alloc()

new_

public static NSArrayController new_()

getNSClass

public static NSArrayController._class_ getNSClass()