使用

• 初始化
  • 设置网络拉取键位数据接口实现
  • 设置自定义键位数据使用模式
  • 设置自定义键位布局使用模式
  • 日志选项
• 功能介绍
  • 安全键盘控件标准集成方式
  • 安全键盘控件UIViewController集成方式
  • 输入组件TMFSKCustomInputView接入

初始化

设置网络拉取键位数据接口实现

接口定义

+ (void)setFetchRemoteConfigDataNetHelper:(id<TMFSKGetKeyPositionNetHelper>)helper;

参数说明

示例代码

SKGetKeyDataImpl *helper = [SKGetKeyDataImpl new];
[TMFSafeKeyboardConfigApi setFetchRemoteConfigDataNetHelper:helper];

设置自定义键位数据使用模式

接口定义

+ (void)setKeyboardDataConfigMode:(TMFKeyboardConfigMode)configMode;

参数说明

示例代码

[TMFSafeKeyboardConfigApi setKeyboardDataConfigMode:TMFCONFIG_MODE_ONLINE];

设置自定义键位布局使用模式

接口定义

+ (void)setKeyboardLayoutConfigMode:(TMFKeyboardConfigMode)configMode;

参数说明

示例代码

[TMFSafeKeyboardConfigApi setKeyboardLayoutConfigMode:TMFCONFIG_MODE_ONLINE];

日志选项

TMFSafeKeyboard 定义了日志输出接口和日志级别定义，下面是配置组件日志的示例：

// AppDelegate.m
#if DEBUG
[TMFSafeKeyboardConfigApi setKeyboardLogLevels:TMFSafeKeyboardLogLevelAll];
#elif
[TMFSafeKeyboardConfigApi setKeyboardLogLevels:TMFSafeKeyboardLogLevelNone];
#endif

下面是只输出警告+错误的日志配置示例：

[TMFSafeKeyboardConfigApi setKeyboardLogLevels:(TMFSafeKeyboardLogLevelWarn | TMFSafeKeyboardLogLevelError)];

功能介绍

安全键盘控件标准集成方式

使用TMFSafeKeyboardWrapperApi自定义键盘：

/// #import "TMFSafeKeyboardWrapperApi.h"

TMFSafeKeyboard *keyboard       = [TMFSafeKeyboard new];

TMFSafeKeyboardWrapper *wrapper = [[TMFSafeKeyboardWrapper alloc] initWithKeyboard:keyboard];

[wrapper setKeyboardDelegate:self];

__weak typeof(self) weakself = self;

[TMFSafeKeyboardWrapperApi customKeyboardWithWrapper:wrapper inputView:textField completeCallback:^(NSData *context, NSString *text) {
    if (weakself == nil) {
        return;
    }
    // 解析数据...
}];

或更为便捷的：

/// #import "TMFSafeKeyboardWrapperApi.h"

[textField setupSafeKeyboardWithCompleteCallback:^(NSData *context, NSString *text) {
    if (weakself == nil) {
        return;
    }
    // 解析数据...
}];

TMFSafeKeyboard提供了丰富的自定义属性，可配置属性如下：

/// 键盘图标(18 * 20 pt)
- (void)setBrandIcon:(UIImage *)brandIcon;
/// 键盘标题
- (void)setBrandName:(NSString *)brandName;
/// 收起按钮(13 * 12 pt)
- (void)setCollapseIcon:(UIImage *)collapseIcon;
/// 收起按钮隐藏
- (void)setHiddenCollapseButton:(BOOL)hiddenCollapseButton;

/// 预览按下的字母键 默认：YES
@property (nonatomic, assign) BOOL canPreviewLetterKey;
/// 预览按下的符号键 默认：NO
@property (nonatomic, assign) BOOL canPreviewSymbolKey;
/// 键盘背景色
@property (nonatomic, copy) UIColor *backgroundColor;

