BorderFilter.java

/*
Copyright 2006 Jerry Huxtable

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.jhlabs.image;

import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.RenderingHints;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;

/**
 * A filter to add a border around an image using the supplied Paint, which may be null for no painting.
 */
public class BorderFilter extends AbstractBufferedImageOp {

	private int leftBorder, rightBorder;
	private int topBorder, bottomBorder;
	private Paint borderPaint;

    /**
     * Construct a BorderFilter which does nothing.
     */
	public BorderFilter() {
	}

    /**
     * Construct a BorderFilter.
	 * @param leftBorder the left border value
	 * @param topBorder the top border value
	 * @param rightBorder the right border value
	 * @param bottomBorder the bottom border value
	 * @param borderPaint the paint with which to fill the border
     */
	public BorderFilter( int leftBorder, int topBorder, int rightBorder, int bottomBorder, Paint borderPaint ) {
		this.leftBorder = leftBorder;
		this.topBorder = topBorder;
		this.rightBorder = rightBorder;
		this.bottomBorder = bottomBorder;
		this.borderPaint = borderPaint;
	}

	/**
	 * Set the border size on the left edge.
	 * @param leftBorder the number of pixels of border to add to the edge
     * @min-value 0
     * @see #getLeftBorder
	 */
	public void setLeftBorder(int leftBorder) {
		this.leftBorder = leftBorder;
	}
	
    /**
     * Returns the left border value.
     * @return the left border value.
     * @see #setLeftBorder
     */
 	public int getLeftBorder() {
		return leftBorder;
	}
	
	/**
	 * Set the border size on the right edge.
	 * @param rightBorder the number of pixels of border to add to the edge
     * @min-value 0
     * @see #getRightBorder
	 */
	public void setRightBorder(int rightBorder) {
		this.rightBorder = rightBorder;
	}
	
    /**
     * Returns the right border value.
     * @return the right border value.
     * @see #setRightBorder
     */
	public int getRightBorder() {
		return rightBorder;
	}
	
	/**
	 * Set the border size on the top edge.
	 * @param topBorder the number of pixels of border to add to the edge
     * @min-value 0
     * @see #getTopBorder
	 */
	public void setTopBorder(int topBorder) {
		this.topBorder = topBorder;
	}

    /**
     * Returns the top border value.
     * @return the top border value.
     * @see #setTopBorder
     */
	public int getTopBorder() {
		return topBorder;
	}

	/**
	 * Set the border size on the bottom edge.
	 * @param bottomBorder the number of pixels of border to add to the edge
     * @min-value 0
     * @see #getBottomBorder
	 */
	public void setBottomBorder(int bottomBorder) {
		this.bottomBorder = bottomBorder;
	}

    /**
     * Returns the border border value.
     * @return the border border value.
     * @see #setBottomBorder
     */
	public int getBottomBorder() {
		return bottomBorder;
	}

	/**
	 * Set the border paint.
	 * @param borderPaint the paint with which to fill the border
     * @see #getBorderPaint
	 */
	public void setBorderPaint( Paint borderPaint ) {
		this.borderPaint = borderPaint;
	}

	/**
	 * Get the border paint.
	 * @return the paint with which to fill the border
     * @see #setBorderPaint
	 */
	public Paint getBorderPaint() {
		return borderPaint;
	}

        @Override
	public BufferedImage filter( BufferedImage src, BufferedImage dst ) {
		int width = src.getWidth();
		int height = src.getHeight();

		if ( dst == null ) {
                    dst = new BufferedImage( width+leftBorder+rightBorder, height+topBorder+bottomBorder, src.getType() );
                }
		Graphics2D g = dst.createGraphics();
                g.setRenderingHint(RenderingHints.KEY_RENDERING,
                                   RenderingHints.VALUE_RENDER_SPEED);
                g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
                                   RenderingHints.VALUE_ANTIALIAS_OFF);
                g.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING,
                                   RenderingHints.VALUE_TEXT_ANTIALIAS_OFF);
                g.setRenderingHint(RenderingHints.KEY_FRACTIONALMETRICS,
                                   RenderingHints.VALUE_FRACTIONALMETRICS_OFF);
                g.setRenderingHint(RenderingHints.KEY_COLOR_RENDERING,
                                   RenderingHints.VALUE_COLOR_RENDER_SPEED);
                g.setRenderingHint(RenderingHints.KEY_DITHERING,
                                   RenderingHints.VALUE_DITHER_DISABLE);
		if ( borderPaint != null ) {
			g.setPaint( borderPaint );
			if ( leftBorder > 0 ) {
                            g.fillRect( 0, 0, leftBorder, height );
                        }
			if ( rightBorder > 0 ) {
                            g.fillRect( width-rightBorder, 0, rightBorder, height );
                        }
			if ( topBorder > 0 ) {
                            g.fillRect( leftBorder, 0, width-leftBorder-rightBorder, topBorder );
                        }
			if ( bottomBorder > 0 ) {
                            g.fillRect( leftBorder, height-bottomBorder, width-leftBorder-rightBorder, bottomBorder );
                        }
		}
		g.drawRenderedImage( src, AffineTransform.getTranslateInstance( leftBorder, rightBorder ) );
		g.dispose();
		return dst;
	}

        @Override
	public String toString() {
		return "Distort/Border...";
	}

    @Override
    public Object clone() throws CloneNotSupportedException {
        return super.clone(); //To change body of generated methods, choose Tools | Templates.
    }
}