er.extensions.components

Class ERXDynamicElement

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

Direct Known Subclasses:

AjaxDynamicElement, CCGoogleAnalytics, ERPDFWrapper, ERXKeyValueSetter, ERXLoremIpsum, ERXWOFormBarrier

public abstract class ERXDynamicElement
extends com.webobjects.appserver._private.WODynamicGroup

ERXDynamicElement provides a common base class for dynamic elements.

All subclasses of ERXDynamicElement have to be thread safe! The WOAssociation objects are thread safe as they don't hold a specific value but are used to retrieve the correct value from the current parent component. If you want or have to store values in instance variables use the inner class ERXDynamicElement.ContextData as value holder. Those objects will store values indirectly within the current context which means you can declare them as static.

Author:

jw

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ERXDynamicElement.ContextData<T> This class is used to store values that cannot be stored in instance variables as dynamic elements have to be thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
ERXDynamicElement(String name, NSDictionary<String,WOAssociation> associations, NSMutableArray<WOElement> children)
ERXDynamicElement(String name, NSDictionary<String,WOAssociation> associations, WOElement template)

Method Summary

Modifier and Type	Method and Description
protected void	afterProcessing(WOContext context) Convenience method to override if you want to store values in ContextData object.
protected void	appendTagAttributeToResponse(WOResponse response, String name, Object value) Appends the attribute to the response.
<T> NSArray<T>	arrayValueForBinding(String name, NSArray<T> defaultValue, WOComponent component) Resolves a given binding as an NSArray object.
<T> NSArray<T>	arrayValueForBinding(String name, WOComponent component) Resolves a given binding as an NSArray object.
NSDictionary<String,WOAssociation>	associations() Returns the element's association dictionary.
protected void	beforeProcessing(WOContext context) Convenience method to override if you want to store values in ContextData object.
boolean	bindingIsSettable(String name) Checks if the association for a binding with the given name can assign values at runtime.
WOAssociation	bindingNamed(String name) Returns the association for a binding with the given name.
boolean	booleanValueForBinding(String name, boolean defaultValue, WOComponent component) Retrieves the current boolean value of the given binding from the component.
boolean	booleanValueForBinding(String name, WOComponent component) Retrieves the current boolean value of the given binding from the component.
boolean	hasBinding(String name) Checks if there is an association for a binding with the given name.
String	id(WOContext context) Return the value of the id binding if it exists or a safe identifier otherwise.
int	integerValueForBinding(String name, int defaultValue, WOComponent component) Retrieves the current int value of the given binding from the component.
protected String	nameInContext(WOContext context) Returns the name of this element within the given context.
boolean	secureInContext(WOContext context) Checks if we are in secure mode by checking the secure binding or the context's secure mode as fallback.
void	setValueForBinding(Object value, String name, WOComponent component) Will try to set the given binding in the component to the passed value.
String	stringValueForBinding(String name, String defaultValue, WOComponent component) Retrieves the current string value of the given binding from the component.
String	stringValueForBinding(String name, WOComponent component) Retrieves the current string value of the given binding from the component.
Object	valueForBinding(String name, Object defaultValue, WOComponent component) Retrieves the current value of the given binding from the component.
Object	valueForBinding(String name, WOComponent component) Retrieves the current value of the given binding from the component.

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, appendToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeAction, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.log4j.Logger log

Constructor Detail

ERXDynamicElement

public ERXDynamicElement(String name,
                         NSDictionary<String,WOAssociation> associations,
                         WOElement template)

ERXDynamicElement

public ERXDynamicElement(String name,
                         NSDictionary<String,WOAssociation> associations,
                         NSMutableArray<WOElement> children)

Method Detail

associations

public NSDictionary<String,WOAssociation> associations()

Returns the element's association dictionary.

Returns:

the element's association dictionary

id

public String id(WOContext context)

Return the value of the id binding if it exists or a safe identifier otherwise.

Parameters:

context - context of the transaction

Returns:

id string for this component

nameInContext

protected String nameInContext(WOContext context)

Returns the name of this element within the given context. This corresponds to the elementID.

Parameters:

context - context of the transaction

Returns:

elementID

secureInContext

public boolean secureInContext(WOContext context)

Checks if we are in secure mode by checking the secure binding or the context's secure mode as fallback.

Parameters:

context - context of the transaction

Returns:

true if in secure mode

hasBinding

public boolean hasBinding(String name)

Checks if there is an association for a binding with the given name.

Parameters:

name - binding name

Returns:

true if the association exists

bindingNamed

