UIMenuController蘋果官方文件

示例程式碼下載地址

1. UIMenuController簡介

在很多應用中，當我們長按一段文字或者圖片的時候會彈出一個選單，我們通過這個選單可以實現文字等的複製、剪下、刪除以及各種操作。

• 這個選單就是UIMenuController，系統預設支援UITextField、UITextView、UIWebView控制元件的UIMenuController相關操作

• 對於系統不支援UIMenuController操作的控制元件，我們就要自定義控制元件的UIMenuController來實現相關功能

2. UIMenuController相關方法

• 建立一個UIMenuController物件

+ (UIMenuController *)sharedMenuController

• 顯示或者隱藏選單

@property(nonatomic,getter=isMenuVisible) BOOL menuVisible;     // default is NO
//是否通過動畫進行設定顯示、隱藏
- (void)setMenuVisible:(BOOL)menuVisible animated:(BOOL)animated;

** 注意 ** 在顯示menu之前，一點要確定為menu設定與其相關的顯示位置

• 設定menu顯示的位置

/**
 *  設定menu顯示的位置資訊
 *
 *  @param targetRect menu需要顯示的矩形區域
 *  @param targetView targetRect會以targetView的左上角為座標原點進行顯示
 */
- (void)setTargetRect:(CGRect)targetRect inView:(UIView *)targetView;

注意

• targetRect一旦設定以後，矩形範圍不會跟隨view的移動而移動，如果view移動，必須相應的更新targetRect 。比如tableView 點選cell出現menu，當按住對應的cell，拖動tableView滾動時，menu不會隨著對應的cell一起滾動---見示例程式碼2

• targetRect通常設定為需要彈出menu控制元件的bounds，targetView設定為對應的控制元件本身

• 更新menu的顯示與對應方法
  預設系統在menu顯示並且點選menu上的item時，呼叫該方法。

- (void)update

• 自定義menuItem
  • 該屬性預設為空。每一個menu Item都是一個UIMenuItem物件。
• 你可以建立自定義的menu items，每一個item擁有自己的標題和方法，你必須通過menuItems屬性新增每一個item。
• 自定義的item在meun中顯示在系統item後面

@property(nonatomic, copy) NSArray <UIMenuItem *> *menuItems

@interface UIMenuItem : NSObject 
//建立UIMenuItem物件
- (instancetype)initWithTitle:(NSString *)title action:(SEL)action ;
@property(nonatomic,copy) NSString *title;
@property(nonatomic)      SEL       action;

• 資料型別:編輯選單箭頭指向view的位置
  預設取決於view在介面的位置

typedef enum {
   UIMenuControllerArrowDefault,
   UIMenuControllerArrowUp,
   UIMenuControllerArrowDown,
   UIMenuControllerArrowLeft,
   UIMenuControllerArrowRight,
} UIMenuControllerArrowDirection;

• munu支援的通知
  根據字面意思很容易理解，不再贅述

UIMenuControllerWillShowMenuNotification
UIMenuControllerDidShowMenuNotification
UIMenuControllerWillHideMenuNotification
UIMenuControllerDidHideMenuNotification
UIMenuControllerMenuFrameDidChangeNotification

3.自定義控制元件的UIMenuController

• 兩個重要方法
  PS:如果自定義的menu顯示效果存在問題，一般是這兩個方法出現了問題，要多加琢磨

//設定控制元件可以成為第一響應者，注意不是每個控制元件都可以成為第一響應者
- (BOOL)canBecomeFirstResponder;    // default is NO
/**
 *  設定控制元件能夠執行那些具體操作
 *  @param action 具體操作
 *  @return YES:支援該操作
 */
- (BOOL)canPerformAction:(SEL)action withSender:(nullable id)sender;
// Allows an action to be forwarded to another target. By default checks -canPerformAction:withSender: to either return self, or go up the responder chain.

• 一般步驟：

• 設定控制元件成為第一響應者

• 建立UIMenuControler

• 建立UIMenuItem(如果需要自定義item)

• 在對應控制元件重寫上述兩個方法

• UIMenuController按鈕點選常見系統方法

- (void)cut:(nullable id)sender NS_AVAILABLE_IOS(3_0);
- (void)copy:(nullable id)sender NS_AVAILABLE_IOS(3_0);
- (void)paste:(nullable id)sender NS_AVAILABLE_IOS(3_0);
- (void)select:(nullable id)sender NS_AVAILABLE_IOS(3_0);
- (void)selectAll:(nullable id)sender NS_AVAILABLE_IOS(3_0);
- (void)delete:(nullable id)sender NS_AVAILABLE_IOS(3_2);
- (void)makeTextWritingDirectionLeftToRight:(nullable id)sender NS_AVAILABLE_IOS(5_0);
- (void)makeTextWritingDirectionRightToLeft:(nullable id)sender NS_AVAILABLE_IOS(5_0);

//私有方法
   _promptForReplace:
   _transliterateChinese:
   _showTextStyleOptions:
   _define:
   _addShortcut:
   _accessibilitySpeak:
   _accessibilitySpeakLanguageSelection:
   _accessibilityPauseSpeaking:
   _share:

• 示例程式碼1：自定義Label的UIMenuController

#import "ZZYMenuLabel.h"

@implementation ZZYMenuLabel
/**
 *  xib建立label時呼叫
 */
- (void)awakeFromNib
{
    [self setUp];
}
/**
 *  程式碼建立label時呼叫
 */