/// 默认文字的颜色
@property (nonatomic, copy) UIColor *normalStateTextColor;
/// 按下文字的颜色
@property (nonatomic, copy) UIColor *focusStateTextColor;
/// 输入键文字的字体
@property (nonatomic, copy) UIFont *textFont;
/// 功能键文字的字体
@property (nonatomic, copy) UIFont *fnTextFont;
/// 边框宽度
@property (nonatomic, assign) CGFloat borderWidth;
/// 边框圆角半径
@property (nonatomic, assign) CGFloat borderCornerRadius;
/// 边框颜色
@property (nonatomic, copy) UIColor *borderColor;
/// 焦点边框颜色
@property (nonatomic, copy) UIColor *focusBorderColor;
/// 未按下去时的背景色
@property (nonatomic, copy) UIColor *contentKeyNormalBackgroundColor;
/// 按下去的背景色
@property (nonatomic, copy) UIColor *contentKeyPressBackgroundColor;
/// 未按下去时的背景图
@property (nonatomic, strong) UIImage *contentKeyNormalBackgroundImage;
/// 按下去的背景图
@property (nonatomic, strong) UIImage *contentKeyPressBackgroundImage;
/// fn未按下去时的背景色
@property (nonatomic, copy) UIColor *fnKeyNormalBackgroundColor;
/// fn按下去的背景色
@property (nonatomic, copy) UIColor *fnKeyPressBackgroundColor;
/// fn未按下去时的背景图
@property (nonatomic, strong) UIImage *fnKeyNormalBackgroundImage;
/// fn按下去的背景图
@property (nonatomic, strong) UIImage *fnKeyPressBackgroundImage;
/// enter未按下去时的背景色
@property (nonatomic, copy) UIColor *enterKeyNormalBackgroundColor;
/// enter按下去的背景色
@property (nonatomic, copy) UIColor *enterKeyPressBackgroundColor;
/// enter未按下去时的文本颜色
@property (nonatomic, copy) UIColor *enterKeyNormalStateTextColor;
/// enter按下去的的文本颜色
@property (nonatomic, copy) UIColor *enterKeyFocusStateTextColor;
/// enter未按下去时的背景图
@property (nonatomic, strong) UIImage *enterKeyNormalBackgroundImage;
/// enter按下去的背景图
@property (nonatomic, strong) UIImage *enterKeyPressBackgroundImage;
/// 普通状态下阴影高度
@property (nonatomic, assign) CGFloat shadowNormalStateHeight;
/// 按下状态下阴影高度
@property (nonatomic, assign) CGFloat shadowPressStateHeight;
/// 阴影颜色
@property (nonatomic, copy) UIColor *shadowColor;
/// 隐藏边框圆角 默认：0（不隐藏）
@property (nonatomic, assign) UIRectCorner hideCorners;
/// 竖屏按键的水平间隔 默认：13
@property (nonatomic, assign) CGFloat horizontalGapForPortrait;
/// 横屏按键的水平间隔 默认：6
@property (nonatomic, assign) CGFloat horizontalGapForLandscape;
/// 竖屏按键的垂直间隔 默认：4
@property (nonatomic, assign) CGFloat verticalGapForPortrait;
/// 横屏按键的垂直间隔 默认：4
@property (nonatomic, assign) CGFloat verticalGapForLandscape;
/// 竖屏时按键区域上下间隔 默认：{6,0,6,0}（刘海屏iPhone建议{0,0,24,0}）
@property (nonatomic, assign) UIEdgeInsets keyItemAreaPaddingForPortrait;
/// 横屏时按键区域上下间隔 默认：{0,0,0,0}
@property (nonatomic, assign) UIEdgeInsets keyItemAreaPaddingForLandscape;
/// 自动设置按键区域上下间隔 默认：YES
@property (nonatomic, assign) BOOL autoKeyItemAreaPadding;
/// 默认的按键区域最大的宽高比例（针对横屏情况） 默认：4.4（宽度4.4:高度1）
@property (nonatomic, assign) CGFloat keyItemAreaMaxAspectRatio;
/// 九宫格按键区域最大的宽高比例（针对iPad、横屏情况） 默认：4.4（宽度4.4:高度1）
@property (nonatomic, assign) CGFloat keyItemAreaMaxAspectRatioFor10Key;

安全键盘控件UIViewController集成方式

参数里面输入需要带上当前的界面对象（UIViewController），需要输入内容的输入框（实现了UIKeyInput协议的视图或UITextField），以及处理键盘输入监听处理。

/// #import "TMFSafeKeyboardWrapperApi.h"

TMFSafeKeyboard *keyboard       = [TMFSafeKeyboard new];

TMFSafeKeyboardWrapper *wrapper = [[TMFSafeKeyboardWrapper alloc] initWithKeyboard:keyboard];

[wrapper setKeyboardDelegate:self];

__weak typeof(self) weakself = self;

// self为UIViewController
[TMFSafeKeyboardWrapperApi customKeyboardWithWrapper:wrapper inputView:textField viewController:self completeCallback:^(NSData *context, NSString *text) {
    if (weakself == nil) {
        return;
    }
    // 解析数据...
}];

输入组件TMFSKCustomInputView接入

创建方式：

/// #import "TMFSKCustomInputView.h"

TMFSKCustomInputView *inputView = [[TMFSKCustomInputView alloc] initWithFrame:CGRectMake(0, 0, 100, 44) inputLength:6];

inputView.delegate = self;

控件提供了丰富的自定义属性配置：

/// 验证码位数
@property(nonatomic) int inputLength;
/// 字符之间的间隔
@property(nonatomic, assign) CGFloat charGap;
/// 字符文本尺寸
@property(nonatomic, assign) CGFloat textSize;
/// 设置是否显示明文
@property(nonatomic, getter=isShowPlainText) BOOL showPlainText;
/// 设置文字颜色
@property(nonatomic, strong)UIColor * textColor;
/// 是否显示边框
@property(nonatomic, getter=isShowBorder) BOOL showBorder;
/// 边框笔触宽度
@property(nonatomic, assign) CGFloat borderWidth;
/// 默认状态下边框颜色
@property(nonatomic, strong) UIColor *borderNormalStateColor;
/// 选中状态下边框颜色
@property(nonatomic, strong) UIColor *borderSelectedStateColor;
/// 设置边框圆角大小
@property(nonatomic) CGFloat borderCornerRadius;
/// 输入的内容
@property (nonatomic, strong, readonly) NSMutableString *text;
/// 光标的颜色
@property(nonatomic, strong) UIColor *cursorColor;
/// 光标的笔触宽度
@property(nonatomic, assign) CGFloat cursorStrokeWidth;