View Javadoc

1   /*
2    * JCaptcha, the open source java framework for captcha definition and integration
3    * Copyright (c)  2007 jcaptcha.net. All Rights Reserved.
4    * See the LICENSE.txt file distributed with this package.
5    */
6   
7   package com.octo.captcha.component.image.backgroundgenerator;
8   
9   import java.awt.image.BufferedImage;
10  
11  /***
12   * <p>Used by ComposedWordToImage to build a background image</p>
13   *
14   * @author <a href="mailto:mag@jcaptcha.net">Marc-Antoine Garrigue</a>
15   * @version 1.0
16   */
17  public interface BackgroundGenerator {
18  
19      /***
20       * @return the generated image height
21       */
22      int getImageHeight();
23  
24      /***
25       * @return teh generated image width
26       */
27      int getImageWidth();
28  
29      /***
30       * Generates a backround image on wich text will be paste. Implementations must take into account the imageHeigt and
31       * imageWidth.
32       *
33       * @return the background image
34       */
35      BufferedImage getBackground();
36  }