WebObjects 5.4.2

Class D2WList

  extended by com.webobjects.appserver.WOElement
      extended by com.webobjects.appserver.WOComponent
          extended by com.webobjects.directtoweb.D2WEmbeddedComponent
              extended by com.webobjects.directtoweb.D2WList
All Implemented Interfaces:
WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class D2WList
extends D2WEmbeddedComponent

This Direct to Web reusable component displays a list component. See the "Direct to Web" chapter of WebObjects Tools and Techniques for information about the behavior and appearance of this component. Synopsis D2WList { [action=anAction;] dataSource=aDataSource; | list=anArray; [displayKeys=keyArray;] entityName=nameString; [pageConfiguration=aConfiguration;] }; Bindings action - the action method to invoke when the user clicks Return. dataSource - an EODataSource containing the objects to display as a list. list - an array containing the objects to display as a list. displayKeys - the properties of the entity to list (NSArray). You can also represent the array as a string: "(prop1, prop2, ...)". entityName - the name of the entity for this record (String). pageConfiguration - the named configuration containing the Web Assistant settings for this component (String). If this binding is not specified, the "*all*" configuration for the list task and the entityName entity is used. See the "Direct to Web" chapter of WebObjects Tools and Techniques for more information about named configurations. Example

 myList : D2WList {
     entityName = "Movie";
     dataSource = displayGroup.dataSource;
     pageConfiguration = "myListMovieConfig";

See Also:
Serialized Form

Nested Class Summary
Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent
Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
Field Summary
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
Constructor Summary
D2WList(WOContext aContext)
          Constructs a D2WList with the specified context.
Method Summary
 EODataSource dataSource()
          Returns the EODataSource containing the objects displayed on the page.
 void setDataSource(Object newValue)
Methods inherited from class com.webobjects.directtoweb.D2WEmbeddedComponent
actionPageDelegate, awake, findTarget, newPageDelegate, setActionPageDelegate, synchronizesVariablesWithBindings
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, 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

Constructor Detail


public D2WList(WOContext aContext)
Constructs a D2WList with the specified context.

aContext - - the WOContext.
Method Detail


public EODataSource dataSource()
Returns the EODataSource containing the objects displayed on the page.

- data source with objects being displayed.


public void setDataSource(Object newValue)

Last updated June 2008

Copyright © 2000-2008 Apple Inc.