bundles/org.eclipse.draw2d/src/org/eclipse/draw2d/MarginBorder.java

/*******************************************************************************
 * Copyright (c) 2000, 2010 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.draw2d;

import org.eclipse.draw2d.geometry.Insets;

/**
 * A border that provides blank padding.
 */
public class MarginBorder extends AbstractBorder {

	/**
	 * This border's insets.
	 */
	protected Insets insets;

	/**
	 * Constructs a MarginBorder with dimensions specified by <i>insets</i>.
	 * 
	 * @param insets
	 *            The Insets for the border
	 * @since 2.0
	 */
	public MarginBorder(Insets insets) {
		this.insets = insets;
	}

	/**
	 * Constructs a MarginBorder with padding specified by the passed values.
	 * 
	 * @param t
	 *            Top padding
	 * @param l
	 *            Left padding
	 * @param b
	 *            Bottom padding
	 * @param r
	 *            Right padding
	 * @since 2.0
	 */
	public MarginBorder(int t, int l, int b, int r) {
		this(new Insets(t, l, b, r));
	}

	/**
	 * Constructs a MarginBorder with equal padding on all sides.
	 * 
	 * @param allsides
	 *            Padding size for all sides of the border.
	 * @since 2.0
	 */
	public MarginBorder(int allsides) {
		this(new Insets(allsides));
	}

	/**
	 * @see org.eclipse.draw2d.Border#getInsets(IFigure)
	 */
	public Insets getInsets(IFigure figure) {
		return insets;
	}

	/**
	 * This method does nothing, since this border is just for spacing.
	 * 
	 * @see org.eclipse.draw2d.Border#paint(IFigure, Graphics, Insets)
	 */
	public void paint(IFigure figure, Graphics graphics, Insets insets) {
	}

}