org.zkoss.zul.Area Maven / Gradle / Ivy

Go to download
/* Area.java

	Purpose:
		
	Description:
		
	History:
		Tue Mar 28 00:27:29     2006, Created by tomyeh

Copyright (C) 2006 Potix Corporation. All Rights Reserved.

{{IS_RIGHT
	This program is distributed under LGPL Version 2.1 in the hope that
	it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.zul;

import java.util.Objects;

import org.zkoss.zk.ui.AbstractComponent;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.UiException;
import org.zkoss.zk.ui.WrongValueException;

/**
 * An area of a {@link Imagemap}.
 *
 * @author tomyeh
 */
public class Area extends AbstractComponent {
	private String _shape;
	private String _coords;
	private String _tooltiptext;
	private Integer _tabindex;

	public Area() {
	}

	public Area(String coords) {
		setCoords(coords);
	}

	/** Returns the shape of this area.
	 * Default: null (means rectangle).
	 */
	public String getShape() {
		return _shape;
	}

	/** Sets the shape of this area.
	 *
	 * @exception WrongValueException if shape is not one of
	 * null, "rect", "rectangle", "circle", "circ", "polygon", and "poly".
	 */
	public void setShape(String shape) throws WrongValueException {
		if (shape != null)
			if (shape.isEmpty())
				shape = null;
			else if (!"rect".equals(shape) && !"rectangle".equals(shape) && !"circle".equals(shape)
					&& !"circ".equals(shape) && !"polygon".equals(shape) && !"poly".equals(shape))
				throw new WrongValueException("Unknown shape: " + shape);
		if (!Objects.equals(shape, _shape)) {
			_shape = shape;
			smartUpdate("shape", _shape);
		}
	}

	/**
	 * Returns null if not set.
	 * @return the tab order of this component
	 * @since 8.0.2
	 */
	public Integer getTabindexInteger() {
		return _tabindex;
	}

	/**
	 * Sets the tab order of this component. Removes the tabindex attribute if it's set to null.
	 * @param tabindex
	 */
	public void setTabindex(Integer tabindex) {
		if (!Objects.equals(_tabindex, tabindex)) {
			_tabindex = tabindex;
			smartUpdate("tabindex", tabindex);
		}
	}

	/** Returns the coordination of this area.
	 */
	public String getCoords() {
		return _coords;
	}

	/** Sets the coords of this area.
	 * Its content depends on {@link #getShape}:
	 * 

	 * circle
	 * coords="x,y,r"
	 * polygon
	 * coords="x1,y1,x2,y2,x3,y3..."

	 * The polygon is automatically closed, so it is not necessary to repeat
	 * the first coordination.
	 * rectangle
	 * coords="x1,y1,x2,y2"
	 * 
	 *
	 * Note: (0, 0) is the upper-left corner.
	 */
	public void setCoords(String coords) {
		if (coords != null && coords.length() == 0)
			coords = null;
		if (!Objects.equals(coords, _coords)) {
			_coords = coords;
			smartUpdate("coords", _coords);
		}
	}

	/** Returns the text as the tooltip.
	 * Default: null.
	 */
	public String getTooltiptext() {
		return _tooltiptext;
	}

	/** Sets the text as the tooltip.
	 */
	public void setTooltiptext(String tooltiptext) {
		if (tooltiptext != null && tooltiptext.length() == 0)
			tooltiptext = null;
		if (!Objects.equals(_tooltiptext, tooltiptext)) {
			_tooltiptext = tooltiptext;
			smartUpdate("tooltiptext", getTooltiptext());
		}
	}

	/** Default: not childable.
	 */
	protected boolean isChildable() {
		return false;
	}

	//-- super --//
	public void beforeParentChanged(Component parent) {
		if (parent != null && !(parent instanceof Imagemap))
			throw new UiException("Area's parent must be imagemap, not " + parent);
		super.beforeParentChanged(parent);
	}

	protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws java.io.IOException {
		super.renderProperties(renderer);

		render(renderer, "coords", _coords);
		render(renderer, "shape", _shape);
		render(renderer, "tooltiptext", _tooltiptext);
		if (_tabindex != null)
			renderer.render("tabindex", _tabindex);
	}
}