org.eclipse.osbp.ui.api/src/org/eclipse/osbp/ui/api/pos/ISignatureService.java

/*
 *                                                                            
 *  Copyright (c) 2011 - 2017 - Loetz GmbH & Co KG, 69115 Heidelberg, Germany 
 *                                                                            
 *  All rights reserved. This program and the accompanying materials           
 *  are made available under the terms of the Eclipse Public License v1.0       
 *  which accompanies this distribution, and is available at                  
 *  http://www.eclipse.org/legal/epl-v10.html                                 
 *                                                                            
 *  Initial contribution:                                                      
 *     Loetz GmbH & Co. KG                              
 * 
 */
package org.eclipse.osbp.ui.api.pos;

import java.awt.image.BufferedImage;

import org.eclipse.osbp.ui.api.customfields.IBlobService;

public interface ISignatureService {
	
	/**
	 * Open tablet.
	 *
	 * @param blobService the blob service
	 * @return true, if successful
	 */
	boolean openTablet(IBlobService blobService);
	
	/**
	 * Close tablet.
	 */
	void closeTablet();
	
	/**
	 * Clear tablet.
	 */
	void clearTablet();
	
	/**
	 * Sets the tablet labels, e.g. ok, clear, cancel
	 * allTexts must be pipe separated and must contain 3 elements.
	 * Must be called before openTablet 
	 *
	 * @param allLabels the new tablet labels
	 */
	void setTabletLabel(String allLabels);
	
	/**
	 * Adds the listener.
	 *
	 * @param listener the listener
	 */
	void addListener(ISignatureListener listener);
	
	/**
	 * Removes the listener.
	 *
	 * @param listener the listener
	 */
	void removeListener(ISignatureListener listener);
	
	/**
	 * Capture tablet signature. Enable notofications.
	 */
	void captureTablet();
	
	/**
	 * Idle tablet. No more notifications.
	 */
	void idleTablet();
	
	/**
	 * Sets the background image for the capturing screen.
	 *
	 * @param imageId the new capture image
	 */
	void setCaptureImage(String imageId);
	
	/**
	 * Adds the slide.
	 *
	 * @param slideName the slide name
	 */
	void addSlideTablet(String slideId);
	
	/**
	 * Sets the delay between each slide in mSec
	 *
	 * @param delay the new slide delay
	 */
	void setSlideDelay(long delay);
	
	/**
	 * Gets the signature blob as uuid from blobMapping.
	 *
	 * @param width the client-width it should be scaled to
	 * @param height the client-height it should be scaled to
	 * @return the signature blob
	 */
	String getSignatureBlob(int width, int height);
}