org.zkoss.zul

Class Captcha

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Image

org.zkoss.zul.Captcha

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Captcha
extends Image

The generic captcha component.

Captcha requires an implementation of an engine (CaptchaEngine). The default engine is based on JHLabs and available in ZK PE and ZK EE.

Author:

henrichen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.Image

Image.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Captcha()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFont(Font font) Add fonts into fonts list.
String	getBgColor() Get the background color of the captcha box (in string as #RRGGBB).
int	getBgRGB() Get the background color in int array (0: red, 1: green, 2:blue).
CaptchaEngine	getCaptchaEngine() Get the captcha engine.
Font[]	getDefaultFonts() Gets the default font list.
String	getExclude() Get exclude characters.
Font	getFont(int j) Get nth Font.
String	getFontColor() Gets font color.
int	getFontRGB() Get the font color in int array (0: red, 1: green, 2:blue).
List<Font>	getFonts() Gets fonts list, default provide two fonts.
int	getIntHeight() Get the captcha int height in pixel; to be used by the derived subclass.
int	getIntWidth() Get the captcha int width in pixel; to be used by the derived subclass.
int	getLength() Get length of the autogenerated text value; default to 5.
String	getValue() Returns the text value of this captcha.
boolean	isBorder() Deprecated. As of release 5.0.4, use isFrame() instead.
boolean	isFrame() Returns whether generate border.
boolean	isNoise() Returns whether generate noise; default to false.
protected CaptchaEngine	newCaptchaEngine() Instantiates the default captcha engine.
String	randomValue() Regenerates new captcha text value and redraw.
void	setBgColor(String color) Set the background color of the chart.
void	setBorder(boolean b) Deprecated. As of release 5.0.4, use setFrame(boolean) instead.
void	setEngine(CaptchaEngine engine) Set the captcha engine.
void	setEngine(String clsnm) Sets the captcha engine by use of a class name.
void	setExclude(String exclude) Set exclude characters that will not be generated.
void	setFontColor(String color) Set font color.
void	setFrame(boolean frame) Sets whether generate border.
void	setHeight(String h) Override super class to prepare the int height.
void	setLength(int len) Set length of the autogenerated text value; default to 5.
void	setNoise(boolean b) Sets whether generate noise; default to false.
void	setValue(String text) Sets the text value to be shown as the distortion captcha.
void	setWidth(String w) Override super class to prepare the int width.
protected void	smartDrawCaptcha() mark a draw flag to inform that this Chart needs update.

Methods inherited from class org.zkoss.zul.Image

getAlign, getBorder, getContent, getExtraCtrl, getHover, getHspace, getSrc, getVspace, isChildable, renderProperties, setAlign, setBorder, setContent, setContent, setHover, setHoverContent, setHoverContent, setHspace, setSrc, setVspace

Methods inherited from class org.zkoss.zul.impl.XulElement

clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Captcha

public Captcha()

Method Detail

getFonts

public List<Font> getFonts()

Gets fonts list, default provide two fonts.

getDefaultFonts

public Font[] getDefaultFonts()

Gets the default font list.

getFont

public Font getFont(int j)

Get nth Font.

addFont

public void addFont(Font font)

Add fonts into fonts list. If you did not add fonts, the default implementation would use the default fonts; i.e. bold Arial 35, and bold courier 35.

setFontColor

public void setFontColor(String color)

Set font color. Allowed value format: #RRGGBB

getFontColor

public String getFontColor()

Gets font color.

getFontRGB

public int getFontRGB()

Get the font color in int array (0: red, 1: green, 2:blue).

setBgColor

public void setBgColor(String color)

Set the background color of the chart.

Parameters:

color - in #RRGGBB format (hexadecimal).

getBgColor

public String getBgColor()

Get the background color of the captcha box (in string as #RRGGBB). null means default.

getBgRGB

public int getBgRGB()

Get the background color in int array (0: red, 1: green, 2:blue). null means default.

setWidth

public void setWidth(String w)

Override super class to prepare the int width.

Overrides:

setWidth in class org.zkoss.zk.ui.HtmlBasedComponent

getIntWidth

public int getIntWidth()

Get the captcha int width in pixel; to be used by the derived subclass.

setHeight

public void setHeight(String h)

Override super class to prepare the int height.

Overrides:

setHeight in class org.zkoss.zk.ui.HtmlBasedComponent

getIntHeight

public int getIntHeight()

Get the captcha int height in pixel; to be used by the derived subclass.

getValue

public String getValue()

Returns the text value of this captcha.

Default: an empty string.

Deriving class can override it to return whatever it wants other than null.

setValue

public void setValue(String text)
              throws org.zkoss.zk.ui.WrongValueException

Sets the text value to be shown as the distortion captcha.

Parameters:

text - the captcha text value

Throws:

org.zkoss.zk.ui.WrongValueException

setLength

public void setLength(int len)

Set length of the autogenerated text value; default to 5.

getLength

public int getLength()

Get length of the autogenerated text value; default to 5.

setExclude

public void setExclude(String exclude)

Set exclude characters that will not be generated. Note that only digit and character is used in generating text value. If you leave exclude null, the default exclude list will be applied; i.e., 0123456789IilOo (only character (no digits) are used except I, i, l, O(big O), o(small o))

getExclude

public String getExclude()

Get exclude characters.

setNoise

public void setNoise(boolean b)

Sets whether generate noise; default to false. (@since 5.0.0)

isNoise

public boolean isNoise()

Returns whether generate noise; default to false. (@since 5.0.0)

setBorder

public void setBorder(boolean b)

Deprecated. As of release 5.0.4, use setFrame(boolean) instead.

Sets whether generate border.

Default to false.

Since:

5.0.0

isBorder

public boolean isBorder()

Deprecated. As of release 5.0.4, use isFrame() instead.

Returns whether generate border.

Default to false.

Since:

5.0.0

setFrame

public void setFrame(boolean frame)

Sets whether generate border.

Default to false.

Since:

5.0.4

isFrame

public boolean isFrame()

Returns whether generate border.

Default to false.

Since:

5.0.4

randomValue

public String randomValue()

Regenerates new captcha text value and redraw.

setEngine

public void setEngine(String clsnm)
               throws ClassNotFoundException,
                      NoSuchMethodException,
                      IllegalAccessException,
                      InstantiationException,
                      InvocationTargetException

Sets the captcha engine by use of a class name. It creates an instance automatically.

Throws:

ClassNotFoundException

NoSuchMethodException

IllegalAccessException

InstantiationException

InvocationTargetException

setEngine

public void setEngine(CaptchaEngine engine)

Set the captcha engine.

getCaptchaEngine

public CaptchaEngine getCaptchaEngine()
                               throws org.zkoss.zk.ui.UiException

Get the captcha engine.

Throws:

org.zkoss.zk.ui.UiException - if failed to load the engine.

newCaptchaEngine

protected CaptchaEngine newCaptchaEngine()
                                  throws org.zkoss.zk.ui.UiException

Instantiates the default captcha engine. It is called, if setEngine(java.lang.String) is not called with non-null engine.

By default, it looks up the library property called org.zkoss.zul.captcha.engine.class. If found, the value is assumed to be the class name of the captcha engine (it must implement CaptchaEngine. If not found, UiException is thrown.

Derived class might override this method to provide your own default class.

Throws:

org.zkoss.zk.ui.UiException - if failed to instantiate the engine

Since:

3.0.0

smartDrawCaptcha

protected void smartDrawCaptcha()

mark a draw flag to inform that this Chart needs update.