bibliothek.gui.dock.util.BackgroundPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-core Show documentation
${project.name} is base or core library
There is a newer version: 1.1.2p6a
/*
 * Bibliothek - DockingFrames
 * Library built on Java/Swing, allows the user to "drag and drop"
 * panels containing any Swing-Component the developer likes to add.
 * 
 * Copyright (C) 2010 Benjamin Sigg
 * 
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Benjamin Sigg
 * [email protected]
 * CH - Switzerland
 */
package bibliothek.gui.dock.util;

import java.awt.Component;
import java.awt.Graphics;
import java.awt.LayoutManager;

import javax.swing.JPanel;

/**
 * This {@link JPanel} implements {@link PaintableComponent} and 
 * can use a {@link BackgroundAlgorithm} to paint its background.
 * @author Benjamin Sigg
 */
public class BackgroundPanel extends JPanel implements PaintableComponent{
	private BackgroundAlgorithm background;
	
	/** whether no pixels of this panel are painted */
	private boolean transparent;
	
	/**
	 * Creates a new panel.
	 * @param solid whether all pixels of this panel are painted
	 * @param transparent whether no pixels of this panel are painted
	 */
	public BackgroundPanel( boolean solid, boolean transparent ){
		setSolid( solid );
		this.transparent = transparent;
	}
	
	/**
	 * Creates a new panel setting a default {@link LayoutManager}.
	 * @param layout the layout manager, can be null
	 * @param solid whether all pixels of this panel are painted
	 * @param transparent whether no pixels of this panel are painted
	 */
	public BackgroundPanel( LayoutManager layout, boolean solid, boolean transparent ){
		super( layout );
		setSolid( solid );
		this.transparent = transparent;
	}
	
	/**
	 * Sets the background algorithm that should be used by this panel.
	 * @param background the background algorithm
	 */
	public void setBackground( BackgroundAlgorithm background ){
		this.background = background;
	}
	
	/**
	 * Gets the algorithm that paints the background of this panel.
	 * @return the algorithm, can be null
	 */
	public BackgroundAlgorithm getBackgroundAlgorithm(){
		return background;
	}
	
	@Override
	public void paint( Graphics g ){
		if( background == null || background.getPaint() == null ){
			super.paint( g );
			paintOverlay( g );
		}
		else{
			background.paint( this, g );
		}
	}

	protected void paintComponent( Graphics g ){
		paintBackground( g );
		paintForeground( g );
	}

	/**
	 * Sets whether this panel paints every pixel or not.
	 * @param solid true if every pixel is painted
	 */
	public void setSolid( boolean solid ){
		setOpaque( solid );
	}
	
	public boolean isSolid(){
		return isOpaque();
	}
	
	/**
	 * Sets whether this panel is completely transparent or not.
	 * @param transparent true if this panel does not paint any pixel
	 */
	public void setTransparent( boolean transparent ){
		this.transparent = transparent;
	}
	
	public boolean isTransparent(){
		return transparent;
	}
	
	public Component getComponent(){
		return this;
	}
	
	public void paintBackground( Graphics g ){
		super.paintComponent( g );
	}
	
	public void paintForeground( Graphics g ){
		// ignore	
	}
	
	@Override
	public void paintBorder( Graphics g ){
		super.paintBorder( g );
	}
	
	@Override
	public void paintChildren( Graphics g ){
		super.paintChildren( g );
	}
	
	public void paintOverlay( Graphics g ){
		// ignore
	}
}