- (instancetype)initWithFrame:(CGRect)frame
{
    if (self = [super initWithFrame:frame]) {
         [self setUp];
    }
    return self;
}

- (void)setUp
{
    self.userInteractionEnabled = YES;
    [self addGestureRecognizer:[[UILongPressGestureRecognizer alloc]initWithTarget:self action:@selector(longPress)]];
}

- (void)longPress
{
    NSLog(@"%s",__func__);
    
    //1.設定label為第一響應者
    //通過設定第一響應者UIMenuController可以獲得支援哪些操作的資訊,操作怎麼處理
    [self becomeFirstResponder];
    
    //2.設定UIMenuController
    UIMenuController * menu = [UIMenuController sharedMenuController];

    //當長按label的時候，這個方法會不斷呼叫，menu就會出現一閃一閃不斷顯示，需要在此處進行判斷
    if (menu.isMenuVisible)return;
    //自定義 UIMenuController
    
    UIMenuItem * item1 = [[UIMenuItem alloc]initWithTitle:@"剪下" action:@selector(myCut:)];
    UIMenuItem * item2 = [[UIMenuItem alloc]initWithTitle:@"貼上" action:@selector(myPaste:)];
    menu.menuItems = @[item1,item2];

    [menu setTargetRect:self.bounds inView:self];
//  [menu setTargetRect:self.frame inView:self.superview];
    
    [menu setMenuVisible:YES animated:YES];
    
}
#pragma mark - 對控制元件許可權進行設定
/**
 *  設定label可以成為第一響應者
 *
 *  @注意：不是每個控制元件都有資格成為第一響應者
 */
- (BOOL)canBecomeFirstResponder
{
    return YES;
}
/**
 *  設定label能夠執行那些具體操作
 *
 *  @param action 具體操作
 *
 *  @return YES:支援該操作
 */
- (BOOL)canPerformAction:(SEL)action withSender:(id)sender
{
//    NSLog(@"%@",NSStringFromSelector(action));
    
    if(action == @selector(cut:) || action == @selector(copy:) || action == @selector(myCut:)|| action == @selector(myPaste:)) return YES;
    return NO;
}

#pragma mark - 方法的實現
//- (void)cut:(id)sender
//{
//    
//    NSLog(@"%@",sender);
//    
//}

- (void)myCut:(UIMenuController *) menu
{
    NSLog(@"%s---%@",__func__,menu);
    //複製文字到剪下板
    [self copy:menu];
    //清空文字
    self.text = nil;
    
}

- (void)cut:(UIMenuController *)menu
{
    //複製文字到剪下板
    [self copy:menu];
    //清空文字
    self.text = nil;
    
}

- (void)copy:(UIMenuController *)menu
{
    //當沒有文字的時候呼叫這個方法會崩潰
     if (!self.text) return;
    //複製文字到剪下板
    UIPasteboard * paste = [UIPasteboard generalPasteboard];
    paste.string = self.text;

}

- (void)myPaste:(UIMenuController *)menu
{
    //將剪下板文字賦值給label
    UIPasteboard * paste = [UIPasteboard generalPasteboard];
    self.text = paste.string;
}
@end

• 示例程式碼2：UITableViewCell的使用

#import "ZZYTableViewCell.h"

@implementation ZZYTableViewCell

- (BOOL)canBecomeFirstResponder
{
    return YES;
}

@end

#import "ZZYTableViewController.h"
#import "ZZYTableViewCell.h"

@interface ZZYTableViewController ()
@property (nonatomic, weak) ZZYTableViewCell * selectCell;
@end

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
    //當menucontroller顯示，點選不同的cell時為什麼會顯示。
//    menuController的顯示依賴於第一響應者，當點選另外的cell時，當前cell取消第一響應者狀態，menucontroller自動消失
    UIMenuController * menu = [UIMenuController sharedMenuController];
    NSLog(@"%d",menu.isMenuVisible);
    //防止點選多次建立
    if (menu.isMenuVisible)
    {
        [menu setMenuVisible:NO animated:YES];
    }
    else
    {
    
    ZZYTableViewCell * cell = [tableView cellForRowAtIndexPath:indexPath];
        self.selectCell = cell;

    [cell becomeFirstResponder];
    
    UIMenuItem * item0 = [[UIMenuItem alloc]initWithTitle:@"分享" action:@selector(share:)];
    UIMenuItem * item1 = [[UIMenuItem alloc]initWithTitle:@"評論" action:@selector(comment:)];
    UIMenuItem * item2 = [[UIMenuItem alloc]initWithTitle:@"點贊" action:@selector(praise:)];
    menu.menuItems = @[item0,item1,item2];
    
    [menu setTargetRect:CGRectMake(0, cell.frame.size.height * 0.5, cell.frame.size.width, cell.frame.size.height) inView:cell];
    
    [menu setMenuVisible:YES animated:YES];
    }
}


- (void)share:(UIMenuController *)menu
{
    NSLog(@"%@",self.selectCell.textLabel.text);
}

- (void)comment:(UIMenuController *)menu
{
    
}

- (void)praise:(UIMenuController *)menu
{
    
}

//防止拖動tableView時產生的BUG
- (void)scrollViewWillBeginDragging:(UIScrollView *)scrollView
{
    UIMenuController * menu = [UIMenuController sharedMenuController];
    [menu setMenuVisible:NO animated:YES];
}