atg.commerce.util
Class PlaceList
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.core.i18n.PlaceList
atg.commerce.util.PlaceList
- All Implemented Interfaces:
- atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener
public class PlaceList
- extends atg.core.i18n.PlaceList
This class represents a list of places, each of which has a code and an
associated display name. For example, you might use this class to store
a list of US states together with their two-letter abbreviations, or a
list of countries each with a shipping code and a display name.
The class is initialized by providing a list of strings in the property
strings
, alternating codes and display names. For example,
this properties file demonstrates initializing an instance of PlaceList
with a (partial) list of US states:
$class=atg.commerce.util.PlaceList
$description=A list of states and territories that we can ship to
strings=\
AK, Alaska,\
MA, Massachusetts,\
ME, Maine,\
NH, New Hampshire
PlaceLists are typically used in JHTML or JSP pages by retrieving
the places
property and iterating over it with a droplet
like ForEach
. The places
property is an
array, each of whose elements has properties named code
and displayName
.
This example shows how you might use a PlaceList in a JHTML page:
The example shown above would produce the following output:
We can ship to the following states:
- AK - Alaska
- MA - Massachusetts
- ME - Maine
- NH - New Hampshire
Nested classes/interfaces inherited from class atg.core.i18n.PlaceList |
atg.core.i18n.PlaceList.Place |
Fields inherited from class atg.core.i18n.PlaceList |
mInitStrings, mPlaces |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Methods inherited from class atg.core.i18n.PlaceList |
getPlaceForCode, getPlaces, getStrings, setStrings, updatePlaces |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
PlaceList
public PlaceList()