Class: UITabBarItem

Inherits:
UIBarItem show all

Overview

The UITabBarItem class implements an item on a tab bar, instances of the UITabBar class. A tab bar operates strictly in radio mode, where one item is selected at a time—tapping a tab bar item toggles the view above the tab bar. You can also specify a badge value on the tab bar item for adding additional visual information—for example, the Phone application uses a badge on the item to show the number of new messages. This class also provides a number of system defaults for creating items.

Instance Attribute Summary (collapse)

Attributes inherited from UIBarItem

#enabled, #image, #imageInsets, #landscapeImagePhone, #landscapeImagePhoneInsets, #tag, #title

Instance Method Summary (collapse)

Methods inherited from UIBarItem

#setTitleTextAttributes:forState:, #titleTextAttributesForState:

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Instance Attribute Details

- (String) badgeValue

Text that is displayed in the upper-right corner of the item with a surrounding red oval. The default value is nil.

Returns:

Instance Method Details

- (UIImage) finishedSelectedImage

Returns the finished selected image.

Returns:

  • (UIImage) —

    The finished selected image.

- (UIImage) finishedUnselectedImage

Returns the finished unselected image.

Returns:

  • (UIImage) —

    The finished unselected image.

- (Object) initWithTabBarSystemItem(systemItem, tag:tag)

Creates and returns a new item containing the specified system item. This method returns a system-supplied tab bar item. The title and image properties of the returned item cannot be changed later.

Parameters:

  • systemItem (UITabBarSystemItem) —

    The system item to use as the first item on the tab bar. One of the constants defined in UITabBarSystemItem.

  • tag (Integer) —

    The receiver’s tag, an integer that you can use to identify bar item objects in your application.

Returns:

  • (Object) —

    A newly initialized item containing the specified system item. The item’s target is nil.

- (Object) initWithTitle(title, image:image, tag:tag)

Creates and returns a new item using the specified properties.

Parameters:

  • title (String) —

    The item’s title. If nil, a title is not displayed.

  • image (UIImage) —

    The item’s image. If nil, an image is not displayed.The images displayed on the tab bar are derived from this image. If this image is too large to fit on the tab bar, it is clipped to fit. The size of a tab bar image is typically 30 x 30 points. The alpha values in the source image are used to create the unselected and selected images—opaque values are ignored.

  • tag (Integer) —

    The receiver’s tag, an integer that you can use to identify bar item objects in your application.

Returns:

  • (Object) —

    Newly initialized item with the specified properties.

- (Object) setFinishedSelectedImage(selectedImage, withFinishedUnselectedImage:unselectedImage)

Sets the finished selected and unselected images.

Parameters:

  • selectedImage (UIImage) —

    The finished selected image.

  • unselectedImage (UIImage) —

    The finished unselected image.

Returns:

- (Object) setTitlePositionAdjustment(adjustment)

Sets the offset to use to adjust the title position.

Parameters:

  • adjustment (UIOffset) —

    The offset to use to adjust the title position.

Returns:

- (UIOffset) titlePositionAdjustment

Returns the offset to use to adjust the title position.

Returns:

  • (UIOffset) —

    The offset to use to adjust the title position.