com.github.cage.image
Class EffectConfig

java.lang.Object
  extended by com.github.cage.image.EffectConfig

public class EffectConfig
extends Object

Class to represent used effect configuration by Painter.

Author:
akiraly

Constructor Summary
EffectConfig()
          Constructor.
EffectConfig(boolean rippleEnabled, boolean blurEnabled, boolean outlineEnabled, boolean rotateEnabled, ScaleConfig scaleConfig)
          Constructor.
 
Method Summary
 ScaleConfig getScaleConfig()
           
 boolean isBlurEnabled()
           
 boolean isOutlineEnabled()
           
 boolean isRippleEnabled()
           
 boolean isRotateEnabled()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EffectConfig

public EffectConfig()
Constructor.


EffectConfig

public EffectConfig(boolean rippleEnabled,
                    boolean blurEnabled,
                    boolean outlineEnabled,
                    boolean rotateEnabled,
                    ScaleConfig scaleConfig)
Constructor.

Parameters:
rippleEnabled - waving effect should be used, default true, disabling this helps performance
blurEnabled - should the image be blurred, default true, disabling this helps performance
outlineEnabled - should a shifted, font colored outline be drawn behind the characters, default false, disabling this helps performance slightly
rotateEnabled - should the letters be rotated independently, default true, disabling this helps performance slightly
scaleConfig - scaling information for the captcha image, can be null
Method Detail

isRippleEnabled

public boolean isRippleEnabled()
Returns:
true if the image will be rippled (waved)

isBlurEnabled

public boolean isBlurEnabled()
Returns:
true if the image will be blurred

isOutlineEnabled

public boolean isOutlineEnabled()
Returns:
true if outline shadow for text will be drawn on the image

isRotateEnabled

public boolean isRotateEnabled()
Returns:
true if the text letters will be rotated before drawn on the image

getScaleConfig

public ScaleConfig getScaleConfig()
Returns:
scaling information for the captcha image, not null


Copyright © 2011. All Rights Reserved.