SEssentialsDiscreteIndicatorElement Class Reference

Inherits from UIView
Declared in SEssentialsDiscreteIndicatorElement.h
Availability
Related samples

Overview

SEssentialsDiscreteIndicatorElement is a UIView subclass, a collection of which can be arranged to form a ShinobiEssentials discrete progress or activity indicator.

An SEssentialsDiscreteIndicatorElement has 2 embedded UIViews - one for the on state and one for the off state. The onView is overlaid on top of the offView and has its transparency varied according to the current indicator state.

Properties

activeProportion

Sets the alpha level of the onView. Varies between 0 and 1, with 0 representing the element in the fully off state and 1 in the fully on state. Override this setter to change the way the 2 views interact as the activeProportion changes.

@property (nonatomic, assign) CGFloat activeProportion

Declared In

SEssentialsDiscreteIndicatorElement.h

Instance Methods

initWithFrame:onImage:offImage:

Create an indicator element with the specified off and on images. This is a helper method which will create the appropriate UIImageViews for you.

- (instancetype)initWithFrame:(CGRect)frame onImage:(UIImage *)onImage offImage:(UIImage *)offImage

Parameters

frame

The frame of the created element

onImage

The UIImage associated with the fully-on state

offImage

The UIImage associated with the fully-off state.

Declared In

SEssentialsDiscreteIndicatorElement.h

initWithFrame:onView:offView:

Create an indicator element with the specified off and on views:

- (instancetype)initWithFrame:(CGRect)frame onView:(UIView *)onView offView:(UIView *)offView

Parameters

frame

The frame of the created element

onView

The UIView associated with the fully-on state

offView

The UIView associated with the fully-off state

Declared In

SEssentialsDiscreteIndicatorElement.h