com.jgraph.layout.JGraphCompoundLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ingeniasjgraphmod Show documentation
A modified version of some JGraph files
The newest version!
/*
 * $Id: JGraphCompoundLayout.java,v 1.1 2009/09/25 15:14:15 david Exp $
 * Copyright (c) 2001-2005, Gaudenz Alder
 * 
 * All rights reserved. 
 * 
 * This file is licensed under the JGraph software license, a copy of which
 * will have been provided to you in the file LICENSE at the root of your
 * installation directory. If you are unable to locate this file please
 * contact JGraph sales for another copy.
 */
package com.jgraph.layout;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

/**
 * This allows to recursively compose any number of abstract layouts into a
 * compound abstract layout. Note that this is more flexible than a decorator
 * pattern, because you can use different class hierarchies to implement the
 * input (facade) and the layout algorithms, while adhering to the rule that
 * each layout algorithm uses the output of the last layout as its input.
 */
public class JGraphCompoundLayout implements JGraphLayout {

	/**
	 * Holds all layouts.
	 */
	protected List layouts = new ArrayList();

	/**
	 * Default constructor
	 */
	public JGraphCompoundLayout() {
	}

	/**
	 * Constructs a compound layout consisting of the specified first- and
	 * secondStep.
	 */
	public JGraphCompoundLayout(JGraphLayout[] layouts) {
		this.layouts.addAll(Arrays.asList(layouts));
	}

	/**
	 * Runs all layouts in the order they were inserted. Note: The facade
	 * encapsulates the input and output of the algorithm, thus ensuring that
	 * each algorithm runs on the outcome of preceding algorithm.
	 */
	public void run(JGraphFacade graph) {
		Iterator it = layouts.iterator();
		while (it.hasNext()) {
			Object layout = it.next();
			if (layout instanceof JGraphLayout)
				((JGraphLayout) layout).run(graph);
		}
	}

	/**
	 * Adds a layout to {@link #layouts}.
	 * 
	 * @param layout
	 *            The layout to add.
	 */
	public void add(JGraphLayout layout) {
		layouts.add(layout);
	}

	/**
	 * Removes a layout from {@link #layouts}
	 * 
	 * @param layout
	 *            The layout to remove.
	 */
	public void remove(JGraphLayout layout) {
		layouts.remove(layout);
	}

	/**
	 * Returns the list of layouts.
	 * 
	 * @return Returns the list of layouts.
	 */
	public List getLayouts() {
		return layouts;
	}

}