SEssentialsProgressIndicatorStyle Class Reference

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

Overview

The SEssentialsProgressIndicatorStyle defines the look and feel for an instance of the SEssentialsProgressIndicator class. If you wish to update how a progress or activity indicator looks, you should modify the properties of its style object.

SEssentialsProgressIndicatorStyle derives from SEssentialsStyle, and so it is created from a SEssentialsTheme object. The theme with which it is created provides the default settings of the style.

The default settings of the following properties on the control are set from the theme:

  • The tertiaryTintColor on the theme is used for the color of the completed portion of the indicator (tintColor).
  • The inactiveTintColor on the theme is used for the color of the incomplete portion of the indicator (trackColor).
  • The primaryFont on the theme defines the font of the progress label (progressLabelFont).
  • The elementStyle on the theme defines whether shading is applied to the completed portion of the indicator (shadingEffect), and whether a border is drawn around it (trackBorderWidth).

Tasks

Common Properties

Continuous indicator properties

Discrete indicator properties

Properties

backgroundPadding

The padding in pixels around the indicator for the background. Defaults to 5 pixels.

@property (nonatomic, assign) CGFloat backgroundPadding

Declared In

SEssentialsProgressIndicatorStyle.h

elementSize

In discrete indicators, this represents the diameter of default circle elements. Note: this has no effect with user-defined elements.

@property (nonatomic, assign) CGFloat elementSize

Discussion

In continuous indicators, this represents the width of the main indicator element.

Defaults to 10.0.

Declared In

SEssentialsProgressIndicatorStyle.h

fadeTail

Determines whether the tail of a discrete activity indicator should fade or not. If not, all the elements will either be in an on state, or an off state. Defaults to YES.

@property (nonatomic, assign) BOOL fadeTail

Declared In

SEssentialsProgressIndicatorStyle.h

indicatorBackgroundColor

The color of the progress indicators background.

@property (nonatomic, retain) UIColor *indicatorBackgroundColor

Declared In

SEssentialsProgressIndicatorStyle.h

numberOfElements

The number of elements present in a discrete indicator. Defaults to 16.

@property (nonatomic, assign) NSUInteger numberOfElements

Declared In

SEssentialsProgressIndicatorStyle.h

progressLabelColor

The color of the progress label. Defaults to the primaryTextColor on the theme.

@property (nonatomic, retain) UIColor *progressLabelColor

Declared In

SEssentialsProgressIndicatorStyle.h

progressLabelFont

The font used for the progress label. Defaults to the primaryFont on the theme.

@property (nonatomic, retain) UIFont *progressLabelFont

Declared In

SEssentialsProgressIndicatorStyle.h

shadingEffect

Boolean value which determines whether or not the indicator should render shading effects. This defaults to the elementStyle property provided by the theme.

@property (nonatomic, assign) BOOL shadingEffect

Declared In

SEssentialsProgressIndicatorStyle.h

showBackground

Determines whether the progress indicator has a background. Defaults to NO.

@property (nonatomic, assign) BOOL showBackground

Declared In

SEssentialsProgressIndicatorStyle.h

showProgressLabel

Determines whether the progress label will be shown or not. The label is only displayed for radial indicators, and is displayed in the center of the indicator. Defaults to NO.

@property (nonatomic, assign) BOOL showProgressLabel

Declared In

SEssentialsProgressIndicatorStyle.h

tintColor

The color of the completed portion of the indicator. This defaults to the tertiaryTintColor provided by the theme.

@property (nonatomic, retain) UIColor *tintColor

Declared In

SEssentialsProgressIndicatorStyle.h

trackBorderWidth

Represents the width of the border around the foreground element in the continuous indicators. If elementStyle on the theme is set to DECORATED, this defaults to 2.0. Otherwise, this defaults to 0.0.

@property (nonatomic, assign) CGFloat trackBorderWidth

Declared In

SEssentialsProgressIndicatorStyle.h

trackColor

The color of the incomplete portion of the indicator. This defaults to the inactiveTintColor provided by the theme.

@property (nonatomic, retain) UIColor *trackColor

Declared In

SEssentialsProgressIndicatorStyle.h