WebObjects 5.2

com.webobjects.directtoweb
Class D2WList

java.lang.Object
  |
  +--com.webobjects.appserver.WOElement
        |
        +--com.webobjects.appserver.WOComponent
              |
              +--com.webobjects.directtoweb.D2WEmbeddedComponent
                    |
                    +--com.webobjects.directtoweb.D2WList
All Implemented Interfaces:
Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

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

Inner classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Inner classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
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, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

D2WList

public D2WList(WOContext aContext)
Constructs a D2WList with the specified context.
Parameters:
aContext - - the WOContext.
Method Detail

dataSource

public EODataSource dataSource()
Returns the EODataSource containing the objects displayed on the page.
Returns:
- data source with objects being displayed.

setDataSource

public void setDataSource(Object newValue)

Last updated Fri Feb 21 13:15:00 PST 2003.

Copyright © 2003 Apple Computer, Inc.