UISearchBar

一、属性

参考博客: https://www.jianshu.com/p/7e49a1c656e7

  1. 搜索框风格
// 搜索框风格
@property(nonatomic) UIBarStyle barStyle;

UIBarStyle 有四种枚举值,但后两种已经禁用。

typedef NS_ENUM(NSInteger, UIBarStyle) {
    UIBarStyleDefault         //白色搜索框,灰色背景
    UIBarStyleBlack           //黑色搜索框,
    
    UIBarStyleBlackOpaque      = 1, // 禁用. Use UIBarStyleBlack
    UIBarStyleBlackTranslucent = 2, // 禁用. Use UIBarStyleBlack and set the translucent property to YES
}
UIBarStyleDefault
UIBarStyleBlack
  1. 搜索的文本、搜索框顶部的提示信息、占位符
// 搜索的文本
@property(nullable,nonatomic,copy)   NSString *text;  
 // 搜索框顶部的提示信息 ( 效果有问题  待验证 )
@property(nullable,nonatomic,copy)   NSString *prompt;    
// 占位符,默认nil, 若有值则在输入文本后消失
@property(nullable,nonatomic,copy)   NSString *placeholder;
placeholder
text
  1. 搜索框右侧的按钮
// 搜索框右侧是否显示图书按钮 
@property(nonatomic)  BOOL showsBookmarkButton;   
//搜索框右侧是否显示取消按钮 
@property(nonatomic) BOOL showsCancelButton;  
//搜索框右侧是否显示搜索结果按钮   
@property(nonatomic) BOOL showsSearchResultsButton; 
// 搜索结果按钮为选中状态
@property(nonatomic, getter=isSearchResultsButtonSelected) BOOL searchResultsButtonSelected;

以上四个属性的默认值都是 NO


showsBookmarkButton=YES.png
showsCancelButton=YES.png
showsSearchResultsButton=YES.png
showsSearchResultsButton=YES&searchResultsButtonSelected=YES.png

4 .风格颜色、背景颜色

// 风格颜色,可用于修改输入框的光标颜色,取消按钮和选择栏被选中时候都会变成设置的颜色
@property(null_resettable, nonatomic,strong) UIColor *tintColor;
// 搜索框背景颜色
@property(nullable, nonatomic,strong) UIColor *barTintColor;

例:

self.searchBar.barTintColor = [UIColor orangeColor];
self.searchBar.tintColor = [UIColor redColor];
tincolor barTintColor

5 .搜索框样式

// 搜索框样式
@property (nonatomic) UISearchBarStyle searchBarStyle
typedef NS_ENUM(NSUInteger, UISearchBarStyle) {
    UISearchBarStyleDefault,    // 默认样式,和UISearchBarStyleProminent 一样
    UISearchBarStyleProminent,  // 显示背景,常用在my Mail, Messages and Contacts
    UISearchBarStyleMinimal     // 不显示背景,系统自带的背景色无效,自定义的有效,常用在Calendar, Notes and Music
}
UISearchBarStyleDefault
UISearchBarStyleProminent
UISearchBarStyleMinimal
  1. 搜索栏的附件选择按钮视图
// 选择按钮试图的按钮标题    
@property(nullable, nonatomic,copy) NSArray *scopeButtonTitles ; 
// 选中的按钮下标值 ,默认 0. 如果超出范围则忽略
@property(nonatomic) NSInteger  selectedScopeButtonIndex ; 
// 是否显示搜索栏的附件选择按钮视图
@property(nonatomic) BOOL showsScopeBar;

测试代码

self.searchBar.showsScopeBar = YES;
self.searchBar.scopeButtonTitles = @[@"1",@"2",@"3"];
self.searchBar.selectedScopeButtonIndex = 1;
带选择按钮视图的搜索栏

7 .搜索框背景图片、搜索框附属分栏条的背景颜色

// 搜索框背景图片
@property(nullable, nonatomic,strong) UIImage *backgroundImage;
// 搜索框附属分栏条的背景颜色
@property(nullable, nonatomic,strong) UIImage *scopeBarBackgroundImage;

例:

 [self.searchBar setBackgroundImage:[UIImage imageNamed:@"searchBarBG"] forBarPosition:UIBarPositionAny barMetrics:UIBarMetricsDefault];
 [self.searchBar setScopeBarBackgroundImage:[UIImage imageNamed:@"scopeBarBG"]];
搜索框背景图和附属框背景图
  1. 搜索框中文本框的背景偏移量和文本偏移量
// 搜索框中文本框的背景偏移量
@property(nonatomic) UIOffset searchFieldBackgroundPositionAdjustment;
// 搜索框中文本框的文本偏移量
@property(nonatomic) UIOffset searchTextPositionAdjustment;

例 :

self.searchBar.searchFieldBackgroundPositionAdjustment = UIOffsetMake(5, 5);
self.searchBar.searchTextPositionAdjustment =  UIOffsetMake(10, 5);
系统默认
设置偏移量后的效果

二、方法

  1. 设置 (获取) 搜索框背景图片、选择按钮视图的背景图片、文本框的背景图片
