Class: UIBarItem

Inherits:
NSObject show all

Overview

UIBarItem is an abstract superclass for items added to a bar that appears at the bottom of the screen. Items on a bar behave in a way similar to buttons (instances of UIButton). They have a title, image, action, and target. You can also enable and disable an item on a bar.

Direct Known Subclasses

UIBarButtonItem, UITabBarItem

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

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

- (Boolean) enabled

A Boolean value indicating whether the item is enabled. If NO, the item is drawn partially dimmed to indicate it is disabled. The default value is YES.

Returns:

  • (Boolean)

- (UIImage) image

The image used to represent the item. This image can be used to create other images to represent this item on the bar—for example, a selected and unselected image may be derived from this image. You should set this property before adding the item to a bar. The default value is nil.

Returns:

- (UIEdgeInsets) imageInsets

The image inset or outset for each edge. The default value is UIEdgeInsetsZero.

Returns:

- (UIImage) landscapeImagePhone

The image to use to represent the item in landscape orientation when using the iPhone appearance idiom. This image can be used to create other images to represent this item on the bar—for example, a selected and unselected image may be derived from this image. You should set this property before adding the item to a bar. The default value is nil.

Returns:

- (UIEdgeInsets) landscapeImagePhoneInsets

The image inset or outset for each edge of the image in landscape orientation when using the iPhone appearance idiom. The default value is UIEdgeInsetsZero.

Returns:

- (Integer) tag

The receiver’s tag, an application-supplied integer that you can use to identify bar item objects in your application. The default value is 0.

Returns:

- (String) title

The title displayed on the item. You should set this property before adding the item to a bar. The default value is nil.

Returns:

Instance Method Details

- (Object) setTitleTextAttributes(attributes, forState:state)

Sets the title’s text attributes for a given control state.

Parameters:

  • attributes (Hash)

    A dictionary containing key-value pairs for text attributes.You can specify the font, text color, text shadow color, and text shadow offset using the keys listed in NSString UIKit Additions Reference.

  • state (UIControlState)

    The control state for which you want to set the text attributes for the title.

Returns:

- (Hash) titleTextAttributesForState(state)

Returns the title’s text attributes for a given control state. The dictionary may contain key-value pairs for text attributes for the font, text color, text shadow color, and text shadow offset using the keys listed in NSString UIKit Additions Reference.

Parameters:

  • state (UIControlState)

    The control state for which you want to know the text attributes for the title.

Returns:

  • (Hash)

    The title’s text attributes for state.