org.eclipse.osbp.ui.api/src/org/eclipse/osbp/ui/api/customfields/IBlobUploadComponent.java

/*
 *                                                                            
 *  Copyright (c) 2011 - 2016 - 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.customfields;

import java.util.List;

import org.eclipse.e4.core.services.events.IEventBroker;

import com.vaadin.server.Resource;
import com.vaadin.ui.Label;

public interface IBlobUploadComponent {
	public enum BUTTON_ALIGNMENT {
		TOP, BUTTOM, LEFT, RIGHT, DEFAULT
	}

	/**
	 * Enables the upload button.
	 *
	 * @param uploadButton
	 *            the upload button
	 */
	void enableUploadButton(boolean uploadButton);

	/**
	 * Sets the resolution for the blob to be displayed via resolution id
	 * 
	 * @param displayResolutionId
	 */
	void setDisplayResolutionId(int displayResolutionId);
	
	/**
	 * Sets the resolution for the blob to be displayed via resolution string
	 *
	 * @param displayResolution the new display resolution
	 */
	void setDisplayResolution(String displayResolution);
	/**
	 * Sets the uuid for the blob to be displayed
	 * 
	 * @param uniqueName
	 */
	void setUploadedUniqueName(String uniqueName);

	/**
	 * Sets the firmly linked.
	 *
	 * @param firmlyLinked
	 *            the new firmly linked
	 */
	void setFirmlyLinked(boolean firmlyLinked);

	/**
	 * Checks if component is firmly linked.
	 *
	 * @return true, if is firmly linked
	 */
	boolean isFirmlyLinked();

	/**
	 * Sets the event broker.
	 *
	 * @param eventBroker the new event broker
	 */
	void setEventBroker(IEventBroker eventBroker);

	/**
	 * Sets the display image label.
	 *
	 * @param displayImageLabel the new display image label
	 */
	void setDisplayImageLabel(Label displayImageLabel);

	/**
	 * Sets the button alignment.
	 *
	 * @param buttonAlignment the new button alignment
	 */
	void setUploadButtonAlignment(BUTTON_ALIGNMENT buttonAlignment);

	/**
	 * Checks if is unique name enabled.
	 *
	 * @return true, if is unique name enabled
	 */
	boolean isUniqueNameEnabled();

	/**
	 * Sets the unique name enabled.
	 *
	 * @param uniqueNameEnabled the new unique name enabled
	 */
	void setUniqueNameEnabled(boolean uniqueNameEnabled);
	
	/**
	 * Sets the upload component label.
	 *
	 * @param label the new blob upload comp label
	 */
	void setBlobUploadCompLabel(Label label);
	
	/**
	 * Sets the upload button caption.
	 *
	 * @param buttonCaption the new upload button caption
	 */
	void setUploadButtonCaption(String buttonCaption);
	
	/**
	 * Sets the upload icon.
	 *
	 * @param uploadIcon the new upload icon
	 */
	void setUploadIcon(Resource uploadIcon);
	
	/**
	 * Sets the download icon.
	 *
	 * @param downloadIcon the new download icon
	 */
	void setDownloadIcon(Resource downloadIcon);
	
	/**
	 * Sets the upload accepted mime types.
	 *
	 * @param mimeTypes the new upload accepted mime types
	 */
	void setUploadAcceptedMimeTypes(List<String> mimeTypes);
	
}