public WOAssociation bindingNamed(String name)

Returns the association for a binding with the given name. If there is no such association null will be returned.

Parameters:

name - binding name

Returns:

association for given binding or null

bindingIsSettable

public boolean bindingIsSettable(String name)

Checks if the association for a binding with the given name can assign values at runtime.

Parameters:

name - binding name

Returns:

true if binding is settable

setValueForBinding

public void setValueForBinding(Object value,
                               String name,
                               WOComponent component)

Will try to set the given binding in the component to the passed value.

Parameters:

value - new value for the binding

name - binding name

component - component to set the value in

valueForBinding

public Object valueForBinding(String name,
                              Object defaultValue,
                              WOComponent component)

Retrieves the current value of the given binding from the component. If there is no such binding or its value evaluates to null the default value will be returned.

Parameters:

name - binding name

defaultValue - default value

component - component to get value from

Returns:

retrieved value or default value

valueForBinding

public Object valueForBinding(String name,
                              WOComponent component)

Retrieves the current value of the given binding from the component. If there is no such binding null will be returned.

Parameters:

name - binding name

component - component to get value from

Returns:

retrieved value or null

stringValueForBinding

public String stringValueForBinding(String name,
                                    String defaultValue,
                                    WOComponent component)

Retrieves the current string value of the given binding from the component. If there is no such binding or its value evaluates to null the default value will be returned.

Parameters:

name - binding name

defaultValue - default value

component - component to get value from

Returns:

retrieved string value or default value

stringValueForBinding

public String stringValueForBinding(String name,
                                    WOComponent component)

Retrieves the current string value of the given binding from the component. If there is no such binding null will be returned.

Parameters:

name - binding name

component - component to get value from

Returns:

retrieved string value or null

booleanValueForBinding

public boolean booleanValueForBinding(String name,
                                      boolean defaultValue,
                                      WOComponent component)

Retrieves the current boolean value of the given binding from the component. If there is no such binding the default value will be returned.

Parameters:

name - binding name

defaultValue - default value

component - component to get value from

Returns:

retrieved boolean value or default value

booleanValueForBinding

public boolean booleanValueForBinding(String name,
                                      WOComponent component)

Retrieves the current boolean value of the given binding from the component. If there is no such binding false will be returned.

Parameters:

name - binding name

component - component to get value from

Returns:

retrieved boolean value or false

integerValueForBinding

public int integerValueForBinding(String name,
                                  int defaultValue,
                                  WOComponent component)

Retrieves the current int value of the given binding from the component. If there is no such binding the default value will be returned.

Parameters:

name - binding name

defaultValue - default value

component - component to get value from

Returns:

retrieved int value or default value

arrayValueForBinding

public <T> NSArray<T> arrayValueForBinding(String name,
                                           WOComponent component)

Resolves a given binding as an NSArray object.

Type Parameters:

T - the type of the array's items

Parameters:

name - binding name

component - component to get value from

Returns:

retrieved array value or null

arrayValueForBinding

public <T> NSArray<T> arrayValueForBinding(String name,
                                           NSArray<T> defaultValue,
                                           WOComponent component)

Resolves a given binding as an NSArray object.

Type Parameters:

T - the type of the array's items

Parameters:

name - binding name

defaultValue - default value

component - component to get value from

Returns:

retrieved array value or default value

appendTagAttributeToResponse

protected void appendTagAttributeToResponse(WOResponse response,
                                            String name,
                                            Object value)

Appends the attribute to the response. If the value is null the appending is skipped.

Parameters:

response - the current response

name - the attribute name

value - the attribute value

beforeProcessing

protected void beforeProcessing(WOContext context)

Convenience method to override if you want to store values in ContextData object. Here you can call the ERXDynamicElement.ContextData.begin(WOContext, Object) on your ContextData objects. This method should then be called at the beginning of the WODynamicGroup.appendToResponse(WOResponse, WOContext), WODynamicGroup.takeValuesFromRequest(WORequest, WOContext) and WODynamicGroup.invokeAction(WORequest, WOContext).

Parameters:

context - context of the transaction

afterProcessing

protected void afterProcessing(WOContext context)

Convenience method to override if you want to store values in ContextData object. Here you can call the ERXDynamicElement.ContextData.end(WOContext) on your ContextData objects. This method should then be called at the end of the WODynamicGroup.appendToResponse(WOResponse, WOContext), WODynamicGroup.takeValuesFromRequest(WORequest, WOContext) and WODynamicGroup.invokeAction(WORequest, WOContext).

Parameters:

context - context of the transaction