org.apache.myfaces.custom.captcha
Class AbstractCAPTCHAComponent

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

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

Direct Known Subclasses:

CAPTCHAComponent

public abstract class AbstractCAPTCHAComponent
extends javax.faces.component.UIComponentBase

Since:

1.1.7

Author:

Hazem Saleh

Field Summary

static java.lang.String	ATTRIBUTE_CAPTCHA_SESSION_KEY_NAME
static java.lang.String	ATTRIBUTE_IMAGE_HEIGHT
static java.lang.String	ATTRIBUTE_IMAGE_WIDTH
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

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

AbstractCAPTCHAComponent()

Method Summary

abstract java.lang.String	getCaptchaSessionKeyName() Determines the CAPTCHA session key name.
abstract java.lang.String	getImageHeight() Integer to indicate the CAPTCHA height.
abstract java.lang.String	getImageWidth() Integer to indicate the CAPTCHA width.

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, getFamily, 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_TYPE

public static java.lang.String COMPONENT_TYPE

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

DEFAULT_RENDERER_TYPE

public static java.lang.String DEFAULT_RENDERER_TYPE

ATTRIBUTE_CAPTCHA_SESSION_KEY_NAME

public static final java.lang.String ATTRIBUTE_CAPTCHA_SESSION_KEY_NAME

See Also:

Constant Field Values

ATTRIBUTE_IMAGE_WIDTH

public static final java.lang.String ATTRIBUTE_IMAGE_WIDTH

See Also:

Constant Field Values

ATTRIBUTE_IMAGE_HEIGHT

public static final java.lang.String ATTRIBUTE_IMAGE_HEIGHT

See Also:

Constant Field Values

Constructor Detail

AbstractCAPTCHAComponent

public AbstractCAPTCHAComponent()

Method Detail

getCaptchaSessionKeyName

public abstract java.lang.String getCaptchaSessionKeyName()

Determines the CAPTCHA session key name.

Returns:

getImageWidth

public abstract java.lang.String getImageWidth()

Integer to indicate the CAPTCHA width. default is 290.

getImageHeight

public abstract java.lang.String getImageHeight()

Integer to indicate the CAPTCHA height. default is 81.