ERXListDisplay Class Reference

Inherits com::webobjects::appserver::WOComponent.

Collaboration diagram for ERXListDisplay:

[legend]

List of all members.

Public Member Functions
String	currentSeparator ()
String	displayString ()
String	emptyArrayDisplay ()
	ERXListDisplay (WOContext aContext)
boolean	escapeHTML ()
String	finalSeparator ()
boolean	isEmptyList ()
boolean	isStateless ()
Object	item ()
NSArray	list ()
void	reset ()
String	separator ()
void	setItem (Object item)
boolean	synchronizesVariablesWithBindings ()
boolean	useContent ()
Public Attributes
int	index
Protected Attributes
String	finalSeparator
NSArray	list
String	separator
Private Attributes
String	emptyArrayDisplay
Boolean	isEmptyList

---

Detailed Description

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. list 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

Author:

NetStruxr

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

---

Constructor & Destructor Documentation

ERXListDisplay

(

WOContext

aContext

)

---

Member Function Documentation

String currentSeparator

(

)

String displayString

(

)

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.

boolean escapeHTML

(

)

String finalSeparator

(

)

boolean isEmptyList

(

)

Returns:

true if the array is null or empty

boolean isStateless

(

)

Object item

(

)

NSArray list

(

)

void reset

(

)

String separator

(

)

void setItem

(

Object

item

)

boolean synchronizesVariablesWithBindings

(

)

boolean useContent

(

)

---

Member Data Documentation

String emptyArrayDisplay [private]

String finalSeparator [protected]

int index

Boolean isEmptyList [private]

NSArray list [protected]

String separator [protected]

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/components/ERXListDisplay.java