SEssentialsTabbedViewStyle Class Reference

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

Overview

The SEssentialsTabbedViewStyle defines the look and feel for an instance of the SEssentialsTabbedView class. If you wish to update how a tabbed view looks, you should update its style object.

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

The following default settings are provided by the theme:

  • The primaryTintColor on the theme is used for the background color of the tab header views (tintColor).
  • The secondaryTintColor on the theme is used for the background color of the tab bar (tabBarBackgroundColor).
  • The secondaryTexture on the theme is used for the background texture of the tab bar (tabBarBackgroundTexture).
  • The primaryTextColor on the theme is used for text in active tab header views (defaultFontColor).
  • The secondaryTextColor on the theme is used as the color for text in inactive tab header views (alternativeFontColor).

Decoration can be applied to the tabbed view. When decoration is applied, the following effects are added to the control:

  • The tab header views are moved so they overlap slightly with each other. When no decoration is applied, the header views will line up without any overlap.
  • The look of the overflow dropdown menu is changed. A translucent border is drawn around the menu, and a drop shadow is drawn beneath the menu.

The decoration property controls whether decoration is applied to the control.

Properties

activeImage

Graphics for the active tab item button

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

Declared In

SEssentialsTabbedViewStyle.h

activeTabMask

The mask image to use for active tabs

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

Declared In

SEssentialsTabbedViewStyle.h

addTabImage

Graphics for the ‘new tab’ button

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

Declared In

SEssentialsTabbedViewStyle.h

addTabMask

Graphics for the ‘new tab’ button mask

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

Declared In

SEssentialsTabbedViewStyle.h

addTabPressedImage

Graphics for the ‘new tab’ button when pressed

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

Declared In

SEssentialsTabbedViewStyle.h

alternativeFontColor

The default font color used on the inactive tabs. This defaults to the secondaryTextColor on the theme.

@property (retain, nonatomic) UIColor *alternativeFontColor

Declared In

SEssentialsTabbedViewStyle.h

buttonsEndImage

Graphics for the edge of the tab bar under the buttons

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

Declared In

SEssentialsTabbedViewStyle.h

buttonsEndImageMask

Graphics for the mask of the edge of the tab bar under the buttons

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

Declared In

SEssentialsTabbedViewStyle.h

buttonsMask

Graphics for the background mask of the ‘new tab’ and ‘overflow dropdown’ buttons

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

Declared In

SEssentialsTabbedViewStyle.h

closeTabImage

Graphics for the close tab icon

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

Declared In

SEssentialsTabbedViewStyle.h

closeTabPressedImage

Graphics for the close tab icon pressed

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

Declared In

SEssentialsTabbedViewStyle.h

decoration

Whether to apply decoration to the control.

@property (nonatomic, assign) BOOL decoration

Discussion

When decoration is applied, the following effects are added to the control:

  • The tab header views are moved so they overlap slightly with each other. When no decoration is applied, the header views will line up without any overlap.
  • The look of the overflow dropdown menu is changed. A translucent border is drawn around the menu, and a drop shadow is drawn beneath the menu.

If elementStyle on the theme is set to DECORATED, this defaults to YES. Otherwise, this defaults to NO.

Declared In

SEssentialsTabbedViewStyle.h

defaultFont

The default font used on the tab. This defaults to the secondaryFont on the theme.

@property (retain, nonatomic) UIFont *defaultFont

Declared In

SEssentialsTabbedViewStyle.h

defaultFontColor

The default font color used on the active tab. This defaults to the primaryTextColor on the theme.

@property (retain, nonatomic) UIColor *defaultFontColor

Declared In

SEssentialsTabbedViewStyle.h

defaultOverflowFont

The default font used on the overflow picker. This defaults to the primaryFont on the theme.

@property (retain, nonatomic) UIFont *defaultOverflowFont

Declared In

SEssentialsTabbedViewStyle.h

inactiveImage

Graphics for the inactive tab item button

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

Declared In

SEssentialsTabbedViewStyle.h

inactiveTabMask

The mask image to use for inactive tabs

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

Declared In

SEssentialsTabbedViewStyle.h

maximumTabWidth

When resizeToText is set to YES this acts as an upper limit on the width of the tab.

@property (assign, nonatomic) CGFloat maximumTabWidth

Declared In

SEssentialsTabbedViewStyle.h

newTabButtonWidth

The default width of the ‘new tab’ button.

@property (assign, nonatomic) CGFloat newTabButtonWidth

Declared In

SEssentialsTabbedViewStyle.h

overflowButtonWidth

The default width of the button that reveals the drop down of off-screen tabs

@property (assign, nonatomic) CGFloat overflowButtonWidth

Declared In

SEssentialsTabbedViewStyle.h

overflowTabsImage

Graphics for the ‘overflow dropdown’ button

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

Declared In

SEssentialsTabbedViewStyle.h

