wikitext/core/org.eclipse.mylyn.wikitext/src/main/java/org/eclipse/mylyn/wikitext/parser/ImageAttributes.java

/*******************************************************************************
 * Copyright (c) 2007, 2011 David Green and others.
 * 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
 *
 * Contributors:
 *     David Green - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.wikitext.parser;

/**
 * Attributes for images.
 *
 * @author David Green
 * @since 3.0
 */
public class ImageAttributes extends Attributes {

	public enum Align {
		Left, Right, Top, Texttop, Middle, Absmiddle, Baseline, Bottom, Absbottom, Center
	}

	private int width = -1;

	private boolean widthPercentage = false;

	private int height = -1;

	private boolean heightPercentage = false;

	private int border = 0;

	private Align align = null;

	private String alt;

	public String getAlt() {
		return alt;
	}

	public void setAlt(String alt) {
		this.alt = alt;
	}

	public int getWidth() {
		return width;
	}

	public void setWidth(int width) {
		this.width = width;
	}

	public int getHeight() {
		return height;
	}

	public void setHeight(int height) {
		this.height = height;
	}

	public int getBorder() {
		return border;
	}

	public void setBorder(int border) {
		this.border = border;
	}

	public Align getAlign() {
		return align;
	}

	public void setAlign(Align align) {
		this.align = align;
	}

	/**
	 * Sets whether the value passed into {@link #setWidth(int)} should be treated as a percentage or as a number of
	 * pixels. The default is false (pixels) to maintain backwards compatibility.
	 *
	 * @param widthPercentage
	 *            pass true if the width is specified as a percentage, false if the width is specified in pixels
	 */
	public void setWidthPercentage(boolean widthPercentage) {
		this.widthPercentage = widthPercentage;
	}

	/**
	 * Tells you whether the value returned from {@link #getWidth()} is the width as a percentage or in pixels.
	 *
	 * @return true if the width should be treated as a percentage, false if the width should be treated as an amount of
	 *         pixels
	 */
	public boolean isWidthPercentage() {
		return widthPercentage;
	}

	/**
	 * Sets whether the value passed into {@link #setHeight(int)} should be treated as a percentage or as a number of
	 * pixels. The default is false (pixels) to maintain backwards compatibility.
	 *
	 * @param heightPercentage
	 *            pass true if the height is specified as a percentage, false if the height is specified in pixels
	 */
	public void setHeightPercentage(boolean heightPercentage) {
		this.heightPercentage = heightPercentage;
	}

	/**
	 * Tells you whether the value returned from {@link #getHeight()} is the height as a percentage or in pixels.
	 *
	 * @return true if the height should be treated as a percentage, false if the height should be treated as an amount
	 *         of pixels
	 */
	public boolean isHeightPercentage() {
		return heightPercentage;
	}
}