/**
 * Copyright 2010-2013 Jingjing Li.
 *
 * This file is part of jplot2d.
 *
 * jplot2d is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * jplot2d is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with jplot2d. If not, see .
 */
package org.jplot2d.element.impl;

import java.awt.Color;
import java.awt.Graphics2D;
import java.util.Map;

import org.jplot2d.element.PComponent;
import org.jplot2d.element.Element;

/**
 * Extended Component that all impl need to implements. Those additional methods is required by environment.
 * 
 * @author Jingjing Li
 * 
 */
public interface ComponentEx extends PComponent, ElementEx {

	public ContainerEx getParent();

	/*
	 * Returns true if the component is movable by mouse dragging. Only selectable component can be
	 * movable.
	 * 
	 * @return true if movable
	 */
	public boolean isMovable();

	/**
	 * Set the movable property.
	 */
	public void setMovable(boolean movable);

	/**
	 * Returns a map to tell why this component cannot be removed from its container. The key is the moored element,
	 * required by its value.
	 * 
	 * @return a map. The key is the element required by its value.
	 */
	public Map getMooringMap();

	/**
	 * Returns true if this component can contribute visible parts to plot rendering artifact when this
	 * component is visible. Subcomponents are not considered.
	 * 
	 * @return the indicator
	 */
	public boolean canContribute();

	/**
	 * Returns the effective color of this component.
	 * 
	 * @return the effective color of this component
	 */
	public Color getEffectiveColor();

	public String getEffectiveFontName();

	public int getEffectiveFontStyle();

	public float getEffectiveFontSize();

	public void parentEffectiveColorChanged();

	public void parentEffectiveFontChanged();

	/**
	 * Called when setColor() or parentEffectiveColorChanged() change the effective color of this component.
	 */
	public void thisEffectiveColorChanged();

	/**
	 * Called when setFontXxx() or parentEffectiveFontChanged() change the effective font of this component.
	 */
	public void thisEffectiveFontChanged();

	/**
	 * Returns true when this component need to be redrawn. The result only apply to cacheable component.
	 * 
	 * @return the redraw status
	 */
	public boolean isRedrawNeeded();

	/**
	 * Mark or clear the flag that indicate this component need to be redrawn, eg. when color changed.
	 * 
	 * @param flag
	 *            the flag that indicate this component need to be redrawn
	 */
	public void setRedrawNeeded(boolean flag);

	/**
	 * Draw this component only. All its children is not drawn.
	 * 
	 * @param g
	 *            to the Graphics2D drawing. The transformation of this component is not applied.
	 */
	public void draw(Graphics2D g);

	/**
	 * Create a deep copy of this component. The parent of the copy are not set.
	 * 
	 * @param orig2copyMap
	 *            original element to copy map
	 * @return a deep copy of this component
	 */
	public ComponentEx copyStructure(Map orig2copyMap);

}