001 /*
002 * ===========================================================================================
003 * = COPYRIGHT
004 *          PAX Computer Technology (Shenzhen) Co., Ltd. PROPRIETARY INFORMATION
005 *   This software is supplied under the terms of a license agreement or nondisclosure
006 *   agreement with PAX Computer Technology (Shenzhen) Co., Ltd. and may not be copied or
007 *   disclosed except in accordance with the terms in that agreement.
008 *     Copyright (C) 2017-2023 PAX Computer Technology (Shenzhen) Co., Ltd. All rights reserved.
009 * Description: // Detail description about the function of this module,
010 *             // interfaces with the other modules, and dependencies.
011 * Revision History:
012 * Date                         Author                        Action
013 * 2017/04/01                   PAX                     Create/Add/Modify/Delete
014 * ===========================================================================================
015 */
016 
017package com.pax.dal;
018
019import com.pax.dal.entity.EUartPort;
020import com.pax.dal.entity.SignPadResp;
021
022public interface ISignPad {
023
024    /**
025     * <div class="zh"> 请求签名 </div> <div class="en"> Request signature </div>
026     * 
027     * @param serial
028     *            <div class="zh"> 16位/8字节的特征码 </div> <div class="en"> 16/8 byte Characteristic code </div>
029     * @return {@link SignPadResp}
030     */
031    public SignPadResp signStart(String serial);
032
033    /**
034     * <div class="zh"> 签名版显示文字内容 </div> <div class="en"> display text content on singpad </div>
035     * 
036     * @param x
037     *            <div class="zh"> X坐标 </div> <div class="en"> X axes </div>
038     * @param y
039     *            <div class="zh"> Y坐标 </div> <div class="en"> Y axes </div>
040     * @param dataID
041     *            <div class="zh"> 文字内容ID </div> <div class="en"> content id </div>
042     * @param flag
043     *            <div class="zh"> 0：不刷屏 1：刷屏 </div> <div class="en"> 0：not Shuabing 1：Shuabing </div>
044     * @param confirm
045     *            <div class="zh"> 0：无需确认 1：需确认 </div> <div class="en"> 0：need not confirm 1：need confirm </div>
046     * @param displayTime
047     *            <div class="zh"> 显示时间 100ms的倍数 </div> <div class="en"> Display time: Multiple of 100ms </div>
048     * @return <div class="zh"> 1:成功 2:失败 </div> <div class="en"> 1:success 2:fail </div>
049     */
050    public int displayWord(int x, int y, byte dataID, byte flag, byte confirm, int displayTime);
051
052    /**
053     * <div class="zh"> 取消接收进程 </div> <div class="en"> cancel receive thread </div>
054     * 
055     * @return <div class="zh"> 1:成功 0: {@link IComm}连接为空 </div> <div class="en"> 1:success 0: {@link IComm} is null
056     *         </div>
057     */
058    public int cancel();
059
060    /**
061     * <div class="zh"> 外置签名版 返回待机界面 </div> <div class="en"> Return to standby interface </div>
062     * 
063     * @return <div class="zh"> 1:成功 0: 失败 </div> <div class="en"> 1:success 0:fail </div>
064     */
065    public int showIdleScreen();
066
067    /**
068     * <div class="zh"> 设置外置签名版的连接端口</div> <div class="en"> Set connection port of the external SignPad</div>
069     * 
070     * @param port
071     *            {@link EUartPort}
072     * @since V3.02.00
073     */
074    void setPort(EUartPort port);
075}