/* 
 * Copyright (c) 2008 Stiftung Deutsches Elektronen-Synchrotron, 
 * Member of the Helmholtz Association, (DESY), HAMBURG, GERMANY.
 *
 * THIS SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "../AS IS" BASIS. 
 * WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED 
 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR PARTICULAR PURPOSE AND 
 * NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 
 * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR 
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. SHOULD THE SOFTWARE PROVE DEFECTIVE 
 * IN ANY RESPECT, THE USER ASSUMES THE COST OF ANY NECESSARY SERVICING, REPAIR OR 
 * CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. 
 * NO USE OF ANY SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
 * DESY HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, 
 * OR MODIFICATIONS.
 * THE FULL LICENSE SPECIFYING FOR THE SOFTWARE THE REDISTRIBUTION, MODIFICATION, 
 * USAGE AND OTHER RIGHTS AND OBLIGATIONS IS INCLUDED WITH THE DISTRIBUTION OF THIS 
 * PROJECT IN THE FILE LICENSE.HTML. IF THE LICENSE IS NOT INCLUDED YOU MAY FIND A COPY 
 * AT HTTP://WWW.DESY.DE/LEGAL/LICENSE.HTM
 */
package org.csstudio.sds.components.model;

import org.csstudio.sds.model.AbstractWidgetModel;
import org.csstudio.sds.model.WidgetPropertyCategory;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;

/**
 * An image widget model.
 * 
 * @author jbercic, Xihui Chen
 * 
 */
public final class ImageModel extends AbstractWidgetModel {
	/**
	 * Unique identifier.
	 */
	public static final String ID = "org.csstudio.sds.components.Image";

	/**
	 * The ID of the <i>filename</i> property.
	 */
	public static final String PROP_FILENAME = "filename";
	/**
	 * The ID of the <i>topcrop</i> property.
	 */
	public static final String PROP_TOPCROP = "crop.top";
	/**
	 * The ID of the <i>bottomcrop</i> property.
	 */
	public static final String PROP_BOTTOMCROP = "crop.bottom";
	/**
	 * The ID of the <i>leftcrop</i> property.
	 */
	public static final String PROP_LEFTCROP = "crop.left";
	/**
	 * The ID of the <i>rightcrop</i> property.
	 */
	public static final String PROP_RIGHTCROP = "crop.right";
	/**
	 * The ID of the <i>stretch</i> property.
	 */
	public static final String PROP_STRETCH = "stretch";
	/**
	 * The ID of the <i>autosize</i> property.
	 */
	public static final String PROP_AUTOSIZE = "autosize";

	/**
	 * The ID of the <i>stop animation</i> property.
	 */
	public static final String PROP_STOP_ANIMATION = "stopanimation";

	/**
	 * The default value for the file extensions.
	 */
	private static final String[] FILE_EXTENSIONS = new String[] { "jpg", "jpeg", "gif", "bmp", "png" };

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getTypeID() {
		return ID;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void configureProperties() {
		// addProperty(PROP_FILENAME, new
		// StringProperty("File Name",WidgetPropertyCategory.Image,""));
		addResourceProperty(PROP_FILENAME, "File", WidgetPropertyCategory.IMAGE, new Path(""), FILE_EXTENSIONS, false);
		addIntegerProperty(PROP_TOPCROP, "Crop Top", WidgetPropertyCategory.IMAGE, 0, false);
		addIntegerProperty(PROP_BOTTOMCROP, "Crop Bottom", WidgetPropertyCategory.IMAGE, 0, false);
		addIntegerProperty(PROP_LEFTCROP, "Crop Left", WidgetPropertyCategory.IMAGE, 0, false);
		addIntegerProperty(PROP_RIGHTCROP, "Crop Right", WidgetPropertyCategory.IMAGE, 0, false);
		addBooleanProperty(PROP_STRETCH, "Stretch to Fit", WidgetPropertyCategory.IMAGE, false, false);
		addBooleanProperty(PROP_AUTOSIZE, "Auto Size", WidgetPropertyCategory.IMAGE, true, false);
		addBooleanProperty(PROP_STOP_ANIMATION, "Stop Animation", WidgetPropertyCategory.IMAGE, false, false);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected String getDefaultToolTip() {
		StringBuffer buffer = new StringBuffer();
		buffer.append(createTooltipParameter(PROP_ALIASES) + "\n");
		buffer.append("Image:\t");
		buffer.append(createTooltipParameter(PROP_FILENAME));
		return buffer.toString();
	}

	/**
	 * Returns the path to the specified file.
	 * 
	 * @return The path to the specified file
	 */
	public IPath getFilename() {
		return getResourceProperty(PROP_FILENAME);
	}

	/**
	 * Returns the amount of pixels, which should be cropped from the top edge
	 * of the image.
	 * 
	 * @return The amount of pixels
	 */
	public int getTopCrop() {
		return getIntegerProperty(PROP_TOPCROP);
	}

	/**
	 * Returns the amount of pixels, which should be cropped from the bottom
	 * edge of the image.
	 * 
	 * @return The amount of pixels
	 */
	public int getBottomCrop() {
		return getIntegerProperty(PROP_BOTTOMCROP);
	}

	/**
	 * Returns the amount of pixels, which should be cropped from the left edge
	 * of the image.
	 * 
	 * @return The amount of pixels
	 */
	public int getLeftCrop() {
		return getIntegerProperty(PROP_LEFTCROP);
	}

	/**
	 * Returns the amount of pixels, which should be cropped from the right edge
	 * of the image.
	 * 
	 * @return The amount of pixels
	 */
	public int getRightCrop() {
		return getIntegerProperty(PROP_RIGHTCROP);
	}

	/**
	 * Returns if the image should be stretched.
	 * 
	 * @return True is it should be stretched, false otherwise
	 */
	public boolean getStretch() {
		return getBooleanProperty(PROP_STRETCH);
	}

	/**
	 * @return True if the widget should be auto sized according the image size.
	 */
	public boolean isAutoSize() {
		return getBooleanProperty(PROP_AUTOSIZE);
	}

	/**
	 * @return True if the animation is stopped.
	 */
	public boolean isStopAnimation() {
		return getBooleanProperty(PROP_STOP_ANIMATION);
	}
}