org.apache.myfaces.custom.captcha
Class CAPTCHAComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.captcha.AbstractCAPTCHAComponent
              org.apache.myfaces.custom.captcha.CAPTCHAComponent

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class CAPTCHAComponent
extends AbstractCAPTCHAComponent

Nested Class Summary

protected static class

CAPTCHAComponent.PropertyKeys

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.custom.captcha.AbstractCAPTCHAComponent

ATTRIBUTE_CAPTCHA_SESSION_KEY_NAME, ATTRIBUTE_IMAGE_HEIGHT, ATTRIBUTE_IMAGE_WIDTH

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

CAPTCHAComponent()

Method Summary

java.lang.String	getCaptchaSessionKeyName() Determines the CAPTCHA session key name.
java.lang.String	getFamily()
java.lang.String	getImageHeight() Integer to indicate the CAPTCHA height.
java.lang.String	getImageWidth() Integer to indicate the CAPTCHA width.
void	setCaptchaSessionKeyName(java.lang.String captchaSessionKeyName)
void	setImageHeight(java.lang.String imageHeight)
void	setImageWidth(java.lang.String imageWidth)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

CAPTCHAComponent

public CAPTCHAComponent()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getCaptchaSessionKeyName

public java.lang.String getCaptchaSessionKeyName()

Description copied from class: AbstractCAPTCHAComponent

Determines the CAPTCHA session key name.

Specified by:

getCaptchaSessionKeyName in class AbstractCAPTCHAComponent

Returns:

setCaptchaSessionKeyName

public void setCaptchaSessionKeyName(java.lang.String captchaSessionKeyName)

getImageWidth

public java.lang.String getImageWidth()

Description copied from class: AbstractCAPTCHAComponent

Integer to indicate the CAPTCHA width. default is 290.

Specified by:

getImageWidth in class AbstractCAPTCHAComponent

setImageWidth

public void setImageWidth(java.lang.String imageWidth)

getImageHeight

public java.lang.String getImageHeight()

Description copied from class: AbstractCAPTCHAComponent

Integer to indicate the CAPTCHA height. default is 81.

Specified by:

getImageHeight in class AbstractCAPTCHAComponent

setImageHeight

public void setImageHeight(java.lang.String imageHeight)