org.eclipse.gmf.runtime.draw2d.ui/src/org/eclipse/gmf/runtime/draw2d/ui/figures/RectangularDropShadowLineBorder.java

/******************************************************************************
 * Copyright (c) 2002, 2008 IBM Corporation 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:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.runtime.draw2d.ui.figures;

import org.eclipse.draw2d.Graphics;
import org.eclipse.draw2d.IFigure;
import org.eclipse.draw2d.geometry.Insets;
import org.eclipse.draw2d.geometry.Rectangle;
import org.eclipse.gmf.runtime.draw2d.ui.internal.figures.LineBorderEx;
import org.eclipse.gmf.runtime.draw2d.ui.mapmode.IMapMode;
import org.eclipse.gmf.runtime.draw2d.ui.mapmode.MapModeUtil;

/**
 * @author sshaw
 *
 */
public class RectangularDropShadowLineBorder
	extends LineBorderEx
	implements DropShadowBorder {

	// whether the shadow will be painted on this border also
	private boolean drawDropShadow = true;
	
	/**
	 * delegated <code>DropShadow</code> object that has the drop shadow logic.
	 */
	private static RectangularDropShadow dropShadow = new RectangularDropShadow();
 
	/**
	 * Constructs a LineBorder 
	 * of the specified width.
	 *
	 * @param w  Width of inset for border in logic points
	 * 
	 */
	public RectangularDropShadowLineBorder(int w) {
		super(w);
	}

	/**
	 * Constructs a DropShadowLineBorder with the foreground color and backgroud color
	 * of the figure that it is drawing the border for.
	 *
	 * 
	 */
	public RectangularDropShadowLineBorder() {
		super();
	}

	/**
	 * Method for determining the width of the drop shadow border will take up on the shape.
	 * @return int the width of the drop shadow
	 */
	protected int getShadowWidth() {
		if( shouldDrawDropShadow() == true )
		{
			return getDropShadow().getShadowWidth();
		}
		return 0;
		
	}

	/**
	 * Method for determining the height of the drop shadow border will take up on the shape.
	 * @return int the height of the drop shadow
	 */
	protected int getShadowHeight() {
		if( shouldDrawDropShadow() == true )
		{
			return getDropShadow().getShadowHeight();
		}
		return 0;
	}

	/**
	 * Method for determining the inset the border will take up on the shape.
	 * @param figure Figure that will be inset from the border
	 * @return Insets the Insets for the border on the given figure.
	 */
	public Insets getInsets(IFigure figure) {
		// take into account line width
		Insets insetsNew = new Insets(getWidth());		
		IMapMode mm = MapModeUtil.getMapMode(figure);
		insetsNew.bottom += mm.DPtoLP(getShadowHeight());
		insetsNew.right += mm.DPtoLP(getShadowWidth());

		return insetsNew;
	}

	/**
	 * Method shouldDrawShadow.  Determines if the shadow should be drawn 
	 * on the figure border.   Checks that a drop shadow is the preferred
	 * border, and that the drop shadow can be drawn on this figure.
	 * @param figure Figure that the border will be drawn on
	 * @return boolean true if the shadow should be drawn, false otherwise.
	 */
	protected boolean shouldDrawShadow(IFigure figure) {
		
		if (shouldDrawDropShadow()== false)
			return false;
		
		Rectangle rBox = figure.getBounds();

		// check to see if we can draw a shadow on this figure
		if (rBox.width < getShadowWidth() * 2
			|| rBox.height < getShadowHeight() * 2) {
			return false;
		}

		return true;
	}
	
	/**
	 * @see TransparentBorder#getTransparentInsets(IFigure)
	 */
	public Insets getTransparentInsets(IFigure figure) {
		Insets insetsNew = new Insets();
		
		insetsNew.top = 0;
		insetsNew.left = 0;
		insetsNew.bottom = MapModeUtil.getMapMode(figure).DPtoLP(getShadowHeight());
		insetsNew.right = MapModeUtil.getMapMode(figure).DPtoLP(getShadowWidth());

		return insetsNew;
	}

	/**
	 * Is this border Opaque or not.  
	 * @return boolean true if opaque, false otherwise
	 */
	public boolean isOpaque() {
		return false;
	}


	/**
	 * Method paintLineBorder.
	 * Painting the line border on the shape without the dropshadow.
	 * @param figure Figure that the border will be painted on
	 * @param g Graphics context 
	 * @param insets Insets value that contrains how the border will be painted.
	 */
	public void paintLineBorder(IFigure figure, Graphics g, Insets insets) {
		// will not paint line border if width is 0
		if (getWidth() > 0) { 
			tempRect.setBounds(getPaintRectangle(figure, insets));
			tempRect.shrink(getWidth()/2, getWidth()/2);
			g.setLineWidth(getWidth());
			g.setLineStyle(getStyle());
			g.drawRectangle(tempRect);			
		}
	}
	
	/**
	 * Paint the border of the figure with a dropshadow.
	 * @param figure Figure that the border will be painted on
	 * @param g Graphics context 
	 * @param insets Insets value that contrains how the border will be painted.
	 * @param rBox Rectangle representing figure bounds.
	 */
	public void paintDropShadowBorder(IFigure figure, Graphics g, Insets insets, Rectangle rBox) {

		//Draw the dropShadow.
		getDropShadow().drawShadow(figure,g,rBox);
		
		IMapMode mm = MapModeUtil.getMapMode(figure);
		
		//Draw the line border.				
		if (getWidth() > 0) { 
			//will not paint line border if width is 0
			tempRect.setBounds(getPaintRectangle(figure, insets));
			tempRect.width -= mm.DPtoLP(getShadowWidth());
			tempRect.height -= mm.DPtoLP(getShadowHeight());
			tempRect.shrink(getWidth() / 2, getWidth() / 2);
			g.setLineWidth(getWidth());	
			g.setLineStyle(getStyle());

			if (getColor() != null) {
				g.setForegroundColor(getColor());
			} else {
				g.setForegroundColor(figure.getForegroundColor());
			}
			g.drawRectangle(tempRect);
		}
	}

	/**
	 * Overridden method for painting the border on the shape.
	 * @param figure Figure that the border will be painted on
	 * @param g Graphics context 
	 * @param insets Insets value that constrains how the border will be painted.
	 */
	public void paint(IFigure figure, Graphics g, Insets insets) {

		Rectangle rBox = new Rectangle(figure.getBounds());

		// draw drop shadow border
		if (shouldDrawShadow(figure)) {
			paintDropShadowBorder(figure, g, insets, rBox);			
		}
		//draw line border
		else{			
			paintLineBorder(figure, g, insets);
		}		
	}
	
	/* 
	 * @see org.eclipse.gmf.runtime.gef.ui.internal.figures.DropShadowBorder#drawDropShadow()
	 */
	public boolean shouldDrawDropShadow() {		
		return this.drawDropShadow;
	}

	/* 
	 * @see org.eclipse.gmf.runtime.gef.ui.internal.figures.DropShadowBorder#drawDropShadow(boolean)
	 */
	public void setShouldDrawDropShadow(boolean bDrawDropShadow) {
		this.drawDropShadow=bDrawDropShadow;
	}

	/**
	 * @return Returns the drop shadow image.
	 */
	protected RectangularDropShadow getDropShadow() {
		return dropShadow;
	}

}