// 1.设置搜索框背景图片
- (void)setBackgroundImage:(nullable UIImage *)backgroundImage forBarPosition:(UIBarPosition)barPosition barMetrics:(UIBarMetrics)barMetrics 
//  获取置搜索框背景图片
- (nullable UIImage *)backgroundImageForBarPosition:(UIBarPosition)barPosition barMetrics:(UIBarMetrics)barMetrics 

// 2.设置不同状态下按钮的背景图
- (void)setScopeBarButtonBackgroundImage:(nullable UIImage *)backgroundImage forState:(UIControlState)state 
// 获取某个状态下按钮的背景图
- (nullable UIImage *)scopeBarButtonBackgroundImageForState:(UIControlState)state  

// 3.设置搜索框文本框的背景图片
- (void)setSearchFieldBackgroundImage:(nullable UIImage *)backgroundImage forState:(UIControlState)state 
// 获取搜索框文本框的背景图片
- (nullable UIImage *)searchFieldBackgroundImageForState:(UIControlState)state
// 设置scopeBar 分割线的背景图
- (void)setScopeBarButtonDividerImage:(nullable UIImage *)dividerImage forLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState
  1. 设置(获取)搜索框的图标(包括搜索图标、清除输入的文字的图标、图书图标、搜索结果列表图标)
// 设置搜索框的图标
- (void)setImage:(nullable UIImage *)iconImage forSearchBarIcon:(UISearchBarIcon)icon state:(UIControlState)state;
// 获取搜索框的图标
- (nullable UIImage *)imageForSearchBarIcon:(UISearchBarIcon)icon state:(UIControlState)state;

枚举值:

typedef NS_ENUM(NSInteger, UISearchBarIcon) {
    UISearchBarIconSearch, // 搜索框放大镜图标
    UISearchBarIconClear , // 搜索框右侧可用于清除输入的文字的图标x
    UISearchBarIconBookmark , // 搜索框右侧的图书图标
    UISearchBarIconResultsList , // 搜索框右侧的搜索结果列表图标
};
  1. 设置(获取)选择按钮视图的分割线图片、按钮上显示的标题样式
// 设置选择按钮视图的分割线图片
- (void)setScopeBarButtonDividerImage:(nullable UIImage *)dividerImage forLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState;
// 获取选择按钮视图的分割线图片
- (nullable UIImage *)scopeBarButtonDividerImageForLeftSegmentState:(UIControlState)leftState rightSegmentState:(UIControlState)rightState;
// 设置选择按钮视图的标题样式
- (void)setScopeBarButtonTitleTextAttributes:(nullable NSDictionary *)attributes forState:(UIControlState)state;
// 获取选择按钮视图的标题样式
- (nullable NSDictionary *)scopeBarButtonTitleTextAttributesForState:(UIControlState)state
设置背景图标及scopeTitle文字属性
  1. 设置(获取)搜索框四种图标的偏移量
//  设置搜索框图标的偏移量
- (void)setPositionAdjustment:(UIOffset)adjustment forSearchBarIcon:(UISearchBarIcon)icon;
//  获取搜索框图标的偏移量
- (UIOffset)positionAdjustmentForSearchBarIcon:(UISearchBarIcon)icon;

三、代理

// 1. 将要开始编辑文本时会调用该方法,返回 NO 将不会变成第一响应者
- (BOOL)searchBarShouldBeginEditing:(UISearchBar *)searchBar;                      
// 2. 开始输入文本会调用该方法
- (void)searchBarTextDidBeginEditing:(UISearchBar *)searchBar;                     
// 3. 将要结束编辑文本时会调用该方法,返回 NO 将不会释放第一响应者
- (BOOL)searchBarShouldEndEditing:(UISearchBar *)searchBar; 
 // 4. 结束编辑文本时调用该方法
- (void)searchBarTextDidEndEditing:(UISearchBar *)searchBar;     
// 5. 文本改变会调用该方法(包含clear文本)
- (void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText; 
// 6. 文字改变前会调用该方法,返回NO则不能加入新的编辑文字
- (BOOL)searchBar:(UISearchBar *)searchBar shouldChangeTextInRange:(NSRange)range replacementText:(NSString *)text ;

// 7. 键盘上的搜索按钮点击的会调用该方法
- (void)searchBarSearchButtonClicked:(UISearchBar *)searchBar;     
// 8. 搜索框右侧图书按钮点击会调用该方法
- (void)searchBarBookmarkButtonClicked:(UISearchBar *)searchBar ;
 // 9.点击取消按钮会调用该方法
- (void)searchBarCancelButtonClicked:(UISearchBar *)searchBar;   
// 10.搜索结果列表按钮被按下会调用该方法
- (void)searchBarResultsListButtonClicked:(UISearchBar *)searchBar ; 
// 11. 搜索框的附属按钮视图中切换按钮会调用该方法
- (void)searchBar:(UISearchBar *)searchBar selectedScopeButtonIndexDidChange:(NSInteger)selectedScope;

你可能感兴趣的:(UISearchBar)