Inherits from SEssentialsStyle : NSObject
Declared in SEssentialsFlowLayoutStyle.h
Availability
Related samples

Overview

The SEssentialsFlowLayoutStyle defines the look and feel for an instance of the SEssentialsFlowLayout class. If you wish to configure how your flow layout looks, you should modify the properties on this class.

SEssentialsFlowLayoutStyle derives from SEssentialsStyle, and so it is initialized from a SEssentialsTheme object. The theme provides the default settings for the style.

The following default settings are taken from the theme:

  • The primaryTintColor on the theme is used for the background color of the flow layout (mainViewTintColor).
  • The primaryTexture on the theme is used for the background texture of the flow layout (mainViewTexture).

Tasks

Colors and textures

  •   mainViewTexture

    The texture of the view background. This defaults to the primaryTexture on the theme.

    property
  •   mainViewTintColor

    The tint color of the view background. This defaults to the primaryTintColor on the theme.

    property
  •   trashcanTintColor

    The tint color of the FlowLayout trashcan icon. This defaults to the ‘tertiaryTintColor’ on the theme.

    property

Selection

Initialization

Images

Properties

deleteImage

Delete image

@property (nonatomic, retain, readonly) UIImage *deleteImage

Discussion

This is the image which appears on the corner of individual flow elements during edit mode when the SEssentialsFlowLayout is using SEssentialsFlowDeleteIdiomIcon delete idiom. This is the image for the default button state.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

deletePressedImage

Delete pressed image

@property (nonatomic, retain, readonly) UIImage *deletePressedImage

Discussion

This is the image which appears on the corner of individual flow elements during edit mode when the SEssentialsFlowLayout is using SEssentialsFlowDeleteIdiomIcon delete idiom. This is the image for the pressed button state.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

doneButtonImage

Done button image

@property (nonatomic, retain, readonly) UIImage *doneButtonImage

Discussion

This is the image which appears to exit edit mode on a SEssentialsFlowLayout when the SEssentialsFlowDeleteIdiomIcon delete idiom is used. This is the image for the default state.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

doneButtonPressedImage

Done button pressed image

@property (nonatomic, retain, readonly) UIImage *doneButtonPressedImage

Discussion

This is the image which appears to exit edit mode on a SEssentialsFlowLayout when the SEssentialsFlowDeleteIdiomIcon delete idiom is used. This is the image for the pressed state.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

mainViewTexture

The texture of the view background. This defaults to the primaryTexture on the theme.

@property (nonatomic, retain) UIColor *mainViewTexture

Declared In

SEssentialsFlowLayoutStyle.h

mainViewTintColor

The tint color of the view background. This defaults to the primaryTintColor on the theme.

@property (nonatomic, retain) UIColor *mainViewTintColor

Declared In

SEssentialsFlowLayoutStyle.h

selectedScaleFactor

The amount to scale a view by when it is selected.

@property (nonatomic, assign) CGFloat selectedScaleFactor

Discussion

A value of 1.0 will not scale the subview. The default value for this property is 1.1.

Declared In

SEssentialsFlowLayoutStyle.h

trashcanImage

Trash can image

@property (nonatomic, retain, readonly) UIImage *trashcanImage

Discussion

This is the image which appears for flow elements to be dragged to for deletion when the SEssentialsFlowLayout is set to use the SEssentialsFlowDeleteIdiomTrashCan delete idiom.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

trashcanMask

Trash can mask image

@property (nonatomic, retain, readonly) UIImage *trashcanMask

Discussion

This mask defines where the trashcan will be colored with trashcanTintColor.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom initialization method above.

Declared In

SEssentialsFlowLayoutStyle.h

trashcanTintColor

The tint color of the FlowLayout trashcan icon. This defaults to the ‘tertiaryTintColor’ on the theme.

@property (nonatomic, retain) UIColor *trashcanTintColor

Declared In

SEssentialsFlowLayoutStyle.h

Instance Methods

initWithTheme:customImages:

Initializes the style object with a set of custom icons for the flow layout. See SEssentialsFlowLayoutImagesWrapper for more details.

- (id)initWithTheme:(SEssentialsTheme *)theme customImages:(SEssentialsFlowLayoutImagesWrapper *)customImages

Declared In

SEssentialsFlowLayoutStyle.h

initWithTheme:trashcanImage:trashcanMask:doneButtonImage:doneButtonPressedImage:deleteImage:deletePressedImage:

DEPRECATED in ShinobiEssentials v2.1, use initWithTheme:customImages: instead

- (id)initWithTheme:(SEssentialsTheme *)theme trashcanImage:(UIImage *)trashcanImage trashcanMask:(UIImage *)trashcanMask doneButtonImage:(UIImage *)doneButtonImage doneButtonPressedImage:(UIImage *)doneButtonPressedImage deleteImage:(UIImage *)deleteImage deletePressedImage:(UIImage *)deletePressedImage

Declared In

SEssentialsFlowLayoutStyle.h