er.directtoweb.components

Class ERDCustomComponent

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.directtoweb.components.ERDCustomComponent

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, ERXExceptionHolder, Serializable, Cloneable

Direct Known Subclasses:

ERCDisplayHelpText, ERDActionButton, ERDAttributeRepetition, ERDBannerComponent, ERDCustomEditComponent, ERDCustomQueryComponent, ERDDisplayTemplateString, ERDEmptyListMessage, ERDQuickSearch, ERDSectionImage, ERDSectionText, ERDSpacer, ERDTabText, ERMD2WColumnSelector, ERMD2WHeader, ERMD2WTableHeader, ERMDActionButton, ERMDAjaxNotificationCenter, ERMDBatchSizeControl

public abstract class ERDCustomComponent
extends ERXNonSynchronizingComponent
implements ERXExceptionHolder

Base class of many custom components.

Has a lot of nifty features including resolving bindings against the rule system and inherits all the value pulling methods from ERXNonSynchronizingComponent. Subclasses should be able to run stand alone without a D2W context. This is achieved by pulling values first from the bindings, then from the d2wContext and finally from an "extraBindings" binding.

たくさんのカスタム・コンポーネントのベース・クラスである ルール・システムへのバインディングや ERXNonSynchronizingComponent の値バインディング取得機能等の必要な処理をたくさん含みます。 サブクラスは D2W コンテキスト無しでスタンドアロンで実行可能です。最初はコンポーネント・バインディングを優先で取得を試し、 だめなら、 d2wContext と後は "extraBindings" バインディングより。

See Also:

Serialized Form

D2W Keys

Name	Description
localContext	- d2wContext (deprecated)
d2wContext	- d2wContext
key	- プロパティ・キー
extraBindings	- オプション・バインディング
propertyKey	- プロパティ・キー

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERDCustomComponent.Keys

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.MapImplementation, com.webobjects.foundation.NSKeyValueCoding.Null<T>, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	extraBindings Holds the extra bindings.
protected static Integer	FALSE
static Logger	log logging support
protected static Integer	TRUE

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

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
ERDCustomComponent(com.webobjects.appserver.WOContext context) Designated constructor

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(com.webobjects.appserver.WOResponse r, com.webobjects.appserver.WOContext c) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.
void	clearValidationFailed() Implementation of the ERXExceptionHolder interface.
boolean	d2wComponentNameDebuggingEnabled() Should the component name be shown.
com.webobjects.directtoweb.D2WContext	d2wContext() The active D2WContext.
protected com.webobjects.directtoweb.D2WContext	d2wContextFromBindings() Returns the active d2wContext.
protected Object	d2wContextValueForBinding(String binding) Utility to pull the value from the D2WContext.
boolean	d2wDebuggingEnabled() Is D2W debugging enabled.
D2WPage	d2wPage() Finds the containing D2WPage, if possible.
boolean	d2wPropertyKeyDebuggingEnabled() Should the property keys be shown. プロパティ・キーを表示する？
Object	extraBindings() Extra bindings supplied to the component.
protected Object	extraBindingsValueForBinding(String binding) Utility to pull the value from the extra bindings if supplied.
boolean	hasBinding(String binding) Checks if the binding can be pulled.
Integer	integerBooleanForBinding(String binding)
String	key() The active property key.
com.webobjects.directtoweb.D2WContext	localContext() The active D2WContext.
protected void	logDebugInfo() Utility to dump some debug info about this component and its parent
protected Object	originalValueForBinding(String binding) Utility to pull the value from the components actual bindings.
protected Object	parentValueForBinding(String binding) Utility to pull the value from the components parent, if the parent is a D2W wrapper component. 親コンポーネントが D2W ラパー・コンポーネントの場合のバインディング取得ユーティリティ
void	reset() Used by stateless subclasses.
void	resetCachedBindingsInStatefulComponent() Used by stateful but non-synching subclasses
void	setD2wContext(com.webobjects.directtoweb.D2WContext value) Sets the D2WContext.
void	setExtraBindings(Object value) Sets the extra bindings.
void	setKey(String newKey) Sets the property key.
void	setLocalContext(com.webobjects.directtoweb.D2WContext value) Sets the D2WContext.
boolean	synchronizesVariablesWithBindings() Overridden from superclass to turn on component synching, which is the default.
String	task() Gets the current D2W task.
boolean	taskIsEdit()
boolean	taskIsInspect()
boolean	taskIsList()
void	validationFailedWithException(Throwable e, Object value, String keyPath) Validation Support.
Object	valueForBinding(String binding) Fetches an object from the bindings.

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

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

Field Detail

log

public static final Logger log

logging support

extraBindings

protected Object extraBindings

Holds the extra bindings.

TRUE

protected static final Integer TRUE

FALSE

protected static final Integer FALSE

Constructor Detail

ERDCustomComponent

public ERDCustomComponent(com.webobjects.appserver.WOContext context)

Designated constructor

Method Detail

setLocalContext

public void setLocalContext(com.webobjects.directtoweb.D2WContext value)

Sets the D2WContext. Applies when used inside a D2WCustomComponent.

setD2wContext

public void setD2wContext(com.webobjects.directtoweb.D2WContext value)