overflowTabsMask

Graphics for the ‘overflow dropdown’ button mask

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

Declared In

SEssentialsTabbedViewStyle.h

overflowTabsPressedImage

Graphics for the ‘overflow dropdown’ button when pressed

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

Declared In

SEssentialsTabbedViewStyle.h

shadowDepth

The size of the shadow underneath the button area (containing the overflow and new tab buttons). This defaults to the shadowDepth on the theme.

@property (nonatomic, assign) CGFloat shadowDepth

Declared In

SEssentialsTabbedViewStyle.h

tabBackgroundImage

Graphics for the background of the tab bar

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

Declared In

SEssentialsTabbedViewStyle.h

tabBackgroundMask

Graphics for the mask of the background of the tab bar

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

Declared In

SEssentialsTabbedViewStyle.h

tabBarBackgroundColor

The color of the background to the tab bar. This defaults to the secondaryTintColor on the theme.

@property (nonatomic, retain) UIColor *tabBarBackgroundColor

Declared In

SEssentialsTabbedViewStyle.h

tabBarBackgroundTexture

The texture of the background to the tab bar. This defaults to the secondaryTexture on the theme.

@property (nonatomic, retain) UIColor *tabBarBackgroundTexture

Declared In

SEssentialsTabbedViewStyle.h

tabButtonsTintColor

The tint color of the ‘new tab’ and ‘overflow dropdown’ icons. This defaults to the tertiaryTintColor on the theme.

@property (nonatomic, retain) UIColor *tabButtonsTintColor

Declared In

SEssentialsTabbedViewStyle.h

tabHeight

The height of the area reserved for the tabs

@property (assign, nonatomic) CGFloat tabHeight

Declared In

SEssentialsTabbedViewStyle.h

tabWidth

The default width of a tab. This will be used when resizeToText is set to NO.

@property (assign, nonatomic) CGFloat tabWidth

Declared In

SEssentialsTabbedViewStyle.h

tintColor

The tint color of the tab header views. This defaults to the primaryTintColor on the theme.

@property (nonatomic, retain) UIColor *tintColor

Declared In

SEssentialsTabbedViewStyle.h

Instance Methods

initWithTheme:activeImage:inactiveImage:activeTabMask:inactiveTabMask:closeTabImage:closeTabPressedImage:addTabImage:addTabPressedImage:addTabMask:overflowTabsImage:overflowTabsPressedImage:overflowTabsMask:buttonsEndImage:buttonsEndImageMask:tabBackgroundImage:tabBackgroundMask:

Initializes the style object with a set of custom images for the tabbed view. If an image is passed in as nil, the style will use a default image for that property.

- (id)initWithTheme:(SEssentialsTheme *)theme activeImage:(UIImage *)activeImage inactiveImage:(UIImage *)inactiveImage activeTabMask:(UIImage *)activeTabMask inactiveTabMask:(UIImage *)inactiveTabMask closeTabImage:(UIImage *)closeTabImage closeTabPressedImage:(UIImage *)closeTabPressedImage addTabImage:(UIImage *)addTabImage addTabPressedImage:(UIImage *)addTabPressedImage addTabMask:(UIImage *)addTabMask overflowTabsImage:(UIImage *)overflowTabsImage overflowTabsPressedImage:(UIImage *)overflowTabsPressedImage overflowTabsMask:(UIImage *)overflowTabsMask buttonsEndImage:(UIImage *)buttonsEndImage buttonsEndImageMask:(UIImage *)buttonsEndImageMask tabBackgroundImage:(UIImage *)tabBackgroundImage tabBackgroundMask:(UIImage *)tabBackgroundMask

Discussion

Deprecated in 2.1, use initWithTheme:customImages: instead.

Declared In

SEssentialsTabbedViewStyle.h

initWithTheme:customImages:

Initializes the style object with a set of custom images for the tabbed view, using the SEssentialsTabbedViewCustomImagesWrapper. If an image is passed in as nil, the style will use a default image for that property.

- (instancetype)initWithTheme:(SEssentialsTheme *)theme customImages:(SEssentialsTabbedViewCustomImagesWrapper *)customImages

Declared In

SEssentialsTabbedViewStyle.h

tabImageLeftInset

The fixed inset on the tab active and inactive images. The image provided needs to be of the 9-part stretchable form used by UIImage:resizableImageWithCapInsets: - with a 1x1 central stretchable area. tabImageLeftInset is the size of the left inset.

- (NSInteger)tabImageLeftInset

Declared In

SEssentialsTabbedViewStyle.h

tabImageTopInset

The fixed inset on the tab active and inactive images. The image provided needs to be of the 9-part stretchable form used by UIImage:resizableImageWithCapInsets: - with a 1x1 central stretchable area. tabImageTopInset is the size of the top inset.

- (NSInteger)tabImageTopInset

Declared In

SEssentialsTabbedViewStyle.h