er.directtoweb.pages

Class ERD2WPickListPage

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

com.webobjects.directtoweb.D2WComponent

com.webobjects.directtoweb.D2WPage

er.directtoweb.pages.ERD2WPage

er.directtoweb.pages.ERD2WListPage

er.directtoweb.pages.ERD2WPickListPage

All Implemented Interfaces:

WOActionResults, com.webobjects.directtoweb.EditRelationshipPageInterface, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.ListPageInterface, com.webobjects.directtoweb.SelectPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERDBranchInterface, ERDListPageInterface, ERDPickPageInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, Serializable, Cloneable

Direct Known Subclasses:

ERD2WPickListPageTemplate, ERNEUPickListPage

public class ERD2WPickListPage
extends ERD2WListPage
implements ERDPickPageInterface, com.webobjects.directtoweb.EditRelationshipPageInterface

Allows the selection of one or more objects from a set of EOs. Can also be used directly as a EditRelationshipPage for editing to-one and to-many relationships.

See Also:

Serialized Form

D2W Keys

Name	Description
showActions	showActions
singleSelection	singleSelection
restrictedChoiceKey	restrictedChoiceKey
restrictingFetchSpecification	restrictingFetchSpecification

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.pages.ERD2WPage

ERD2WPage.Keys, ERD2WPage.ValidationDelegate

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
EOEnterpriseObject	_masterObject These are set when we are in edit-relationship mode.
String	_relationshipKey
Boolean	_singleSelection Caches if we are in single selection mode.
String	dummy IE sometimes won't submit the form if it only has checkboxes, we bind this to a WOHiddenField.
static org.apache.log4j.Logger	log logging support

Fields inherited from class er.directtoweb.pages.ERD2WListPage

_displayGroup, _hasToUpdate, _rowFlip, _sessionID, _shouldRefetch, dataSourceState, referenceEO

Fields inherited from class er.directtoweb.pages.ERD2WPage

_allConfigurations, _branch, _context, _nextPage, _nextPageDelegate, _pageController, _userInfo, errorKeyOrder, errorMessage, errorMessages, keyPathsWithValidationExceptions, validationDelegate, validationDelegateInited, validationLog

Fields inherited from class com.webobjects.directtoweb.D2WComponent

_eo, _localContext, currentObjectKey

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
ERD2WPickListPage(WOContext context) Public constructor.

Method Summary

Modifier and Type	Method and Description
WOComponent	backAction()
WOComponent	cancelPage()
boolean	checked()
protected void	didUpdate()
NSArray	filteredObjects() The display group's objects, filtered by the display group qualifier (if any)
WOComponent	selectAll()
WOComponent	selectAllOnPage()
NSArray	selectedObjects() The currently selected objects.
String	selectionWidgetName()
void	setCancelPage(WOComponent cp)
void	setChecked(boolean newChecked)
void	setChoices(NSArray choices)
void	setMasterObjectAndRelationshipKey(EOEnterpriseObject eo, String relationshipName)
void	setSelectedObjects(NSArray selectedObjects) Sets currently selected objects.
boolean	showCancel() Determines if the cancel button should be shown.
boolean	showSelectionActions()
boolean	singleSelection()
WOComponent	unselectAll()
WOComponent	unselectAllOnPage()
protected void	willUpdate()

Methods inherited from class er.directtoweb.pages.ERD2WListPage

