WebObjects 5.4.2

com.webobjects.directtoweb
Class D2WPlainListPage

java.lang.Object
  extended by com.webobjects.appserver.WOElement
      extended by com.webobjects.appserver.WOComponent
          extended by com.webobjects.directtoweb.D2WComponent
              extended by com.webobjects.directtoweb.D2WPage
                  extended by com.webobjects.directtoweb.D2WListPage
                      extended by com.webobjects.directtoweb.D2WPlainListPage
All Implemented Interfaces:
WOActionResults, DTWGeneration, ListPageInterface, SelectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable
Direct Known Subclasses:
BASPlainListPage, NEUPlainListPage, WOLPlainListPage

public class D2WPlainListPage
extends D2WListPage

The D2WPlainListPage class provides the behavior for the plain-list page Direct to Web templates, specifically BASPlainListPage, NEUPlainListPage, and WOLPlainListPage. The classes for these components inherit directly from D2WPlainListPage and define no additional methods or variables.

Most of the methods in this class are accessed, via the EOKeyValueCoding interface defined in the EOControl framework, from the bindings (.wod) file of the Direct to Web template. If you create a Direct to Web template from a plain-list page, you can invoke the methods in this class in the same way.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent
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.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WPlainListPage(WOContext aContext)
          Creates an instance of D2WPlainListPage with the specified context.
 
Method Summary
 String componentsForSortKeyList()
          Contributes to the template method that corresponds to the method sortKeyList.
 void setLocalContext(D2WContext newValue)
          Sets the local context to the specified D2WContext.
 NSArray sortKeyList()
          Gets the list of property keys that can be used to sort the displayed objects of the receiver.
 
Methods inherited from class com.webobjects.directtoweb.D2WListPage
alternatingColorForRow, appendToResponse, backAction, backgroundColorForRow, backgroundColorForRowMethod, defaultSortKey, deleteObjectAction, displayGroup, editingContextDidSaveChanges, editObjectAction, finalize, inspectObjectAction, isEntityReadOnly, isListEmpty, isSelecting, listSize, numberOfObjectsPerBatch, replacementAssociationForAssociation, selectedObject, selectObjectAction, setBackgroundColorForRow, setDataSource, setSelectedObject
 
Methods inherited from class com.webobjects.directtoweb.D2WPage
alternateRowColor, dataSource, descriptionForResponse, extraBindings, nextPage, nextPageDelegate, pageWrapperName, setExtraBindings, setNextPage, setNextPageDelegate, showCancel
 
Methods inherited from class com.webobjects.directtoweb.D2WComponent
allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContext, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, object, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setObject, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames
 
Methods inherited from class com.webobjects.appserver.WOComponent
application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.webobjects.directtoweb.ListPageInterface
setNextPage, setNextPageDelegate
 
Methods inherited from interface com.webobjects.directtoweb.SelectPageInterface
nextPageDelegate, setNextPageDelegate
 

Constructor Detail

D2WPlainListPage

public D2WPlainListPage(WOContext aContext)
Creates an instance of D2WPlainListPage with the specified context.

Parameters:
aContext - instance of WOContext
See Also:
D2WListPage.D2WListPage(WOContext)
Method Detail

setLocalContext

public void setLocalContext(D2WContext newValue)
Sets the local context to the specified D2WContext.

The current implementation sets the number of objects per batch of the display group.

The implementation is subject to change in future releases.

Overrides:
setLocalContext in class D2WListPage
Parameters:
newValue - instance of D2WContext
See Also:
D2WListPage.displayGroup(), D2WListPage.numberOfObjectsPerBatch(), D2WListPage.setLocalContext(D2WContext)

sortKeyList

public NSArray sortKeyList()
Gets the list of property keys that can be used to sort the displayed objects of the receiver.

Returns:
the list of property keys to sort the displayed objects

componentsForSortKeyList

public String componentsForSortKeyList()
Contributes to the template method that corresponds to the method sortKeyList.

The implementation is subject to change in future releases.

Returns:
part of the definition of sortKeyList
See Also:
D2WPlainListPage.sortKeyList()

Last updated June 2008

Copyright © 2000-2008 Apple Inc.