Package de.cuioss.test.jsf.config.decorator

Class ComponentConfigDecorator

java.lang.Object

de.cuioss.test.jsf.config.decorator.ComponentConfigDecorator

public class ComponentConfigDecorator
extends Object

Helper class acting as runtime-registry for UIComponent, Converter, Validator and Renderer

Author:

Oliver Wolff

Constructor Summary

Constructors

Constructor	Description
ComponentConfigDecorator(@NonNull Application application, @NonNull FacesContext facesContext)

Method Summary

Modifier and Type	Method	Description
ComponentConfigDecorator	addUiComponent(String expr, UIComponent component)	Add a component to the view root to be found when searching via UIComponentBase.findComponent(String).
ComponentConfigDecorator	registerBehavior(Class<? extends ClientBehavior> behaviorClass)	Register a ClientBehavior.
ComponentConfigDecorator	registerBehavior(String behaviorId, Class<? extends ClientBehavior> behaviorClass)	Register a ClientBehavior for a given behaviorId
ComponentConfigDecorator	registerCompositeComponent(String libraryName, String tagName, UIComponent uiComponent)	Register a composite component to be rendered.
ComponentConfigDecorator	registerConverter(Class<? extends Converter> converter)	Register a Converter for a given target class.
ComponentConfigDecorator	registerConverter(Class<? extends Converter> converter, Class<?> targetClass)	Register a Converter for a given target class.
ComponentConfigDecorator	registerConverter(Class<? extends Converter> converter, String converterId)	Register a Converter to a given converterId.
ComponentConfigDecorator	registerCuiMockComponentWithRenderer()	Shorthand for registering a CuiMockComponent with a CuiMockRenderer.
ComponentConfigDecorator	registerMockRenderer(String family, String rendererType)	Registers a CuiMockRenderer for the given attributes.
ComponentConfigDecorator	registerMockRendererForCommandButton()	Shorthand for registering a CuiMockRenderer for HtmlCommandButton.
ComponentConfigDecorator	registerMockRendererForHtmlForm()	Shorthand for registering a CuiMockRenderer for HtmlForm.
ComponentConfigDecorator	registerMockRendererForHtmlInputText()	Shorthand for registering a CuiMockRenderer for HtmlInputText.
ComponentConfigDecorator	registerMockRendererForHtmlOutputText()	Shorthand for registering a CuiMockRenderer for HtmlOutputText.
ComponentConfigDecorator	registerMockRendererForHtmlSelectBooleanCheckbox()	Shorthand for registering a CuiMockRenderer for HtmlSelectBooleanCheckbox.
ComponentConfigDecorator	registerMockRendererForHtmlSelectOneRadio()	Shorthand for registering a CuiMockRenderer for HtmlSelectOneRadio.
ComponentConfigDecorator	registerRenderer(Class<? extends Renderer> renderer)	Registers a Renderer The family and rendererType will be derived by the mandatory FacesRenderer annotation
ComponentConfigDecorator	registerRenderer(String family, String rendererType, Renderer renderer)	Registers a Renderer
ComponentConfigDecorator	registerUIComponent(Class<? extends UIComponent> component)	Registers a UIComponent
ComponentConfigDecorator	registerUIComponent(String componentType, Class<? extends UIComponent> component)	Registers a UIComponent
ComponentConfigDecorator	registerValidator(Class<? extends Validator> validator)	Adds add Validator the needed validatorId is retrieved from FacesValidator.
ComponentConfigDecorator	registerValidator(String validatorId, Class<? extends Validator> validator)	Adds add Validator to the given id.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentConfigDecorator

public ComponentConfigDecorator(@NonNull
                                @NonNull Application application,
                                @NonNull
                                @NonNull FacesContext facesContext)

Method Detail

registerValidator

public ComponentConfigDecorator registerValidator(String validatorId,
                                                  Class<? extends Validator> validator)

Adds add Validator to the given id.

Parameters:

validatorId - the id the Validator should be registered with, must not be null

validator - the actual Validator class, must not be null.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerValidator

public ComponentConfigDecorator registerValidator(Class<? extends Validator> validator)

Adds add Validator the needed validatorId is retrieved from FacesValidator.

Parameters:

validator - the actual Validator class, must not be null. In order to work the Validator must provide the FacesValidator annotation in order to identify the the needed validatorId

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerConverter

public ComponentConfigDecorator registerConverter(Class<? extends Converter> converter,
                                                  Class<?> targetClass)

Register a Converter for a given target class.

Parameters:

converter - to be registered , must not be null

targetClass - must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerConverter

public ComponentConfigDecorator registerConverter(Class<? extends Converter> converter)

Register a Converter for a given target class.

Parameters:

converter - to be registered , must not be null and must provide a FacesConverter annotation for deriving targetType or converter.id

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerConverter

public ComponentConfigDecorator registerConverter(Class<? extends Converter> converter,
                                                  String converterId)

Register a Converter to a given converterId.

Parameters:

converter - to be registered , must not be null

converterId - must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerUIComponent

public ComponentConfigDecorator registerUIComponent(String componentType,
                                                    Class<? extends UIComponent> component)

Registers a UIComponent

Parameters:

componentType - identifying the component, must not be null

component - the actual component, must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerUIComponent

public ComponentConfigDecorator registerUIComponent(Class<? extends UIComponent> component)

Registers a UIComponent

Parameters:

component - the actual component, must not be null must provide the FacesComponent annotation to derive the componentId to be registered to.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerCuiMockComponentWithRenderer

public ComponentConfigDecorator registerCuiMockComponentWithRenderer()

Shorthand for registering a CuiMockComponent with a CuiMockRenderer.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRenderer

public ComponentConfigDecorator registerMockRenderer(String family,
                                                     String rendererType)

Registers a CuiMockRenderer for the given attributes.

Parameters:

family - identifying the component-family the renderer is related to, must not be null

rendererType - identifying the type of the renderer is related to, must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForHtmlOutputText

public ComponentConfigDecorator registerMockRendererForHtmlOutputText()

Shorthand for registering a CuiMockRenderer for HtmlOutputText.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForHtmlSelectBooleanCheckbox

public ComponentConfigDecorator registerMockRendererForHtmlSelectBooleanCheckbox()

Shorthand for registering a CuiMockRenderer for HtmlSelectBooleanCheckbox.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForHtmlSelectOneRadio

public ComponentConfigDecorator registerMockRendererForHtmlSelectOneRadio()

Shorthand for registering a CuiMockRenderer for HtmlSelectOneRadio.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForHtmlInputText

public ComponentConfigDecorator registerMockRendererForHtmlInputText()

Shorthand for registering a CuiMockRenderer for HtmlInputText.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForHtmlForm

public ComponentConfigDecorator registerMockRendererForHtmlForm()

Shorthand for registering a CuiMockRenderer for HtmlForm.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerMockRendererForCommandButton

public ComponentConfigDecorator registerMockRendererForCommandButton()

Shorthand for registering a CuiMockRenderer for HtmlCommandButton.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerRenderer

public ComponentConfigDecorator registerRenderer(String family,
                                                 String rendererType,
                                                 Renderer renderer)

Registers a Renderer

Parameters:

family - identifying the component-family the renderer is related to, must not be null

rendererType - identifying the type of the renderer is related to, must not be null

renderer - the actual renderer to be registered, must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerRenderer

public ComponentConfigDecorator registerRenderer(Class<? extends Renderer> renderer)

Registers a Renderer The family and rendererType will be derived by the mandatory FacesRenderer annotation

Parameters:

renderer - the actual renderer to be registered, must not be null, must provide FacesRenderer annotation and a no arg public constructor.

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerBehavior

public ComponentConfigDecorator registerBehavior(String behaviorId,
                                                 Class<? extends ClientBehavior> behaviorClass)

Register a ClientBehavior for a given behaviorId

Parameters:

behaviorId - the id the ClientBehavior should be registered with, must not be null

behaviorClass - the actual type of the ClientBehavior must not be null

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerBehavior

public ComponentConfigDecorator registerBehavior(Class<? extends ClientBehavior> behaviorClass)

Register a ClientBehavior. The behaviorId will be extracted by the mandatory FacesBehavior annotation

Parameters:

behaviorClass - the actual type of the ClientBehavior must not be null and provide the FacesBehavior annotation in order to extract the correct behaviorId

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

registerCompositeComponent

public ComponentConfigDecorator registerCompositeComponent(String libraryName,
                                                           String tagName,
                                                           UIComponent uiComponent)

Register a composite component to be rendered.

Parameters:

libraryName - the library name like "http://xmlns.jcp.org/jsf/composite/" or "

tagName - the tag name

uiComponent - the component that should be returned as mock / placeholder for the composite component

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage

addUiComponent

public ComponentConfigDecorator addUiComponent(String expr,
                                               UIComponent component)

Add a component to the view root to be found when searching via UIComponentBase.findComponent(String).

Parameters:

expr - the expression the component should be found with

component - the component

Returns:

the ComponentConfigDecorator itself in order to enable a fluent-api style usage