All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nervousync.commons.beans.image.MarkOptions Maven / Gradle / Ivy

There is a newer version: 1.0.1
Show newest version
/*
 * Licensed to the Nervousync Studio (NSYC) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.nervousync.commons.beans.image;

import java.awt.Color;
import java.awt.Image;

import javax.swing.ImageIcon;

import com.nervousync.commons.core.Globals;

/**
 * Image options for mark operate
 * @author Steven Wee	[email protected]
 * @version $Revision: 1.0 $ $Date: May 1, 2018 4:11:01 PM $
 */
public final class MarkOptions {
	
	/**
	 * Mark type
	 * @see com.nervousync.commons.beans.image.MarkOptions.MarkType
	 */
	private MarkType markType;
	/**
	 * Mark location define
	 * @see com.nervousync.commons.beans.image.MarkOptions.MarkLocation
	 */
	private MarkLocation markLocation;
	/**
	 * Mark image path if mark type is MarkType.ICON
	 */
	private String markPath = null;
	/**
	 * Mark image transparent value, default is 1, valid value is between 0 and 1
	 */
	private float transparency = 1f;
	/**
	 * Mark text value if mark type is MarkType.TEXT
	 */
	private String markText = null;
	/**
	 * Mark text color setting
	 */
	private Color color = Color.BLACK;
	/**
	 * Mark text font name
	 */
	private String fontName = null;
	/**
	 * Mark text font size
	 */
	private int fontSize = 12;
	
	private MarkOptions(MarkType markType, MarkLocation markLocation, 
			String markPath, float transparency, String markText, 
			Color color, String fontName, int fontSize) {
		this.markType = markType;
		this.markLocation = markLocation;
		this.markPath = markPath;
		this.transparency = transparency;
		this.markText = markText;
		this.color = color;
		this.fontName = fontName;
		this.fontSize = fontSize;
	}
	
	/**
	 * Initialize ICON MarkOptions
	 * @param markLocation		Mark location define
	 * @param markPath			Mark icon file path
	 * @param transparency		Icon transparent setting
	 * @return
	 */
	public static MarkOptions markIcon(MarkLocation markLocation, 
			String markPath, float transparency) {
		return new MarkOptions(MarkType.ICON, markLocation, markPath, transparency, null, null, 
				null, Globals.DEFAULT_VALUE_INT);
	}

	/**
	 * Initialize TEXT MarkOptions
	 * @param markLocation		Mark location define
	 * @param markText			Mark text value
	 * @param color				Mark text color
	 * @param fontName			Mark text font name
	 * @param fontSize			Mark text font size
	 * @return
	 */
	public static MarkOptions markText(MarkLocation markLocation, 
			String markText, Color color, String fontName, int fontSize) {
		return new MarkOptions(MarkType.TEXT, markLocation, null, Globals.DEFAULT_VALUE_FLOAT, 
				markText, color, fontName, fontSize);
	}

	/**
	 * @return the markType
	 */
	public MarkType getMarkType() {
		return markType;
	}

	/**
	 * @return the markLocation
	 */
	public MarkLocation getMarkLocation() {
		return markLocation;
	}

	/**
	 * @return the markPath
	 */
	public String getMarkPath() {
		return markPath;
	}

	/**
	 * @return the transparency
	 */
	public float getTransparency() {
		return transparency;
	}

	/**
	 * @return the markText
	 */
	public String getMarkText() {
		return markText;
	}

	/**
	 * @return the color
	 */
	public Color getColor() {
		return color;
	}

	/**
	 * @return the fontName
	 */
	public String getFontName() {
		return fontName;
	}

	/**
	 * @return the fontSize
	 */
	public int getFontSize() {
		return fontSize;
	}
	
	public MarkPosition retrievePosition(int width, int height) {
		int positionX = Globals.DEFAULT_VALUE_INT;
		int positionY = Globals.DEFAULT_VALUE_INT;
		switch (this.markType) {
		case ICON:
			ImageIcon imageIcon = new ImageIcon(this.markPath);
			Image iconImg = imageIcon.getImage();

			if (iconImg != null && this.transparency >= 0 
					&& this.transparency <= 1) {
				
				switch (this.markLocation) {
				case LEFT_TOP:
					positionX = 0;
					positionY = 0;
					break;
				case TOP:
					positionX = (width - iconImg.getWidth(null)) / 2;
					positionY = 0;
					break;
				case RIGHT_TOP:
					positionX = width - iconImg.getWidth(null);
					positionY = 0;
					break;
				case LEFT:
					positionX = 0;
					positionY = (height - iconImg.getHeight(null)) / 2; 
					break;
				case CENTER:
					positionX = (width - iconImg.getWidth(null)) / 2;
					positionY = (height - iconImg.getHeight(null)) / 2; 
					break;
				case RIGHT:
					positionX = width - iconImg.getWidth(null);
					positionY = (height - iconImg.getHeight(null)) / 2; 
					break;
				case LEFT_BOTTOM:
					positionX = 0;
					positionY = height - iconImg.getHeight(null); 
					break;
				case BOTTOM:
					positionX = (width - iconImg.getWidth(null)) / 2;
					positionY = height - iconImg.getHeight(null); 
					break;
				case RIGHT_BOTTOM:
					positionX = width - iconImg.getWidth(null);
					positionY = height - iconImg.getHeight(null); 
					break;
				}
			}
			break;
		case TEXT:
			if (this.markText != null && this.fontName != null
					&& this.fontSize > 0) {
				int textWidth = this.markText.length() * this.fontSize;
				int textHeight = this.fontSize;
				
				switch (this.markLocation) {
				case LEFT_TOP:
					positionX = 0;
					positionY = textHeight;
					break;
				case TOP:
					positionX = (width - textWidth) / 2;
					positionY = textHeight;
					break;
				case RIGHT_TOP:
					positionX = width - textWidth;
					positionY = textHeight;
					break;
				case LEFT:
					positionX = 0;
					positionY = (height + textHeight) / 2;
					break;
				case CENTER:
					positionX = (width - textWidth) / 2;
					positionY = (height + textHeight) / 2;
					break;
				case RIGHT:
					positionX = width - textWidth;
					positionY = (height + textHeight) / 2;
					break;
				case LEFT_BOTTOM:
					positionX = 0;
					positionY = height;
					break;
				case BOTTOM:
					positionX = (width - textWidth) / 2;
					positionY = height;
					break;
				case RIGHT_BOTTOM:
					positionX = width - textWidth;
					positionY = height;
					break;
				}
			}
			break;
		}
		
		if (positionX != Globals.DEFAULT_VALUE_INT && positionY != Globals.DEFAULT_VALUE_INT) {
			return new MarkPosition(positionX, positionY);
		}
		return null;
	}
		
	public static final class MarkPosition {
		
		private int positionX = Globals.DEFAULT_VALUE_INT;
		private int positionY = Globals.DEFAULT_VALUE_INT;
		
		public MarkPosition(int positionX, int positionY) {
			this.positionX = positionX;
			this.positionY = positionY;
		}

		/**
		 * @return the positionX
		 */
		public int getPositionX() {
			return positionX;
		}

		/**
		 * @return the positionY
		 */
		public int getPositionY() {
			return positionY;
		}
	}

	public enum MarkType {
		ICON, TEXT
	}
	
	public enum MarkLocation {
		LEFT_TOP, TOP, RIGHT_TOP, 
		LEFT, CENTER, RIGHT,
		LEFT_BOTTOM, BOTTOM, RIGHT_BOTTOM
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy