er.extensions.components

Class ERXComponentUtilities

java.lang.Object

er.extensions.components.ERXComponentUtilities

public class ERXComponentUtilities
extends Object

ERXComponentUtilities contains WOComponent/WOElement-related utility methods.

Author:

mschrag

Field Summary

Fields

Modifier and Type	Field and Description
static WOAssociation	EMPTY
static WOAssociation	FALSE
static WOAssociation	TRUE
static WOAssociation	ZERO

Constructor Summary

Constructors

Constructor and Description
ERXComponentUtilities()

Method Summary

Modifier and Type	Method and Description
static NSMutableDictionary<String,WOAssociation>	_queryParameterAssociations(NSDictionary<String,WOAssociation> associations, boolean removeQueryParameterAssociations)
static NSMutableDictionary	_queryParametersInComponent(NSMutableDictionary associations, WOComponent component)
static void	appendHtmlAttribute(String key, WOAssociation association, WOResponse response, WOComponent component) Appends an association as an HTML attribute.
static void	appendHtmlAttributes(NSDictionary<String,WOAssociation> associations, NSArray<String> excludeKeys, WOResponse response, WOComponent component) Appends a dictionary of associations as HTML attributes.
static void	appendHtmlAttributes(NSDictionary<String,WOAssociation> associations, WOResponse response, WOComponent component) Appends a dictionary of associations as HTML attributes.
static void	appendHtmlAttributes(NSDictionary<String,WOAssociation> associations, WOResponse response, WOContext context) Appends a dictionary of associations as HTML attributes.
static <T> NSArray<T>	arrayValueForBinding(String name, NSArray<T> defaultValue, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current array value of the given binding from the component.
static NSArray	arrayValueForBinding(String name, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current array value of the given binding from the component.
static boolean	bindingIsSettable(String name, NSDictionary<String,WOAssociation> associations) Checks if the association for a binding with the given name can assign values at runtime.
static WOAssociation	bindingNamed(String name, NSDictionary<String,WOAssociation> associations) Returns the association for a binding with the given name.
static boolean	booleanValueForBinding(String name, boolean defaultValue, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current boolean value of the given binding from the component.
static boolean	booleanValueForBinding(String name, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current boolean value of the given binding from the component.
static boolean	booleanValueForBinding(WOComponent component, String bindingName) Returns the boolean value of a binding.
static boolean	booleanValueForBinding(WOComponent component, String bindingName, boolean defaultValue) Returns the boolean value of a binding.
static NSArray<String>	componentTree() Returns an array of the current component names.
static boolean	hasBinding(String name, NSDictionary<String,WOAssociation> associations) Checks if there is an association for a binding with the given name.
static String	htmlTemplate(String componentName, NSArray languages) Returns the contents of the html template for the given component name as a string.
static URL	htmlTemplateUrl(String componentName, NSArray languages) Returns the URL of the html template for the given component name.
static WOElement	inheritTemplateFrom(String componentName, NSArray<String> languages) Allows a component to "inherit" the template (.html and .wod files) from another component.
static int	integerValueForBinding(String name, int defaultValue, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current int value of the given binding from the component.
static <T extends WOComponent> T	pageWithName(Class<T> componentClass) Calls pageWithName with ERXWOContext.currentContext() for the current thread.
static <T extends WOComponent> T	pageWithName(Class<T> componentClass, WOContext context) Returns the component for the given class without having to cast.
static NSMutableDictionary<String,WOAssociation>	queryParameterAssociations(NSDictionary<String,WOAssociation> associations) Returns the set of ?key=value associations from an associations dictionary.
static NSMutableDictionary<String,WOAssociation>	queryParameterAssociations(NSMutableDictionary<String,WOAssociation> associations, boolean removeQueryParameterAssociations) Returns the set of ?key=value associations from an associations dictionary.
static NSMutableDictionary	queryParametersInComponent(NSDictionary associations, WOComponent component) Returns a query parameter dictionary from a set of ?key=association WOAssociation dictionary.
static NSMutableDictionary	queryParametersInComponent(NSMutableDictionary associations, WOComponent component, boolean removeQueryParametersAssociations) Returns a query parameter dictionary from a set of ?key=association WOAssociation dictionary.
static void	setValueForBinding(Object value, String name, NSDictionary<String,WOAssociation> associations, WOComponent component) Will try to set the given binding in the component to the passed value.
static String	stringValueForBinding(String name, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current string value of the given binding from the component.
static String	stringValueForBinding(String name, String defaultValue, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current string value of the given binding from the component.
static String	template(String componentName, String extension, NSArray languages) Returns the contents of the template for the given component name as a string.
static URL	templateUrl(String componentName, String extension, NSArray languages) Returns the URL of the template for the given component name.
static Object	valueForBinding(String name, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current value of the given binding from the component.
static Object	valueForBinding(String name, Object defaultValue, NSDictionary<String,WOAssociation> associations, WOComponent component) Retrieves the current value of the given binding from the component.

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static WOAssociation TRUE

FALSE

public static WOAssociation FALSE

EMPTY

public static WOAssociation EMPTY

ZERO

public static WOAssociation ZERO

Constructor Detail

ERXComponentUtilities

public ERXComponentUtilities()

Method Detail

queryParametersInComponent

public static NSMutableDictionary queryParametersInComponent(NSDictionary associations,
                                                             WOComponent component)

Returns a query parameter dictionary from a set of ?key=association WOAssociation dictionary.

Parameters:

associations - the set of associations

component - the component to evaluate their values within

Returns:

a dictionary of key-value query parameters

queryParametersInComponent

public static NSMutableDictionary queryParametersInComponent(NSMutableDictionary associations,
                                                             WOComponent component,
                                                             boolean removeQueryParametersAssociations)

Returns a query parameter dictionary from a set of ?key=association WOAssociation dictionary.

Parameters:

associations - the set of associations

component - the component to evaluate their values within

removeQueryParametersAssociations - should the entries be removed from the passed-in dictionary?

Returns:

a dictionary of key-value query parameters

_queryParametersInComponent

public static NSMutableDictionary _queryParametersInComponent(NSMutableDictionary associations,
                                                              WOComponent component)

queryParameterAssociations

public static NSMutableDictionary<String,WOAssociation> queryParameterAssociations(NSDictionary<String,WOAssociation> associations)

Returns the set of ?key=value associations from an associations dictionary.

Parameters:

associations - the associations to enumerate

Returns:

dictionary with query parameter associations

queryParameterAssociations

public static NSMutableDictionary<String,WOAssociation> queryParameterAssociations(NSMutableDictionary<String,WOAssociation> associations,
                                                                                   boolean removeQueryParameterAssociations)

Returns the set of ?key=value associations from an associations dictionary. If removeQueryParameterAssociations is true, the corresponding entries will be removed from the associations dictionary that was passed in.

Parameters:

associations - the associations to enumerate

removeQueryParameterAssociations - should the entries be removed from the passed-in dictionary?

Returns:

dictionary with query parameter associations

_queryParameterAssociations

public static NSMutableDictionary<String,WOAssociation> _queryParameterAssociations(NSDictionary<String,WOAssociation> associations,
                                                                                    boolean removeQueryParameterAssociations)

booleanValueForBinding

public static boolean booleanValueForBinding(WOComponent component,
                                             String bindingName)

Returns the boolean value of a binding.

Parameters:

component - the component

bindingName - the name of the boolean binding

Returns:

a boolean

booleanValueForBinding

public static boolean booleanValueForBinding(WOComponent component,
                                             String bindingName,
                                             boolean defaultValue)

Returns the boolean value of a binding.

Parameters:

component - the component

bindingName - the name of the boolean binding

defaultValue - the default value if the binding is null

Returns:

a boolean

htmlTemplateUrl

public static URL htmlTemplateUrl(String componentName,
                                  NSArray languages)

Returns the URL of the html template for the given component name.

Parameters:

componentName - the name of the component to load a template for (without the .wo)

languages - the list of languages to use for finding components

Returns:

the URL to the html template (or null if there isn't one)

templateUrl

public static URL templateUrl(String componentName,
                              String extension,
                              NSArray languages)

Returns the URL of the template for the given component name.

Parameters:

componentName - the name of the component to load a template for (without the .wo)

extension - the file extension of the template (without the dot -- i.e. "html")

languages - the list of languages to use for finding components

Returns:

the URL to the template (or null if there isn't one)

htmlTemplate

public static String htmlTemplate(String componentName,
                                  NSArray languages)
                           throws IOException

Returns the contents of the html template for the given component name as a string.

Parameters:

componentName - the name of the component to load a template for (without the .wo)

languages - the list of languages to use for finding components

Returns:

the string contents of the html template (or null if there isn't one)

Throws:

IOException

template

public static String template(String componentName,
                              String extension,
                              NSArray languages)
                       throws IOException

Returns the contents of the template for the given component name as a string.

Parameters:

componentName - the name of the component to load a template for (without the .wo)

extension - the file extension of the template (without the dot -- i.e. "html")

languages - the list of languages to use for finding components

Returns:

the string contents of the template (or null if there isn't one)

Throws:

IOException

inheritTemplateFrom

public static WOElement inheritTemplateFrom(String componentName,
                                            NSArray<String> languages)

Allows a component to "inherit" the template (.html and .wod files) from another component.

Usage in your WOComponent subclass:

 @Override
 public WOElement template() {
     return ERXComponentUtilities.inheritTemplateFrom("AddAddress", session().languages());
 }
 

This very simple implementation does have some limitations:

1. It can't be used to inherit the template of another component inheriting a template.
2. It can't handle having two components with the same name in different packages or frameworks
3. It does not use WO template caching

Parameters:

componentName - the name of the component whose template will be inherited

languages - the list of languages to use for finding components

Returns:

the template from the indicated component

See Also:

WOComponent.template()

componentTree

public static NSArray<String> componentTree()

Returns an array of the current component names.

Returns:

array of current component names

appendHtmlAttributes

public static void appendHtmlAttributes(NSDictionary<String,WOAssociation> associations,
                                        WOResponse response,
                                        WOContext context)

Appends a dictionary of associations as HTML attributes.

Parameters:

associations - the associations dictionary

response - the response to write to

context - the context

appendHtmlAttributes

public static void appendHtmlAttributes(NSDictionary<String,WOAssociation> associations,
                                        WOResponse response,
                                        WOComponent component)

Appends a dictionary of associations as HTML attributes.

Parameters:

associations - the associations dictionary

response - the response to write to

component - the component to evaluate the associations within

appendHtmlAttributes

public static void appendHtmlAttributes(NSDictionary<String,WOAssociation> associations,
                                        NSArray<String> excludeKeys,
                                        WOResponse response,
                                        WOComponent component)

Appends a dictionary of associations as HTML attributes.

Parameters:

associations - the associations dictionary

excludeKeys - the associations to ignore

response - the response to write to

component - the component to evaluate the associations within

appendHtmlAttribute

public static void appendHtmlAttribute(String key,
                                       WOAssociation association,
                                       WOResponse response,
                                       WOComponent component)

Appends an association as an HTML attribute.

Parameters:

key - the key to append

association - the association

response - the response to write to

component - the component to evaluate the association within

pageWithName

public static <T extends WOComponent> T pageWithName(Class<T> componentClass,
                                                     WOContext context)

Returns the component for the given class without having to cast. For example: MyPage page = ERXComponentUtilities.pageWithName(MyPage.class, context);

Type Parameters:

T - the type of component to

Parameters:

componentClass - the component class to lookup

context - the context

Returns:

the created component

pageWithName

public static <T extends WOComponent> T pageWithName(Class<T> componentClass)

Calls pageWithName with ERXWOContext.currentContext() for the current thread.

Type Parameters:

T - the type of component to

Parameters:

componentClass - the component class to lookup

Returns:

the created component

hasBinding

public static boolean hasBinding(String name,
                                 NSDictionary<String,WOAssociation> associations)

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

Parameters:

name - binding name

associations - array of associations

Returns:

true if the association exists

bindingNamed

public static WOAssociation bindingNamed(String name,
                                         NSDictionary<String,WOAssociation> associations)

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

Parameters:

name - binding name

associations - array of associations

Returns:

association for given binding or null

bindingIsSettable

public static boolean bindingIsSettable(String name,
                                        NSDictionary<String,WOAssociation> associations)

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

Parameters:

name - binding name

associations - array of associations

Returns:

true if binding is settable

setValueForBinding

public static void setValueForBinding(Object value,
                                      String name,
                                      NSDictionary<String,WOAssociation> associations,
                                      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

associations - array of associations

component - component to set the value in

valueForBinding

public static Object valueForBinding(String name,
                                     Object defaultValue,
                                     NSDictionary<String,WOAssociation> associations,
                                     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

associations - array of associations

component - component to get value from

Returns:

retrieved value or default value

valueForBinding

public static Object valueForBinding(String name,
                                     NSDictionary<String,WOAssociation> associations,
                                     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

associations - array of associations

component - component to get value from

Returns:

retrieved value or null

stringValueForBinding

public static String stringValueForBinding(String name,
                                           String defaultValue,
                                           NSDictionary<String,WOAssociation> associations,
                                           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

associations - array of associations

component - component to get value from

Returns:

retrieved string value or default value

stringValueForBinding

public static String stringValueForBinding(String name,
                                           NSDictionary<String,WOAssociation> associations,
                                           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

associations - array of associations

component - component to get value from

Returns:

retrieved string value or null

booleanValueForBinding

public static boolean booleanValueForBinding(String name,
                                             boolean defaultValue,
                                             NSDictionary<String,WOAssociation> associations,
                                             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

associations - array of associations

component - component to get value from

Returns:

retrieved boolean value or default value

booleanValueForBinding

public static boolean booleanValueForBinding(String name,
                                             NSDictionary<String,WOAssociation> associations,
                                             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

associations - array of associations

component - component to get value from

Returns:

retrieved boolean value or false

integerValueForBinding

public static int integerValueForBinding(String name,
                                         int defaultValue,
                                         NSDictionary<String,WOAssociation> associations,
                                         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

associations - array of associations

component - component to get value from

Returns:

retrieved int value or default value

arrayValueForBinding

public static <T> NSArray<T> arrayValueForBinding(String name,
                                                  NSArray<T> defaultValue,
                                                  NSDictionary<String,WOAssociation> associations,
                                                  WOComponent component)

Retrieves the current array 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

associations - array of associations

component - component to get value from

Returns:

retrieved array value or default value

arrayValueForBinding

public static NSArray arrayValueForBinding(String name,
                                           NSDictionary<String,WOAssociation> associations,
                                           WOComponent component)

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

Parameters:

name - binding name

associations - array of associations

component - component to get value from

Returns:

retrieved array value or null