er.extensions.components

Class ERXComponent

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

AjaxSocialNetworkLink, AjaxStatelessJSONClient, CCSegmentedSlider, ERAkismet, ERCFFileUpload, ERMODComponent, ERTagCloud, ERTagField, ERXExceptionPage, ERXFlickrBatchNavigation, ERXNonSynchronizingComponent, ERXRouteURL, ERXSimpleSpamCheck, SEComponent, SEEntitySnapshots, SESnapshotsList

public abstract class ERXComponent
extends com.webobjects.appserver.WOComponent

ERXComponent provides a common base class for WOComponents along with a bunch of miscellaneous handy features.

ERXComponent は WOComponents のサブクラスで、多数の便利なコマンドを用意しています

See Also:

Serialized Form

Author:

mschrag

Nested Class Summary

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 NSMutableDictionary	_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
ERXComponent(com.webobjects.appserver.WOContext context) Constructs a new ERXComponent.

Method Summary

Modifier and Type	Method and Description
void	_awakeInContext(com.webobjects.appserver.WOContext aArg0)
protected void	_checkAccess() _checkAccess is called prior to all three phases of the R-R loop to ensure that the user has permission to access this component.
protected String	_frameworkName() Returns the name of this component's framework or "app" if frameworkName() returns null.
protected void	_includeCSSResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Injects per-component CSS dependencies into the head tag based on the definitions in useDefaultComponentCSS(), defaultCSSPath(), primaryCSSFile(), and additionalCSSFiles().
protected void	_includeJavascriptResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Injects per-component javascript dependencies into the head tag based on the definitions in useDefaultComponentJavascript(), defaultJavascriptPath(), primaryJavascriptFile(), and additionalJavascriptFiles().
protected NSArray<String>	additionalCSSFiles() Returns an array of additional CSS files for this component, or null (or empty array) if there aren't any.
protected NSArray<String>	additionalJavascriptFiles() Returns an array of additional Javascript files for this component, or null (or empty array) if there aren't any.
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Calls _checkAccess prior to super.appendToResponse and adds support for ClickToOpen (TM).
protected <T> NSArray<T>	arrayValueForBinding(String binding) Resolves a given binding as an NSArray object.
protected <T> NSArray<T>	arrayValueForBinding(String binding, NSArray<T> defaultValue) Resolves a given binding as an NSArray object.
protected boolean	booleanValueForBinding(String binding) Resolves a given binding as a boolean value.
protected boolean	booleanValueForBinding(String binding, boolean defaultValue) Resolves a given binding as a boolean value.
protected boolean	booleanValueForBinding(String binding, ERXUtilities.BooleanOperation defaultValue) Resolves a given binding as a boolean value with the option of specifying a boolean operator as the default value.
ERXBrowser	browser() Convenience method to get the browser.
protected void	checkAccess() Override to provide custom security checks.
boolean	clickToOpenEnabled(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Returns whether or not click-to-open should be enabled for this component.
String	componentName() Returns the name of this component without the package name.
protected String	defaultCSSPath() Returns the default path prefix for CSS, which will be prepended to all required CSS files for this component.
protected String	defaultJavascriptPath() Returns the default path prefix for Javascript, which will be prepended to all required Javascript files for this component.
NSMutableDictionary	dynamicBindings() Lazily initialized dictionary which can be used for the 'item' binding in a repetition for example: 'item = dynamicBindings.myVariable'.
protected float	floatValueForBinding(String binding, float defaultValue) Resolves a given binding as a float value.
protected int	intValueForBinding(String binding, int defaultValue) Resolves a given binding as a int value.
com.webobjects.appserver.WOActionResults	invokeAction(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Calls _checkAccess prior to super.invokeAction.
protected boolean	isPageAccessAllowed() Override and return true for any components to which you would like to allow page level access.
ERXLocalizer	localizer() Convenience method to get the localizer.
protected Object	objectValueForBinding(String binding) Resolves a given binding as an object in the normal fashion of calling valueForBinding.
protected Object	objectValueForBinding(String binding, Object defaultValue) Resolves a given binding as an object in the normal fashion of calling valueForBinding.
<T extends com.webobjects.appserver.WOComponent> T	pageWithName(Class<T> componentClass) This variant of pageWithName provides a Java5 genericized version of the original pageWithName.
protected void	postAppendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override to hook into appendToResponse after super.appendToResponse.
protected void	preAppendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Override to hook into appendToResponse after security checks but before the super.appendToResponse.
protected String	primaryCSSFile() Returns the primary CSS file for this component, or null if there isn't one.
protected String	primaryJavascriptFile() Returns the primary Javascript file for this component, or null if there isn't one.
void	reset() このメソッドは、指定されているコンテクストのオブジェクトに対する、 ステートレス・コンポーネントの一時的リファレンスをリセットもしくは削除します。 あるコンポーネントの共有化されたインスタンスが、他のセッションによって再利用されるとき、 このメソッドを利用し、各コンポーネントのインスタンス変数を解放します。
protected boolean	shouldCheckAccess() Returns whether or not this component should check access before processing any of the request-response loop.
protected String	stringValueForBinding(String binding) Retrieves a given binding and if it is not null then returns toString called on the bound object.
protected String	stringValueForBinding(String binding, String defaultValue) Retrieves a given binding and if it is not null then returns toString called on the bound object.
void	takeValuesFromRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Calls _checkAccess prior to super.takeValuesFromRequest.
protected boolean	useDefaultComponentCSS() Returns true if this component provides a default CSS file that has the same name as the component itself.
protected boolean	useDefaultComponentJavascript() Returns true if this component provides a default Javascript file that has the same name as the component itself.

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, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_dynamicBindings

protected NSMutableDictionary _dynamicBindings

Constructor Detail

ERXComponent

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

Constructs a new ERXComponent.

Parameters:

context - the WOContext

Method Detail

pageWithName

public <T extends com.webobjects.appserver.WOComponent> T pageWithName(Class<T> componentClass)

This variant of pageWithName provides a Java5 genericized version of the original pageWithName. You would call it with: MyNextPage nextPage = pageWithName(MyNextPage.class);

Java5 の新しい pageWithName コマンド。 次の様に呼ばれます： MyNextPage nextPage = pageWithName(MyNextPage.class);

Type Parameters:

T -

the type of component to create

作成するコンポーネント・タイプ

Parameters:

componentClass -

the Class of the component to load

ロードするコンポーネントのクラス

Returns:

an instance of the requested component class

コンポーネント・クラスのインスタンス

_awakeInContext

public void _awakeInContext(com.webobjects.appserver.WOContext aArg0)

Overrides:

_awakeInContext in class com.webobjects.appserver.WOComponent

_checkAccess

protected void _checkAccess()
                     throws SecurityException

_checkAccess is called prior to all three phases of the R-R loop to ensure that the user has permission to access this component. You should override checkAccess to implement addition security checks.

各リスポンス・リクエスト・ループの最初に _checkAccess 実行され、ユーザがこのコンポーネントへのアクセスが可能かどうかをチェックします。 他のセキュリティ・チェックを行う時には checkAccess をオーバライドすると良い

Throws:

SecurityException -

if the user does not have permission

ユーザがアクセス権を持っていない場合

shouldCheckAccess

protected boolean shouldCheckAccess()

Returns whether or not this component should check access before processing any of the request-response loop. The default implementation just returns _isPage().

Returns:

whether or not this component should check access

takeValuesFromRequest

public void takeValuesFromRequest(com.webobjects.appserver.WORequest request,
                                  com.webobjects.appserver.WOContext context)

Calls _checkAccess prior to super.takeValuesFromRequest.

スーパーの前に _checkAccess のセキュリティ・チェックを行います

Overrides:

takeValuesFromRequest in class com.webobjects.appserver.WOComponent

Parameters:

request -

the current request with the WOComponent object

リクエスト

context -

context of a transaction

トランスアクションのコンテキスト

invokeAction

public com.webobjects.appserver.WOActionResults invokeAction(com.webobjects.appserver.WORequest request,
                                                             com.webobjects.appserver.WOContext context)

Calls _checkAccess prior to super.invokeAction.

スーパーの前に _checkAccess のセキュリティ・チェックを行います

Overrides:

invokeAction in class com.webobjects.appserver.WOComponent

Parameters:

request -

the current request with the WOComponent object

リクエスト

context -

context of a transaction

トランスアクションのコンテキスト

Returns:

a WOActionResults containing the result of the request

リクエスト結果を含む WOActionResults

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Calls _checkAccess prior to super.appendToResponse and adds support for ClickToOpen (TM).

スーパーの前にセキュリティ・チェックし、ClickToOpen (TM) サポート

Overrides:

appendToResponse in class com.webobjects.appserver.WOComponent

Parameters:

response -

the HTTP response that an application returns to a Web server to complete a cycle of the request-response loop

RR ループの最後のリスポンス結果を戻す

context -

context of a transaction

トランスアクションのコンテキスト

clickToOpenEnabled

public boolean clickToOpenEnabled(com.webobjects.appserver.WOResponse response,
                                  com.webobjects.appserver.WOContext context)

Returns whether or not click-to-open should be enabled for this component. By default this returns ERXClickToOpenSupport.isEnabled().

このコンポーネントで click-to-open をサポートしているかどうかを戻します。 デフォルトでは ERXClickToOpenSupport.isEnabled() を戻します。

Parameters:

response -

the response

リスポンス

context -

the context

コンテクスト

Returns:

whether or not click-to-open is enabled for this component

このコンポーネントで click-to-open をサポートしているかどうか

intValueForBinding

protected int intValueForBinding(String binding,
                                 int defaultValue)

Resolves a given binding as a int value. Useful for image sizes and the like.

指定されているバインディングを int 値に変換して戻します。
イメージ・サイズなどに有効です

Parameters:

binding -

binding to be resolved as a int value.

int 値として戻すバインディング

defaultValue -

default int value to be used if the binding is not bound.

バインディングが見つからない場合のデフォルト int 値

Returns:

result of evaluating binding as a int.

バインディング結果の int 値

floatValueForBinding

protected float floatValueForBinding(String binding,
                                     float defaultValue)

Resolves a given binding as a float value.

指定されているバインディングを float 値に変換して戻します。

Parameters:

binding -

binding to be resolved as a float value.

float 値として戻すバインディング

defaultValue -

default float value to be used if the binding is not bound.

バインディングが見つからない場合のデフォルト float 値

Returns:

result of evaluating binding as a float.

バインディング結果の float 値

booleanValueForBinding

protected boolean booleanValueForBinding(String binding)

Resolves a given binding as a boolean value. Defaults to false.

指定されているバインディングを boolean 値に変換して戻します。
デフォルトは false です

Parameters:

binding -

binding to be resolved as a boolean value.

boolean 値として戻すバインディング

Returns:

result of evaluating binding as a boolean.

バインディング結果の boolean 値

booleanValueForBinding

protected boolean booleanValueForBinding(String binding,
                                         boolean defaultValue)

Resolves a given binding as a boolean value.

指定されているバインディングを boolean 値に変換して戻します。

Parameters:

binding -

binding to be resolved as a boolean value.

boolean 値として戻すバインディング

defaultValue -

default boolean value to be used if the binding is not bound.

バインディングが見つからない場合のデフォルト boolean 値

Returns:

result of evaluating binding as a boolean.

バインディング結果の boolean 値

booleanValueForBinding

protected boolean booleanValueForBinding(String binding,
                                         ERXUtilities.BooleanOperation defaultValue)

Resolves a given binding as a boolean value with the option of specifying a boolean operator as the default value.

指定されているバインディングを boolean 値に変換して戻します。
boolean operator を指定することが可能です

Parameters:

binding -

binding to be resolved as a boolean value.

boolean 値として戻すバインディング

defaultValue -

boolean operator to be evaluated if the binding is not present.

バインディングが見つからない場合のデフォルト boolean operator

Returns:

result of evaluating binding as a boolean.

バインディング結果の boolean 値

objectValueForBinding

protected Object objectValueForBinding(String binding)

Resolves a given binding as an object in the normal fashion of calling valueForBinding. This has the one advantage of being able to resolve the resulting object as a {link ERXUtilities$Operation} if it is an Operation and then returning the result as the evaluation of that operation.

指定されているバインディングを object として戻します。
valueForBindingと違って、結果オブジェクトを{link ERXUtilities$Operation} として戻され、処理が含まれるの場合、処理の結果を取得します。

Parameters:

binding -

name of the component binding.

コンポーネントのバインディング名

Returns:

the object for the given binding and in the case that it is an instance of an Operation the value of that operation.

指定されているバインディングのオブジェクト（処理の値のインスタンス）

objectValueForBinding

protected Object objectValueForBinding(String binding,
                                       Object defaultValue)

Resolves a given binding as an object in the normal fashion of calling valueForBinding. This has the one advantage of being able to resolve the resulting object as a {link ERXUtilities$Operation} if it is an Operation and then returning the result as the evaluation of that operation.

指定されているバインディングを object として戻します。
valueForBindingと違って、結果オブジェクトを{link ERXUtilities$Operation} として戻され、処理が含まれるの場合、処理の結果を取得します。

Parameters:

binding -

name of the component binding.

コンポーネントのバインディング名

defaultValue -

value to be used if valueForBinding returns null.

valueForBinding が null を戻す場合のデフォルト値

Returns:

the object for the given binding and in the case that it is an instance of an Operation the value of that operation.

指定されているバインディングのオブジェクト（処理の値のインスタンス）

stringValueForBinding

protected String stringValueForBinding(String binding)

Retrieves a given binding and if it is not null then returns toString called on the bound object.

指定されているバインディングのオブジェクトが nullでなければ、
toString が呼ばれ、結果を戻します。

Parameters:

binding -

name of the component binding.

コンポーネントのバインディング名

Returns:

resolved binding in string format

指定されているバインディングの文字列表現

stringValueForBinding

protected String stringValueForBinding(String binding,
                                       String defaultValue)

Retrieves a given binding and if it is not null then returns toString called on the bound object.

指定されているバインディングのオブジェクトが nullでなければ、
toString が呼ばれ、結果を戻します。

Parameters:

binding -

name of the component binding.

コンポーネントのバインディング名

defaultValue -

value to be used if valueForBinding returns null.

valueForBinding が null を戻す場合のデフォルト値

Returns:

resolved binding in string format

指定されているバインディングの文字列表現

arrayValueForBinding

protected <T> NSArray<T> arrayValueForBinding(String binding)

Resolves a given binding as an NSArray object.

指定されているバインディングを NSArray 値に変換して戻します。

Type Parameters:

T - type of array elements

Parameters:

binding -

name of the component binding.

NSArray 値として戻すバインディング

Returns:

result of evaluating binding as an NSArray.

バインディング結果の NSArray 値

arrayValueForBinding

protected <T> NSArray<T> arrayValueForBinding(String binding,
                                              NSArray<T> defaultValue)

Resolves a given binding as an NSArray object.

指定されているバインディングを NSArray 値に変換して戻します。

Type Parameters:

T - type of array elements

Parameters:

binding -

name of the component binding.

NSArray 値として戻すバインディング

defaultValue -

value to be used if valueForBinding returns null.

バインディングが見つからない場合のデフォルト NSArray 値

Returns:

result of evaluating binding as an NSArray.

バインディング結果の NSArray 値

localizer

public ERXLocalizer localizer()

Convenience method to get the localizer.

ローカライザーを取得する為の便利なメソッド

Returns:

the current localizer

カレント・ローカライザー

browser

public ERXBrowser browser()

Convenience method to get the browser.

browser オブジェクトを戻します。基本的には session にも directaction にも browser オブジェクトへのアクセスがありますが、 session 又は directaction 内にあるかどうか分からない時にはこのコマンドが便利です。

Returns:

the current browser

browser オブジェクト

dynamicBindings

public NSMutableDictionary dynamicBindings()

Lazily initialized dictionary which can be used for the 'item' binding in a repetition for example: 'item = dynamicBindings.myVariable'. Useful in rapid turnaround modes where adding a iVar would cause hot code swapping to stop working.

ダイナミック・バインディング用ディクショナリー repetition内、バインディングの 'item' として使用できます。
例えば、 'item = dynamicBindings.myVariable'

Returns:

a dictionay for use with dynamic bindings

NSMutableDictionary ダイナミック・バインディング・ディクショナリー

reset

public void reset()

このメソッドは、指定されているコンテクストのオブジェクトに対する、 ステートレス・コンポーネントの一時的リファレンスをリセットもしくは削除します。 あるコンポーネントの共有化されたインスタンスが、他のセッションによって再利用されるとき、 このメソッドを利用し、各コンポーネントのインスタンス変数を解放します。

Overrides:

reset in class com.webobjects.appserver.WOComponent

componentName

public String componentName()

Returns the name of this component without the package name.

このコンポーネントの名前を戻します。（パッケージ無し）

Returns:

the name of this component without the package name

このコンポーネントの名前

_includeCSSResources

protected void _includeCSSResources(com.webobjects.appserver.WOResponse response,
                                    com.webobjects.appserver.WOContext context)

Injects per-component CSS dependencies into the head tag based on the definitions in useDefaultComponentCSS(), defaultCSSPath(), primaryCSSFile(), and additionalCSSFiles().

If you return true for useDefaultComponentCSS (and do not override primaryCSSFile), this component will inject a reference to defaultCSSPath() + /YourComponentName.css. For instance, if your component is named HeaderFooter, useDefaultComponentCSS will automatically add a reference to defaultCSSPath() + /HeaderFooter.css for you. This allows you to very easily specify per-component CSS files without upper-level components knowing about them. Currently _includeCSSResources does not try to do anything fancy in terms of recombining CSS files.

Override defaultCSSPath to provide the base path relative to WebServerResources that contains your CSS files. If all of your CSS is in WebServerResources/css, you would return "css" from defaultCSSPath().

If you do not want to use the component's name as the name of the CSS file, you can optionally override primaryCSSFile() to return the name of a specific CSS file, as well as additionalCSSFiles() to return an NSArray of CSS files. All of these file names will be prepended with the defaultCSSPath if it is set.

useDefaultComponentCSS(), defaultCSSPath(),primaryCSSFile(), と additionalCSSFiles() で定義されているコンポーネントに依存した CSS をヘッダー内に挿入します。

useDefaultComponentCSS で true を戻す場合　（primaryCSSFileをオーバライドしないで） このコンポーネントは defaultCSSPath() + /YourComponentName.css をヘッダーに挿入します。 例えば、コンポーネントの名前が HeaderFooter とし、useDefaultComponentCSS は自動的に defaultCSSPath() + /HeaderFooter.css へのレファレンスを作成します。 この機能を使うことで、簡単にコンポーネントに属している CSS ファイルを作成でき、上位のコンポーネントを 意識する必要がありません。 現在では _includeCSSResources は CSS ファイルの結合などを行いません。

defaultCSSPath をオーバライドすること、CSS ファイルを含む WebServerResources への元パスを提供します。 すべての CSS が WebServerResources/css 内にある場合、defaultCSSPath() として "css" を戻します。

CSS ファイルとしてコンポーネント名を使用したく無い場合、primaryCSSFile() をオーバライドすることで、 ある CSS ファイル名を戻します。それとも、additionalCSSFiles() で CSS ファイルの NSArray を戻します。 すべてのファイル名は defaultCSSPath を先頭に追加されるのです。

Parameters:

response -

the response to write into

書き込みするリスポンス

context -

the current context

カレント・コンテクスト

_includeJavascriptResources

protected void _includeJavascriptResources(com.webobjects.appserver.WOResponse response,
                                           com.webobjects.appserver.WOContext context)

Injects per-component javascript dependencies into the head tag based on the definitions in useDefaultComponentJavascript(), defaultJavascriptPath(), primaryJavascriptFile(), and additionalJavascriptFiles().

If you return true for useDefaultComponentJavascript (and do not override primaryJavascriptFile), this component will inject a reference to defaultJavascriptPath() + /YourComponentName.js. For instance, if your component is named HeaderFooter, useDefaultComponentJavascript will automatically add a reference to defaultJavascriptPath() + /HeaderFooter.js for you. This allows you to very easily specify per-component Javascript files without upper-level components knowing about them. Currently _includeJavascriptResources does not try to do anything fancy in terms of recombinding Javascript files.

Override defaultJavascriptPath to provide the base path relative to WebServerResources that contains your Javascript files. If all of your Javascript is in WebServerResources/scripts, you would return "scripts" from defaultJavascriptPath().

If you do not want to use the component's name as the name of the Javascript file, you can optionally override primaryJavascriptFile() to return the name of a specific Javascript file, as well as additionalJavascriptFiles() to return an NSArray of Javascript files. All of these file names will be prepended with the defaultJavascriptPath if it is set.

useDefaultComponentJavascript(), defaultJavascriptPath(), primaryJavascriptFile(), と additionalJavascriptFiles() で定義されているコンポーネントに依存した javascript をヘッダー内に挿入します。

useDefaultComponentJavascript で true を戻す場合　（primaryJavascriptFileをオーバライドしないで） このコンポーネントは defaultJavascriptPath() + /YourComponentName.js をヘッダーに挿入します。 例えば、コンポーネントの名前が HeaderFooter とし、useDefaultComponentJavascript は自動的に defaultJavascriptPath() + /HeaderFooter.js へのレファレンスを作成します。 この機能を使うことで、簡単にコンポーネントに属している Javascript ファイルを作成でき、上位のコンポーネントを 意識する必要がありません。 現在では _includeJavascriptResources は Javascript ファイルの結合などを行いません。

defaultJavascriptPath をオーバライドすること、Javascript ファイルを含む WebServerResources への元パスを提供します。 すべての Javascript が WebServerResources/scripts 内にある場合、defaultJavascriptPath() として "scripts" を戻します。

Javascript ファイルとしてコンポーネント名を使用したく無い場合、primaryJavascriptFile() をオーバライドすることで、 ある Javascript ファイル名を戻します。それとも、additionalJavascriptFiles() で Javascript ファイルの NSArray を戻します。 すべてのファイル名は defaultJavascriptPath を先頭に追加されるのです。

Parameters:

response -

the response to write into

書き込みするリスポンス

context -

the current context

カレント・コンテクスト

_frameworkName

protected String _frameworkName()

Returns the name of this component's framework or "app" if frameworkName() returns null.

このコンポーネントのフレームワークを戻します。 frameworkName() が null の場合には "app" が戻ります。

Returns:

the name of this component's framework

このコンポーネントのフレームワーク

useDefaultComponentCSS

protected boolean useDefaultComponentCSS()

Returns true if this component provides a default CSS file that has the same name as the component itself.

コンポーネントと同じ名前を持つデフォルト CSS ファイルがある場合には true が戻ります。

Returns:

true if this component provides a default-named CSS

デフォルト CSS ファイルがある場合には true

defaultCSSPath

protected String defaultCSSPath()

Returns the default path prefix for CSS, which will be prepended to all required CSS files for this component. The default is "".

CSS へのデフォルトパスの先頭を戻します。このコンポーネントの全 CSS ファイルに適用します。 デフォルトは ""

Returns:

the default CSS path.

デフォルト CSS パス

primaryCSSFile

protected String primaryCSSFile()

Returns the primary CSS file for this component, or null if there isn't one. This path will be prepended with defaultCSSPath().

このコンポーネントのメイン CSS ファイルを戻します。無ければ、 null が戻ります。 このパスは defaultCSSPath() と合成されます。

Returns:

the primary CSS file for this component

このコンポーネントのメイン CSS ファイル

additionalCSSFiles

protected NSArray<String> additionalCSSFiles()

Returns an array of additional CSS files for this component, or null (or empty array) if there aren't any. Each path will be prepended with defaultCSSPath().

このコンポーネントに必要なオプション CSS ファイルの配列。無ければ、null (empty array) 各自のパスは defaultCSSPath() と合成されます。

Returns:

an array of additional CSS files for this component.

このコンポーネントに必要なオプション CSS ファイルの配列

useDefaultComponentJavascript

protected boolean useDefaultComponentJavascript()

Returns true if this component provides a default Javascript file that has the same name as the component itself.

コンポーネントと同じ名前を持つデフォルト Javascript ファイルがある場合には true が戻ります。

Returns:

true if this component provides a default-named Javascript

デフォルト Javascript ファイルがある場合には true

defaultJavascriptPath

protected String defaultJavascriptPath()

Returns the default path prefix for Javascript, which will be prepended to all required Javascript files for this component. The default is "".

Javascript へのデフォルトパスの先頭を戻します。このコンポーネントの全 Javascript ファイルに適用します。 デフォルトは ""

Returns:

the default Javascript path.

デフォルト Javascript パス

primaryJavascriptFile

protected String primaryJavascriptFile()

Returns the primary Javascript file for this component, or null if there isn't one. This path will be prepended with defaultJavascriptPath().

このコンポーネントのメイン Javascript ファイルを戻します。無ければ、 null が戻ります。 このパスは defaultJavascriptPath() と合成されます。

Returns:

the primary Javascript file for this component

このコンポーネントのメイン Javascript ファイル

additionalJavascriptFiles

protected NSArray<String> additionalJavascriptFiles()

Returns an array of additional Javascript files for this component, or null (or empty array) if there aren't any. Each path will be prepended with defaultJavascriptPath().

このコンポーネントに必要なオプション Javascript ファイルの配列。無ければ、null (empty array) 各自のパスは defaultJavascriptPath() と合成されます。

Returns:

an array of additional Javascript files for this component.

このコンポーネントに必要なオプション Javascript ファイルの配列

isPageAccessAllowed

protected boolean isPageAccessAllowed()

Override and return true for any components to which you would like to allow page level access.

ページ・レベル・アクセス true はページへのアクセスが可能です

Returns:

true by default

デフォルトは true

checkAccess

protected void checkAccess()
                    throws SecurityException

Override to provide custom security checks. It is not necessary to call super on this method.

カスタム・セキュリティ・チェックを行う場合にはオーバライドするといいのです。 スーパーを呼ぶ必要ありません。

Throws:

SecurityException -

if the security check fails

セキュリティ・チェックが失敗した場合

preAppendToResponse

protected void preAppendToResponse(com.webobjects.appserver.WOResponse response,
                                   com.webobjects.appserver.WOContext context)

Override to hook into appendToResponse after security checks but before the super.appendToResponse. It is not necessary to call super on this method.

セキュリティ・チェックの後で、super.appendToResponse を呼ぶ前の横取り このフェーズに何がする必要がある場合は、オーバライドするといいのです この中ではスーパーを呼ぶ必要ありません。

Parameters:

response -

the current response

カレント・リスポンス

context -

the current context

カレント・コンテクスト

postAppendToResponse

protected void postAppendToResponse(com.webobjects.appserver.WOResponse response,
                                    com.webobjects.appserver.WOContext context)

Override to hook into appendToResponse after super.appendToResponse. It is not necessary to call super on this method.

super.appendToResponse を直後の横取り このフェーズに何がする必要がある場合は、オーバライドするといいのです この中ではスーパーを呼ぶ必要ありません。

Parameters:

response -

the current response

カレント・リスポンス

context -

the current context

カレント・コンテクスト