org.josef.web.jsf.binding.jcc

Class ZipCode

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UINamingContainer

org.josef.web.jsf.binding.jcc.ZipCode

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class ZipCode
extends javax.faces.component.UINamingContainer

Backing component for the ZipCode composite component.
Note: This ZipCode component has a country attribute which should result in an Iso3166Country. Sometimes the ZipCode is used on a page with tabs and then it can happen that the ZipCode is not initialized (read the country on the ZipCode is not available yet) and becomes available later. This class was build with this concept in mind.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

Field Summary

Fields inherited from class javax.faces.component.UINamingContainer

COMPONENT_FAMILY, COMPONENT_TYPE, SEPARATOR_CHAR_PARAM_NAME

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
ZipCode()

Method Summary

Modifier and Type	Method and Description
static Iso3166Country	getCountry(javax.faces.component.UIComponent component) Gets the country for the supplied component.
static Iso3166Country	getCountryOfAttribute(Object countryAttribute) Gets the country from the supplied countryAttribute.
Integer	getMaximumLength() Gets the maximum length of the zip code.
boolean	renderZipCodeField() Determines whether the zip code input field needs to be rendered.

Methods inherited from class javax.faces.component.UINamingContainer

createUniqueId, getFamily, getSeparatorChar, visitTree

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, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.StateHolder

isTransient, restoreState, saveState, setTransient

Constructor Detail

ZipCode

public ZipCode()

Method Detail

getMaximumLength

public Integer getMaximumLength()

Gets the maximum length of the zip code.

Returns:

The maximum length of the zip code or null when the country attribute does not (yet) contain a country or when the country does not use zip codes.

renderZipCodeField

public boolean renderZipCodeField()

Determines whether the zip code input field needs to be rendered.
The zip code field is not rendered for countries that do not use zip codes.

Returns:

True when the zip code input field needs to be rendered, otherwise false.

getCountry

public static Iso3166Country getCountry(javax.faces.component.UIComponent component)

Gets the country for the supplied component.
This method checks the following components in order, for a "country" attribute:

1. The passed in component
2. The naming container of the passed in component

Parameters:

component - The component to get the country of.

Returns:

The country for the supplied component of null when the supplied component does not have a country attribute.

getCountryOfAttribute

public static Iso3166Country getCountryOfAttribute(Object countryAttribute)

Gets the country from the supplied countryAttribute.

Parameters:

countryAttribute - The country attribute.
Normally the result of executing JsfComponentUtil.getAttribute(component, "country");

Returns:

The country contained in the supplied countryAttribute or null when the supplied countryAttribute does not contain a country.