com.webobjects.directtoweb
Class D2WCustomComponent

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WComponent
              com.webobjects.directtoweb.D2WCustomComponent

All Implemented Interfaces:

WOActionResults, DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class D2WCustomComponent
extends D2WComponent

The D2WCustomComponent class is a component that allows you to use a WebObjects reusable component as a property-level component. You can use the Web Assistant to specify the name of the reusable component to embed.

D2WCustomComponent passes two bindings to the reusable component:

• object -- the object containing the property to modify or display
• key -- the key for the property to modify or display.

See the "Customizing a Direct to Web Application" chapter in Developing WebObjects Applications With Direct to Web for more information about this component.

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.NSKeyValueCoding

NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

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 class com.webobjects.appserver.WOComponent

MINUSONE

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

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

Method Summary

void	validationFailedWithException(Throwable theException, Object theValue, String theKeyPath) Invokes the validationFailedWithException method on the parent component.

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, replacementAssociationForAssociation, 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, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

D2WCustomComponent

public D2WCustomComponent(WOContext aContext)

Creates an instance of D2WCustomComponent with the specified context.

Parameters:

aContext - instance of WOContext

See Also:

D2WComponent#D2WComponent(WOContext)

Method Detail

validationFailedWithException

public void validationFailedWithException(Throwable theException,
                                          Object theValue,
                                          String theKeyPath)

Invokes the validationFailedWithException method on the parent component.

Overrides:

validationFailedWithException in class WOComponent

Parameters:

theException - the exception that was thrown

theValue - the value that was being set

theKeyPath - the derived path that was being accessed

See Also:

WOComponent.parent(), WOComponent.validationFailedWithException(Throwable, Object, String)