WebObjects 5.2.3

com.webobjects.directtoweb
Class D2WEditToManyFault

java.lang.Object
  extended bycom.webobjects.appserver.WOElement
      extended bycom.webobjects.appserver.WOComponent
          extended bycom.webobjects.directtoweb.D2WComponent
              extended bycom.webobjects.directtoweb.D2WEditToManyFault
All Implemented Interfaces:
Cloneable, com.webobjects.directtoweb.generation.DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

public class D2WEditToManyFault
extends D2WComponent

D2WEditToManyFault is a property-level component that displays a hyperlink representing a to-many relationship. The hyperlink navigates to an edit-relationship page that allows the user to change which objects are in the relationship. This component does not traverse the relationship (unlike D2WEditToManyRelationship) making it appropriate for relationships that contain many objects.

Property-level components are not accessed programmatically. Instead, you use the Web Assistant or Rule Editor to choose the property-level component that Direct to Web uses to display a property on a particular entity and task page.

If you want to create a property-level component to edit a property, use D2WCustomComponent.

See Also:
D2WEditToManyRelationship, D2WCustomComponent, D2WEditToOneFault, Serialized Form

Nested Class Summary
 
Nested classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Nested classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 EOEnterpriseObject browserItem
          The item for a WOBrowser.
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WEditToManyFault(WOContext aContext)
          Creates an instance of D2WEditToManyFault with the specified context.
 
Method Summary
 NSArray browserList()
          Provides the list for a WOBrowser.
 String browserListDescription()
          Provides the closed label for a D2WCollapsibleComponentContent.
 String browserStringForItem()
          Provides the display string for a WOBrowser.
 WOComponent editValues()
          Provides the action for a WOImageButton.
 String helpString()
          Provides the alt and name values for a WOImageButton.
 String ivarNameForBrowserItem()
          Provides the name of the template field that corresponds to the browserItem field.
 String methodNameBrowserListDescription()
          Provides the name of the template method that corresponds to the method browserListDescription.
 String methodNameForEditValues()
          Provides the name of the template method that corresponds to the method editValues.
 String methodNameListDescription()
          Provides the name of the template method that corresponds to the method listDescription (if one exists).
 String plurifiedStrings()
          Contributes to the template method that corresponds to the method browserListDescription.
 WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, com.webobjects.directtoweb.generation.DTWTemplate aTemplate, WOContext aContext)
          Replaces the associations that are pertinent to editing to-many relationships.
 
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, 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, setLocalContext, setObject, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, awake, 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, sleep, synchronizesVariablesWithBindings, 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
 

Field Detail

browserItem

public EOEnterpriseObject browserItem
The item for a WOBrowser.

The implementation is subject to change in future releases.

See Also:
browserList(), browserStringForItem()
Constructor Detail

D2WEditToManyFault

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

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

browserList

public NSArray browserList()
Provides the list for a WOBrowser.

The implementation is subject to change in future releases.

Returns:
instance of NSArray if the object is not null; null otherwise
See Also:
browserItem, D2WComponent.object(), D2WComponent.propertyKey()

browserListDescription

public String browserListDescription()
Provides the closed label for a D2WCollapsibleComponentContent.

The current implementation returns the concatenation of the number of destination objects and the name of the destination entity, if there are any objects; the string "N/A", otherwise.

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
browserList(), D2WComponent.relationship()

browserStringForItem

public String browserStringForItem()
Provides the display string for a WOBrowser.

The implementation is subject to change in future releases.

Returns:
instance of String if browser item is not null; null otherwise
See Also:
browserItem

editValues

public WOComponent editValues()
Provides the action for a WOImageButton. Returns an edit-relationship page for the target entity.

The implementation is subject to change in future releases.

Returns:
instance of WOComponent
See Also:
helpString(), D2WComponent.relationship(), D2W.editRelationshipPageForEntityNamed(String, WOSession)

helpString

public String helpString()
Provides the alt and name values for a WOImageButton. Returns a brief description of the action.

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
editValues()

ivarNameForBrowserItem

public String ivarNameForBrowserItem()
Provides the name of the template field that corresponds to the browserItem field.

The current implementation returns the concatenation of "itemFor" and the property key.

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
browserItem, replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext), D2WComponent.propertyKey()

methodNameBrowserListDescription

public String methodNameBrowserListDescription()
Provides the name of the template method that corresponds to the method browserListDescription.

The current implementation returns the concatenation of "displayStringFor", the property key, and "Item".

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
browserListDescription(), replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext), D2WComponent.propertyKey()

methodNameForEditValues

public String methodNameForEditValues()
Provides the name of the template method that corresponds to the method editValues.

The current implementation returns the concatenation of "edit", the property key, and "Action".

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
editValues(), replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext), D2WComponent.propertyKey()

methodNameListDescription

public String methodNameListDescription()
Provides the name of the template method that corresponds to the method listDescription (if one exists).

The current implementation returns the concatenation of "listDescriptionFor", and the property key.

The implementation is subject to change in future releases.

Returns:
instance of String
See Also:
replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext), D2WComponent.propertyKey()

plurifiedStrings

public String plurifiedStrings()
Contributes to the template method that corresponds to the method browserListDescription.

The implementation is subject to change in future releases.

Returns:
part of the definition of browserListDescription
See Also:
browserListDescription(), methodNameBrowserListDescription(), replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext)

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          com.webobjects.directtoweb.generation.DTWTemplate aTemplate,
                                                          WOContext aContext)
Replaces the associations that are pertinent to editing to-many relationships.

The bindings include browserList, browserListDescription, browserItem, browserStringForItem, and editValues.

The implementation is subject to change in future releases.

Specified by:
replacementAssociationForAssociation in interface com.webobjects.directtoweb.generation.DTWGeneration
Overrides:
replacementAssociationForAssociation in class D2WComponent
Parameters:
oldAssociation - instance of WOAssociation
oldBinding - instance of String
aTemplate - instance of DTWTemplate
aContext - instance of WOContext
Returns:
instance of WOAssociation
See Also:
browserList(), browserListDescription(), methodNameBrowserListDescription(), browserItem, browserStringForItem(), ivarNameForBrowserItem(), editValues(), methodNameForEditValues(), D2WComponent.replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext)

Last updated Thu Oct 21 15:04:16 PDT 2004.

Copyright © 2004 Apple Computer, Inc.