Sets the D2WContext. Applies when used inside a property key repetition.

localContext

public com.webobjects.directtoweb.D2WContext localContext()

The active D2WContext. Simply calls to d2wContext()

d2wContext

public com.webobjects.directtoweb.D2WContext d2wContext()

The active D2WContext.

d2wContextFromBindings

protected com.webobjects.directtoweb.D2WContext d2wContextFromBindings()

Returns the active d2wContext. If the value was not set via KVC, tries to get the value from the bindings if the component is non-syncing アクティブな d2wContext を戻します。 KVC で設定されていなければ、非シンクロナイズ・コンポーネントのバインディングより取得を試し見る

task

public String task()

Gets the current D2W task.

taskIsEdit

public boolean taskIsEdit()

taskIsInspect

public boolean taskIsInspect()

taskIsList

public boolean taskIsList()

validationFailedWithException

public void validationFailedWithException(Throwable e,
                                          Object value,
                                          String keyPath)

Validation Support. Passes errors to the parent. Validation Support. エラーを親コンポーネントに渡す

Overrides:

validationFailedWithException in class com.webobjects.appserver.WOComponent

clearValidationFailed

public void clearValidationFailed()

Implementation of the ERXExceptionHolder interface. Clears exceptions in the parent if possible. ERXExceptionHolder インタフェース実装。可能であれば、親のエラーをクリアします。

Specified by:

clearValidationFailed in interface ERXExceptionHolder

integerBooleanForBinding

public Integer integerBooleanForBinding(String binding)

hasBinding

public boolean hasBinding(String binding)

Checks if the binding can be pulled. If the component is synching, throws an Exception. Otherwise checks the superclass and if the value for the binding is not null. バインディングが取得可能かどうかをチェックします。シンクロナイズ・コンポーネントの場合にはエラーを発行します。 そうでなければ、スーパークラスをバインディングが非 null であるようにチェックします

Overrides:

hasBinding in class com.webobjects.appserver.WOComponent

logDebugInfo

protected void logDebugInfo()

Utility to dump some debug info about this component and its parent

parentValueForBinding

protected Object parentValueForBinding(String binding)

Utility to pull the value from the components parent, if the parent is a D2W wrapper component. 親コンポーネントが D2W ラパー・コンポーネントの場合のバインディング取得ユーティリティ

originalValueForBinding

protected Object originalValueForBinding(String binding)

Utility to pull the value from the components actual bindings. コンポーネントのバインディングから取得するユーティリティ

d2wContextValueForBinding

protected Object d2wContextValueForBinding(String binding)

Utility to pull the value from the D2WContext. D2WContext から値を取得するユーティリティ

extraBindingsValueForBinding

protected Object extraBindingsValueForBinding(String binding)

Utility to pull the value from the extra bindings if supplied.

valueForBinding

public Object valueForBinding(String binding)

Fetches an object from the bindings. Tries the actual supplied bindings, the supplied d2wContext, the parent and finally the extra bindings dictionary. バインディングを使って、オブジェクトをフェッチする バインディングを次の順で取得を試す：コンポーネント、d2wContext、親コンポーネント、オプション・バインディング・ディクショナリー

Overrides:

valueForBinding in class com.webobjects.appserver.WOComponent

resetCachedBindingsInStatefulComponent

public void resetCachedBindingsInStatefulComponent()

Used by stateful but non-synching subclasses

Overrides:

resetCachedBindingsInStatefulComponent in class ERXNonSynchronizingComponent

reset

public void reset()

Used by stateless subclasses.

Overrides:

reset in class ERXComponent

setExtraBindings

public void setExtraBindings(Object value)

Sets the extra bindings.

extraBindings

public Object extraBindings()

Extra bindings supplied to the component. If this is a dictionary, it will be used for additional bindings.

setKey

public void setKey(String newKey)

Sets the property key.

key

public String key()

The active property key.

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overridden from superclass to turn on component synching, which is the default.

Overrides:

synchronizesVariablesWithBindings in class ERXNonSynchronizingComponent

Returns:

false

d2wDebuggingEnabled

public boolean d2wDebuggingEnabled()

Is D2W debugging enabled.

d2wComponentNameDebuggingEnabled

public boolean d2wComponentNameDebuggingEnabled()

Should the component name be shown. コンポーネント名を表示する？

d2wPropertyKeyDebuggingEnabled

public boolean d2wPropertyKeyDebuggingEnabled()

Should the property keys be shown. プロパティ・キーを表示する？

d2wPage

public D2WPage d2wPage()

Finds the containing D2WPage, if possible. There are certain situations when having a reference to the containing D2W page is useful, e.g., when needing to use the userInfo dictionary of ERD2WPage to pass information between subcomponents.

Returns:

the containing D2WPage 可能であれば、D2WPage の親コンポーネントを戻します。 場合によって、親 D2W ページへのアクセスは必要です。 ユーザ情報ディクショナリーへのアクセス等でサブコンポーネントの情報交換が可能です。

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse r,
                             com.webobjects.appserver.WOContext c)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.

Overrides:

appendToResponse in class ERXNonSynchronizingComponent

Parameters:

r - to which we are appending

c - context of the response