org.apache.myfaces.custom.captcha
Class CAPTCHAComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.custom.captcha.AbstractCAPTCHAComponent
              extended by org.apache.myfaces.custom.captcha.CAPTCHAComponent
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, 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 String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static 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
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Constructor Summary
CAPTCHAComponent()
           
 
Method Summary
 String getCaptchaSessionKeyName()
          Determines the CAPTCHA session key name.
 String getFamily()
           
 String getImageHeight()
          Integer to indicate the CAPTCHA height.
 String getImageWidth()
          Integer to indicate the CAPTCHA width.
 void setCaptchaSessionKeyName(String captchaSessionKeyName)
           
 void setImageHeight(String imageHeight)
           
 void setImageWidth(String imageWidth)
           
 
Methods inherited from class org.apache.myfaces.custom.captcha.AbstractCAPTCHAComponent
getCaptchaSessionValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, 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
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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 String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

CAPTCHAComponent

public CAPTCHAComponent()
Method Detail

getFamily

public String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

getCaptchaSessionKeyName

public String getCaptchaSessionKeyName()
Description copied from class: AbstractCAPTCHAComponent
Determines the CAPTCHA session key name. If org.apache.myfaces.tomahawk.PREFIX_CAPTCHA_SESSION_KEY is set to true (default), a prefix defined by the component is added to this key name.

Specified by:
getCaptchaSessionKeyName in class AbstractCAPTCHAComponent
Returns:

setCaptchaSessionKeyName

public void setCaptchaSessionKeyName(String captchaSessionKeyName)

getImageWidth

public 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(String imageWidth)

getImageHeight

public 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(String imageHeight)


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.