er.extensions.components

Class ERXListDisplay

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXListDisplay

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class ERXListDisplay
extends WOComponent

Useful for displaying a list of objects. Ex. a list of person eos could be displayed as "Fred, Mark and Max". If you give the "item" binding, then the content is used to render. Otherwise the "attribute" binding will get used.

See Also:

Serialized Form

Author:

NetStruxr, kieran - I noticed nullArrayDisplay binding was not implemented. Implemented more useful emptyArrayDisplay with fallback to nullArrayDisplay binding for backwards compatibility.

Bindings

Name	Description
list	list
attribute	attribute
emptyArrayDisplay	the string to display when the array is null or empty
item	current item if in content mode
separator	separator to use for the first items (default ", ")
finalSeparator	separator for the last items (default localized " and ")
escapeHTML	escapeHTML

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
protected String	finalSeparator
int	index
protected NSArray	list
protected String	separator

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERXListDisplay(WOContext aContext)

Method Summary

Modifier and Type	Method and Description
String	currentSeparator()
String	displayString()
String	emptyArrayDisplay()
boolean	escapeHTML()
String	finalSeparator()
boolean	isEmptyList()
boolean	isStateless()
Object	item()
NSArray	list()
void	reset()
String	separator()
void	setItem(Object item)
boolean	useContent()

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

index

public int index

list

protected NSArray list

finalSeparator

protected String finalSeparator

separator

protected String separator

Constructor Detail

ERXListDisplay

public ERXListDisplay(WOContext aContext)

Method Detail

isStateless

public boolean isStateless()

Overrides:

isStateless in class WOComponent

escapeHTML

public boolean escapeHTML()

useContent

public boolean useContent()

list

public NSArray list()

isEmptyList

public boolean isEmptyList()

Returns:

true if the array is null or empty

item

public Object item()

setItem

public void setItem(Object item)

currentSeparator

public String currentSeparator()

finalSeparator

public String finalSeparator()

separator

public String separator()

reset

public void reset()

Overrides:

reset in class WOComponent

displayString

public String displayString()

emptyArrayDisplay

public String emptyArrayDisplay()

Returns:

what to display when the list is null or empty. Supporting null or empty makes sense since an empty relationship will return an empty array, not a null array.