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 */ 016package com.pax.dal; 017 018import android.graphics.Bitmap; 019 020import com.pax.dal.entity.CustomerDisplayInfo; 021import com.pax.dal.exceptions.CustomerDisplayDevException; 022 023/** 024 * <div class="zh">顾客显示屏操作模块。注：仅部分机型支持，新机型将适配原生的Presentation功能。</div> 025 * <div class="en">Customer display operation module.Note: Only some models are supported. New models will be compatible with the native Presentation function.</div> 026 * @since V3.25.00 027 */ 028public interface ICustomerDisplay { 029 030 /** 031 * <div class="zh"> 获取顾客显示屏属性。</div> <div class="en"> Get customer display properties. </div> 032 * 033 * @return {@link CustomerDisplayInfo} 034 * @throws CustomerDisplayDevException CustomerDisplayDevException 035 * @since V3.25.00 036 */ 037 @Deprecated 038 CustomerDisplayInfo getProperty() throws CustomerDisplayDevException; 039 040 /** 041 * <div class="zh"> 设置顾客显示屏亮度。</div> <div class="en"> Set customer display brightness. </div> 042 * 043 * @param level <div class="zh"> 亮度。范围 0~10，0表示屏幕全黑。默认值6。</div> 044 * <div class="en"> Brightness. The range is 0 ~ 10, 0 means the screen is completely black. The default value is 6. </div> 045 * @throws CustomerDisplayDevException CustomerDisplayDevException 046 * @since V3.25.00 047 */ 048 void setBrightness(int level) throws CustomerDisplayDevException; 049 050 /** 051 * <div class="zh"> 设置顾客显示屏的背景图片。</div> <div class="en">Set the background image of the customer display. </div> 052 * 053 * @param x <div class="zh"> x坐标。</div> <div class="en"> X coordinates.</div> 054 * @param y <div class="zh"> y坐标。</div> <div class="en"> Y coordinates.</div> 055 * @param background <div class="zh"> 背景图像。如果图片像素超过屏幕，将按原图片比例进行缩放。只支持png格式。</div> 056 * <div class="en"> Background image. If the picture pixels exceed the screen, it will be scaled to the original picture scale. 057 * Only PNG format is supported.</div> 058 * @throws CustomerDisplayDevException CustomerDisplayDevException 059 * @since V3.25.00 060 */ 061 @Deprecated 062 void setBackgroundImage(int x, int y, Bitmap background) throws CustomerDisplayDevException; 063 064 /** 065 * <div class="zh"> 设置顾客显示屏的纯色背景。</div> <div class="en"> Set the solid background of the customer display.</div> 066 * 067 * @param color <div class="zh"> 068 * 069 * <ul> 070 * <li>0: 红色。</li> 071 * <li>1: 绿色。</li> 072 * <li>2: 蓝色。</li> 073 * <li>3: 黑色。</li> 074 * <li>4: 白色。</li> 075 * <li>5: 黄色。</li> 076 * <li>6: 灰色。</li> 077 * </ul> 078 * </div> 079 * <div class="en"> 080 * <ul> 081 * <li>0: RED.</li> 082 * <li>1: GREEN.</li> 083 * <li>2: BLUE.</li> 084 * <li>3: BLACK.</li> 085 * <li>4: WHITE.</li> 086 * <li>5: YELLOW.</li> 087 * <li>6: GRAY.</li> 088 * </ul> 089 * </div> 090 * @throws CustomerDisplayDevException CustomerDisplayDevException 091 * @since V3.25.00 092 */ 093 @Deprecated 094 void setBackgroundSolid(int color) throws CustomerDisplayDevException; 095 096 /** 097 * <div class="zh"> 设置顾客显示屏文字。</div> <div class="en"> Set the customer display text. </div> 098 * 099 * @param x <div class="zh"> x坐标。</div> <div class="en"> X coordinates.</div> 100 * @param y <div class="zh"> y坐标。</div> <div class="en"> Y coordinates.</div> 101 * @param text <div class="zh"> 要显示的文字。</div> <div class="en"> The text to display. </div> 102 * @param charset <div class="zh"> 文字的编码格式。为NULL表示UTF-8。</div> <div class="en"> The encoding format of the text. Null means UTF-8. </div> 103 * @throws CustomerDisplayDevException CustomerDisplayDevException 104 * @since V3.25.00 105 */ 106 @Deprecated 107 void setText(int x, int y, String text, String charset) throws CustomerDisplayDevException; 108 109 /** 110 * <div class="zh"> 清除客显屏指定区域。</div> <div class="en"> Clear the designated area of the Customer screen.</div> 111 * 112 * @param x <div class="zh"> x坐标。</div> <div class="en"> X coordinates.</div> 113 * @param y <div class="zh"> y坐标。</div> <div class="en"> Y coordinates.</div> 114 * @param width <div class="zh"> 清除宽度。 </div> <div class="en"> Clearance width.</div> 115 * @param height <div class="zh"> 清除高度。</div> <div class="en"> Clearance height.</div> 116 * @throws CustomerDisplayDevException CustomerDisplayDevException 117 * @since V3.25.00 118 */ 119 @Deprecated 120 void clear(int x, int y, int width, int height) throws CustomerDisplayDevException; 121 122 /** 123 * <div class="zh"> 设置顾客显示屏的字体。</div> <div class="en"> Set the font of the customer display.</div> 124 * 125 * @param style <div class="zh"> 126 * <ul> 127 * <li>0: 正常。</li> 128 * <li>1: 加粗。</li> 129 * <li>2: 斜体。</li> 130 * <li>3: 斜体加粗。</li> 131 * </ul> 132 * </div> 133 * <div class="en"> 134 * <ul> 135 * <li>0: normal.</li> 136 * <li>1: bold.</li> 137 * <li>2: italic.</li> 138 * <li>3: bold italic.</li> 139 * </ul> 140 * </div> 141 * @param height <div class="zh"> 字体高度。单位: 像素。</div> <div class="en"> Font height. Unit: pixel.</div> 142 * @throws CustomerDisplayDevException CustomerDisplayDevException 143 * @since V3.25.00 144 */ 145 @Deprecated 146 void setFont(int style, int height) throws CustomerDisplayDevException; 147 148 /** 149 * <div class="zh"> 启动顾客显示屏的签名板。 </div> <div class="en"> Start the signature board on the customer display. </div> 150 * 151 * @param timeout <div class="zh"> 超时时间。单位: 毫秒。</div> <div class="en"> Timeout. unit: millisecond.</div> 152 * @throws CustomerDisplayDevException CustomerDisplayDevException 153 * @since V3.25.00 154 */ 155 @Deprecated 156 void startSignBoard(int timeout) throws CustomerDisplayDevException; 157 158 /** 159 * <div class="zh"> 获取顾客显示屏的签名图像。</div> <div class="en"> Get the signature image of customer display. </div> 160 * 161 * @return <div class="zh"> 签名图像。 </div> <div class="en"> Signature image. </div> 162 * @throws CustomerDisplayDevException CustomerDisplayDevException 163 * @since V3.25.00 164 */ 165 @Deprecated 166 Bitmap getSignBoardImage() throws CustomerDisplayDevException; 167 168 /** 169 * <div class="zh">设置客显屏默认显示内容。</div> <div class="en">Set the default content displayed on the guest screen. </div> 170 * 171 * @param op 172 * <div class="zh"> 173 * <ul> 174 * <li>0: 删除客制化bitmap，系统将显示自带的bitmap， 此时bitmap可为null。</li> 175 * <li>1: 添加客制化bitmap作为默认显示内容。</li> 176 * </ul> 177 * </div> 178 * <div class="en"> 179 * <ul> 180 * <li>0: If you delete a customized bitmap, the system displays its own bitmap. In this case, the bitmap can be null</li> 181 * <li>1: Add customized bitmap as the default display content</li> 182 * </ul> 183 * </div> 184 * 185 * @param bitmap 186 * <div class="zh">作为默认显示内容的客制化bitmap </div> 187 * <div class="en">Customized bitmap as the default display content</div> 188 * 189 * @throws WLCustomerDisplayDevException 190 * 191 * @since V4.10.00 192 */ 193 void setDefaultBackgroundImage(int op, Bitmap bitmap) throws CustomerDisplayDevException; 194}