org.robovm.objc.annotation

Annotation Type IBOutletCollection

@Retention(value=RUNTIME)
 @Target(value={METHOD,FIELD})
public @interface IBOutletCollection

Used to mark a class method or field as an Objective-C property compliant with a XCode interface builder outlet collection. Outlet collections must be of type NSArray and must not be static.

Outlet collection methods in ordinary classes can have any name if a selector() has been specified. The getter must return something and take 0 parameters and the setter must return nothing and take exactly 1 parameter.

If no selector() has been specified the name of the method will be used to determine the selector for the outlet collection. In that case the property methods must follow the Java beans property methods naming convention: the getter name starts with "is" or "get" while the setter name starts with "set".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name The name of the outlet collection.
String	selector The name of the Objective-C selector this outlet collection binds to.
boolean	strongRef Specifies that when a outlet collection is set a strong reference from the Objective-C object the outlet collection belongs to to the Java instance being set should be created.

Element Detail

selector

public abstract String selector

The name of the Objective-C selector this outlet collection binds to. If not specified the selector will be derived from the name of the method or field.

Default:

""

name

public abstract String name

The name of the outlet collection. If not specified the name will be derived from the name of the method or field. In case of methods "is", "get" or "set" will be dropped from the start of the method name and the rest will be used as property name with the first character downcased.

Default:

""

strongRef

public abstract boolean strongRef

Specifies that when a outlet collection is set a strong reference from the Objective-C object the outlet collection belongs to to the Java instance being set should be created. This prevents the Java instance from being GCed until the Objective-C object instance is deallocated. This is typically used for Objective-C outlets which don't retain their values (either specified as assign or weak in Objective-C).

This attribute is only meaningful when set on a setter method. If specified on a getter method it will be ignored.

NOTE: There must be a corresponding getter method in the class. This will be used to determine the old value of the property. ObjCObject.removeStrongRef(Object) will be called passing the old value if not null. If the property methods follow the Java beans naming convention the getter method can be automatically determined. Otherwise the name() has to be set to the same value on both the getter and setter methods.

See Also:

ObjCObject.addStrongRef(Object), ObjCObject.removeStrongRef(Object)

Default:

false