RBImageSelectionField Class Reference

Inherits from UIView
Declared in RBImageSelectionField.h

Overview

An image selection field.

  delegate

A delegate to receive image selection field events.

@property (nonatomic, weak, nullable) id<RBImageSelectionFieldDelegate> delegate

Discussion

A delegate to receive image selection field events.

Declared In

RBImageSelectionField.h

  itemSize

The size of image item cells. Default = 150, 150.

@property (nonatomic) CGSize itemSize

Discussion

The size of image item cells. Default = 150, 150.

Declared In

RBImageSelectionField.h

  singleSelectionOnly

Whether or not only single selection is allowed. Default = NO.

@property (nonatomic) BOOL singleSelectionOnly

Discussion

Whether or not only single selection is allowed. Default = NO.

Declared In

RBImageSelectionField.h

  zeroSelectionAllowed

Whether or not zero selection is allowed. Default = NO.

@property (nonatomic) BOOL zeroSelectionAllowed

Discussion

Whether or not zero selection is allowed. Default = NO.

Declared In

RBImageSelectionField.h

  failureImage

An optional image that should be displayed if a failure occurs loading images.

@property (nonatomic, nullable) UIImage *failureImage

Discussion

An optional image that should be displayed if a failure occurs loading images.

Declared In

RBImageSelectionField.h

  failureImageContentMode

The content mode of the failure image.

@property (nonatomic) UIViewContentMode failureImageContentMode

Discussion

The content mode of the failure image.

Declared In

RBImageSelectionField.h

  selectedOverlayImage

The optional image overlay when selected.

@property (nonatomic, nullable) UIImage *selectedOverlayImage

Discussion

The optional image overlay when selected.

Declared In

RBImageSelectionField.h

  selectedOverlayImageContentMode

The content mode of the selected overlay image.

@property (nonatomic) UIViewContentMode selectedOverlayImageContentMode

Discussion

The content mode of the selected overlay image.

Declared In

RBImageSelectionField.h

  items

An array of RBImageSelectionFieldItem objects.

@property (nonatomic, nullable) NSArray<RBImageSelectionFieldItem*> *items

Discussion

An array of RBImageSelectionFieldItem objects.

Declared In

RBImageSelectionField.h

  selectedIndexes

The selected items by index.

@property (nonatomic, readonly, nullable) NSSet<NSNumber*> *selectedIndexes

Discussion

The selected items by index.

Declared In

RBImageSelectionField.h

  positioner

The layout positioner used. You may theme this positioner. Default values = spacing = 10, dimensions = 1, margin = [0, 0, 0, 0], orientation = RBOrientationHorizontal, sizing = RBLayoutGridPositionerSizingToSize.

@property (nonatomic, nonnull, readonly) RBLayoutGridPositioner *positioner

Discussion

The layout positioner used. You may theme this positioner. Default values = spacing = 10, dimensions = 1, margin = [0, 0, 0, 0], orientation = RBOrientationHorizontal, sizing = RBLayoutGridPositionerSizingToSize.

Declared In

RBImageSelectionField.h

– updateItemSelectionAtIndex:toSelected:

Updates the selection state of the image at the given index.

- (void)updateItemSelectionAtIndex:(NSUInteger)itemIndex toSelected:(BOOL)selected

Parameters

itemIndex

The index of the image item to update the selection state of.

selected

Whether or not the image item should be selected.

Discussion

Updates the selection state of the image at the given index.

Declared In

RBImageSelectionField.h

– itemSelectionAtIndex:

Whether or not the given image item index is selected.

- (BOOL)itemSelectionAtIndex:(NSUInteger)itemIndex

Parameters

itemIndex

The index of the image item.

Return Value

Whether or not the item is selected.

Discussion

Whether or not the given image item index is selected.

Declared In

RBImageSelectionField.h

– unselectAllItems

Unselects all image items.

- (void)unselectAllItems

Discussion

Unselects all image items.

Declared In

RBImageSelectionField.h

+ defaultPositioner

The default layout positioner used. You may theme this positioner. Default = RBLayoutGridPositioner with values spacing = 10, dimensions = 1, margin = [10, 10, 10, 10], orientation = RBOrientationVertical, sizing = RBLayoutGridPositionerSizingToSize.

+ (nonnull RBLayoutPositioner *)defaultPositioner

Return Value

The default positioner.

Discussion

The default layout positioner used. You may theme this positioner. Default = RBLayoutGridPositioner with values spacing = 10, dimensions = 1, margin = [10, 10, 10, 10], orientation = RBOrientationVertical, sizing = RBLayoutGridPositionerSizingToSize.

Declared In

RBImageSelectionField.h