visualization/plugins/org.eclipse.mylar.zest.core/src/org/eclipse/mylar/zest/core/internal/viewers/figures/PaneFigure.java

/*******************************************************************************
 * Copyright 2005-2006, CHISEL Group, University of Victoria, Victoria, BC, Canada.
 * 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:
 *     The Chisel Group, University of Victoria
 *******************************************************************************/
package org.eclipse.mylar.zest.core.internal.viewers.figures;

import org.eclipse.draw2d.ActionEvent;
import org.eclipse.draw2d.ActionListener;
import org.eclipse.draw2d.ColorConstants;
import org.eclipse.draw2d.FreeformLayout;
import org.eclipse.draw2d.IFigure;
import org.eclipse.draw2d.Label;
import org.eclipse.draw2d.Panel;
import org.eclipse.draw2d.geometry.Dimension;
import org.eclipse.draw2d.geometry.Rectangle;
import org.eclipse.mylar.zest.core.internal.graphmodel.nested.NestedPane;
import org.eclipse.mylar.zest.core.internal.nestedgraphviewer.parts.FigureGridLayout;
import org.eclipse.mylar.zest.core.messages.ZestUIMessages;

/**
 * 
 * Basic figure for creating panes in the nested graph viewer. Can be one of
 * three types: NestedPane.SUPPLIER_PANE, NestedPane.CLIENT_PANE,
 * or NestedPain.MAIN_PANE. The main pane contains the nested graph element that
 * the user is currently focussed on. The supplier pane contains all nodes that
 * have arcs running "from" that node "to" the focus node, or any of its children.
 * The client pane contains all nodes that have arcs running "to" that node "from"
 * the focus node or any of its children.
 * @author Del Myers
 */

//@tag zest(bug(152613-Client-Supplier(fix))) : the basic panes that will contain the nested graphs.
public class PaneFigure extends Panel {
	private static final int ICON_SIZE = 16;
	private Label label;
	private MinMaxFigure minMax;
	private Panel clientArea;
	private int type;
	public PaneFigure(int type) {
		super();
		this.type = type;
		clientArea = new Panel();
		
		setLayoutManager(new FreeformLayout(){
			/* (non-Javadoc)
			 * @see org.eclipse.draw2d.XYLayout#layout(org.eclipse.draw2d.IFigure)
			 */
			public void layout(IFigure parent) {
				Rectangle textbounds = (label != null) ? label.getTextBounds() : new Rectangle(0,0,0,0);
				
				Rectangle parentBounds = parent.getBounds();
				if (label != null) label.setSize(parent.getSize().width, textbounds.height);
				clientArea.setBounds(new Rectangle(parentBounds.x, parentBounds.y+textbounds.height, parent.getSize().width, parent.getSize().height-textbounds.height));
				//@tag zest(bug(152613-Client-Supplier(fix))) : allow the icon to have a say in the size of the figure.
				if (minMax != null) {
					Object constraint = getConstraint(minMax);
					if (constraint instanceof Dimension) {
						Dimension d = (Dimension)constraint;
						minMax.setBounds(new Rectangle(parentBounds.x+parentBounds.width-d.width, parentBounds.y, d.width, d.height));
						label.setSize(label.getSize().width, d.height);
					}
				}
			}
			
			/* (non-Javadoc)
			 * @see org.eclipse.draw2d.AbstractLayout#getPreferredSize(org.eclipse.draw2d.IFigure, int, int)
			 */
			//@tag zest(bug(152613-Client-Supplier(fix))) : preferred size should be set by the layout manager, as it is what is doing the layout.
			public Dimension getPreferredSize(IFigure container, int wHint, int hHint) {
				int labelHeight = 0;
				int labelWidth = wHint;
				int clientHeight = 0;
				if (label != null) {
					labelHeight = label.getTextBounds().height;
					labelWidth = label.getTextBounds().width;
					if (minMax != null && minMax.getSize().height > labelHeight) {
						labelHeight = minMax.getSize().height;
					}
				}
				if (!isClosed()) {
					if (hHint >= labelHeight) {
						clientHeight = hHint-labelHeight;
					}
				}
				return new Dimension(labelWidth, labelHeight+clientHeight);
			}
		});
		clientArea.setBackgroundColor(ColorConstants.white);
		clientArea.setLayoutManager(new FigureGridLayout());
		clientArea.setOpaque(true);
		super.add(clientArea, null, -1);
		if (type != NestedPane.MAIN_PANE) {
			label = new Label();
			label.setBackgroundColor(ColorConstants.darkBlue);
			label.setText(getTextForType(type));
			label.setOpaque(true);
			label.setForegroundColor(ColorConstants.lightGray);
			minMax = new MinMaxFigure();
			super.add(label, null, -1);
			super.add(minMax, new Dimension(ICON_SIZE, ICON_SIZE), -1);
			minMax.setVisible(true);
			minMax.addActionListener(new ActionListener(){
				public void actionPerformed(ActionEvent event) {
					invalidateTree();
					revalidate();
				}});
		}
		
		invalidate();
		
	}
	/**
	 * @param paneType2
	 * @return
	 */
	private String getTextForType(int paneType) {
		switch(paneType) {
		case NestedPane.CLIENT_PANE: return ZestUIMessages.VIEW_NESTED_CLIENT_PANE;
		case NestedPane.SUPPLIER_PANE: return ZestUIMessages.VIEW_NESTED_SUPPLIER_PANE;
		}
		return "";
	}
	
	public Panel getClientPanel() {
		return clientArea;
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.draw2d.Figure#add(org.eclipse.draw2d.IFigure, java.lang.Object, int)
	 */
	public void add(IFigure figure, Object constraint, int index) {
		//add to the client area so that the title is visible.
		clientArea.add(figure, constraint, index);
	}
	/* (non-Javadoc)
	 * @see org.eclipse.draw2d.Figure#remove(org.eclipse.draw2d.IFigure)
	 */
	public void remove(IFigure figure) {
		if (clientArea.getChildren().contains(figure)){
			clientArea.remove(figure);
			return;
		}
		super.remove(figure);
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.draw2d.Figure#removeAll()
	 *
	public void removeAll() {
		clientArea.removeAll();
	}*/
	
	/**
	 * @return the type
	 */
	public int getType() {
		return type;
	}
	
	/**
	 * Allows the pane to be open or to be closed. This is only valid in
	 * SUPPLIER_PANE and CLIENT_PANE types.
	 * @param closed whether or not the content pane should be closed.
	 */
	public void setClosed(boolean closed) {
		if (closed != isClosed()) {
			if (minMax != null) {
				minMax.setMax(closed);
				invalidate();
			}
		}
	}
	
	/**
	 * 
	 * @return whether or not the content pane is closed.
	 */
	public boolean isClosed() {
		return (minMax != null && minMax.isMax());
	}
	
	
	
	/* (non-Javadoc)
	 * @see org.eclipse.draw2d.Figure#getClientArea(org.eclipse.draw2d.geometry.Rectangle)
	 */
/*	public Rectangle getClientArea(Rectangle rect) {
		Rectangle client = getClientPanel().getClientArea();
		rect.x = client.x;
		rect.y = client.y;
		rect.width = client.width;
		rect.height = client.height;
		return rect;
	}*/
}