_fetchDisplayGroup, alternatingColorForRow, alwaysRefetchList, appendToResponse, backgroundColorForRow, checkSortOrderingKeys, colorForRow, createDisplayGroup, defaultSortKey, deleteObjectAction, descriptionForResponse, displayGroup, editingContextDidSaveChanges, editObjectAction, fetchIfNecessary, formTargetJavaScriptUrl, inspectObjectAction, invokeAction, isEntityEditable, isEntityInspectable, isEntityPrintable, isEntityReadOnly, isListEmpty, isSelecting, isSelectingNotTopLevel, isValidSortKey, listSize, localInstanceOfObject, numberOfObjectsPerBatch, printerFriendlyVersion, printerFriendlyVersion, referenceEOs, selectedObject, selectObjectAction, sessionID, setBackgroundColorForRow, setDataSource, setSelectedObject, setSortOrderingsOnDisplayGroup, setupPhase, shouldShowBatchNavigation, shouldShowSelectAll, sortOrderings, takeValuesFromRequest, targetString, urlForCurrentState, useBatchingDisplayGroup, userPreferencesCanSpecifySorting, warmUpForDisplay

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, awake, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, clickToOpenEnabled, cssClassForPageContainerElement, cssClassForPropertyKey, cssClassForPropertyName, currentSection, currentSectionKeys, currentTab, d2wComponentNameDebuggingEnabled, d2wContext, d2wCurrentComponentName, d2wDebuggingEnabled, displayVariant, editingContext, errorKeyOrder, errorMessage, errorMessageForPropertyKey, errorMessages, hasActualChanges, hasBranchChoices, hasErrors, hasValidationExceptionForPropertyKey, inlineStyleDeclarationForPropertyKey, inlineStyleDeclarationForPropertyName, isEmbedded, isKeyOmitted, isObjectDeleteable, isObjectEditable, isObjectInspectable, isTopLevelPage, latestEntryForCurrentPropertyKey, makeStatsKey, nextPage, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setObject, setPageController, settings, setValidationDelegate, shouldCollectValidationExceptions, shouldDisplayDetailedPageMetrics, shouldDisplayPageMetricsSummary, shouldPropagateExceptions, shouldSetFailedValidationValue, sleep, statsForPage, statsKeyForCurrentPropertyKey, statsKeyPrefix, tabSectionsContents, tabSectionsContentsFromRuleResult, userInfo, userPreferencesValueForKey, userPreferencesValueForPageConfigurationKey, validationDelegate, validationFailedWithException

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, extraBindings, replacementAssociationForAssociation, setExtraBindings

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, 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, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, 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

Methods inherited from interface er.directtoweb.interfaces.ERDPickPageInterface

nextPageDelegate, setDataSource, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.EditRelationshipPageInterface

setNextPage, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.ListPageInterface

setNextPage, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.SelectPageInterface

nextPageDelegate, setNextPageDelegate

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

dummy

public String dummy

IE sometimes won't submit the form if it only has checkboxes, we bind this to a WOHiddenField.

_singleSelection

public Boolean _singleSelection

Caches if we are in single selection mode.

_masterObject

public EOEnterpriseObject _masterObject

These are set when we are in edit-relationship mode.

_relationshipKey

public String _relationshipKey

Constructor Detail

ERD2WPickListPage

public ERD2WPickListPage(WOContext context)

Public constructor.

Parameters:

context - current context

Method Detail

showCancel

public boolean showCancel()

Determines if the cancel button should be shown.

Overrides:

showCancel in class ERD2WListPage

Returns:

if we have a nextPage set

checked

public boolean checked()

setChecked

public void setChecked(boolean newChecked)

selectedObjects

public NSArray selectedObjects()

Description copied from class: ERD2WListPage

The currently selected objects.

Specified by:

selectedObjects in interface ERDPickPageInterface

Overrides:

selectedObjects in class ERD2WListPage

setSelectedObjects

public void setSelectedObjects(NSArray selectedObjects)

Description copied from class: ERD2WListPage

Sets currently selected objects. Pushes the values to the display group, clearing the selection if needed.

Specified by:

setSelectedObjects in interface ERDPickPageInterface

Overrides:

setSelectedObjects in class ERD2WListPage

cancelPage

public WOComponent cancelPage()

Specified by:

cancelPage in interface ERDPickPageInterface

setCancelPage

public void setCancelPage(WOComponent cp)

Specified by:

setCancelPage in interface ERDPickPageInterface

backAction

public WOComponent backAction()

Overrides:

backAction in class ERD2WListPage

setChoices

public void setChoices(NSArray choices)

Specified by:

setChoices in interface ERDPickPageInterface

willUpdate

protected void willUpdate()

Overrides:

willUpdate in class ERD2WListPage

didUpdate

protected void didUpdate()

Overrides:

didUpdate in class ERD2WListPage

showSelectionActions

public boolean showSelectionActions()

filteredObjects

public NSArray filteredObjects()

The display group's objects, filtered by the display group qualifier (if any)

selectAll

public WOComponent selectAll()

selectAllOnPage

public WOComponent selectAllOnPage()

unselectAll

public WOComponent unselectAll()

unselectAllOnPage

public WOComponent unselectAllOnPage()

singleSelection

public boolean singleSelection()

selectionWidgetName

public String selectionWidgetName()

setMasterObjectAndRelationshipKey

public void setMasterObjectAndRelationshipKey(EOEnterpriseObject eo,
                                              String relationshipName)

Specified by:

setMasterObjectAndRelationshipKey in interface com.webobjects.directtoweb.EditRelationshipPageInterface