com.neurosys.template.wicket.itemadapters

Class CustomItemComponentRenderAdapter

java.lang.Object

com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JSONGridRenderAdapter, MapRenderAdapter, ScriptableCustomItemComponentRenderAdapter, SelectRenderAdapter, SimpleEditorAdapter, SizeRenderAdapter, TextAreaAdapter

public class CustomItemComponentRenderAdapter
extends Object
implements Serializable

A custom adapter that allows one to customize how a particular MetaItem could be rendered in ProductDetailsTemplatePanel

Important : This Adapter has to adopt a singleton model as its really a FACTORY and calling components like FacetMeta definitions are Singleton's.
This means all modelTransformer, #lookup etc are all and should be stateless.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CustomItemComponentRenderAdapter.ContextualTwoWayTransformer Some TwoWayTransformer may need additional context, can use this to supply context.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizationModule<Void>	authorizationModule
protected org.apache.commons.collections.Transformer	modelTransformer An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.

Constructor Summary

Constructors

Constructor and Description
CustomItemComponentRenderAdapter()
CustomItemComponentRenderAdapter(CustomItemComponentRenderAdapter t)

Method Summary

Modifier and Type	Method and Description
protected org.apache.wicket.Component	filter(org.apache.wicket.Component c, MetaItem mi, User user) Apply Authorization etc
org.apache.wicket.Component	getComponent(String componentId, MetaItem metaItem, org.apache.wicket.model.IModel rawModel, Object modelObject, User user) Some fields/attribute may require display of options for selection or Auto-Suggest etc..
List	getDataList(Object rawLookup, MetaItem metaItem, Object modelObject) Provides Lookup Data Model for {#getLookupComponent(com.neurosys.content.wicket.pages.panel.TemplatePanel.MetaItem)
protected Object	getLookup(MetaItem metaItem)
org.apache.commons.collections.Transformer	getModelTransformer() An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.
protected void	markComponentReadOnly(org.apache.wicket.Component c)
Object	processSubmit(MetaItem metaItem, org.apache.wicket.Component fieldEntityComponent, Object value, User user) Call on submit of component.
void	setModelTransformer(org.apache.commons.collections.Transformer modelTransformer) An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.
protected org.apache.wicket.model.IModel	translateCurrentSelectionModel(org.apache.wicket.model.IModel defaultModel, Object modelObject, MetaItem metaItem) Helper method: The Object model may not be the type expected by the component type defined in this Adapter, so provide a conversion from raw data to desired UI type.

Methods inherited from class java.lang.Object

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

Field Detail

modelTransformer

protected transient org.apache.commons.collections.Transformer modelTransformer

An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.
This is to dynamically handle complex data types that need to be transformed to a model acceptable to the Display Unit.

The Core Model for the field/attribute may not be suitable for consumption, so allow custom Transformers to re-model it and pass it on to the final rendering component/widget.

Example: A Multi-Select drop down may demand a Collection of current selections (multiple), however the model maybe represented as a Comma separated list. This would require a Transformeration from the String to a genuine Collection data structure.

Can be null:

true

authorizationModule

protected AuthorizationModule<Void> authorizationModule

Constructor Detail

CustomItemComponentRenderAdapter

public CustomItemComponentRenderAdapter()

CustomItemComponentRenderAdapter

public CustomItemComponentRenderAdapter(CustomItemComponentRenderAdapter t)

Method Detail

getDataList

public List getDataList(Object rawLookup,
                        MetaItem metaItem,
                        Object modelObject)

Provides Lookup Data Model for {#getLookupComponent(com.neurosys.content.wicket.pages.panel.TemplatePanel.MetaItem)

Parameters:

rawLookup - as Object (String or Transformer that produces a List)

Returns:

List

getLookup

protected Object getLookup(MetaItem metaItem)

getComponent

public org.apache.wicket.Component getComponent(String componentId,
                                                MetaItem metaItem,
                                                org.apache.wicket.model.IModel rawModel,
                                                Object modelObject,
                                                User user)

Some fields/attribute may require display of options for selection or Auto-Suggest etc..

Providing rendering option for lookup for that field/attribute. The base class returns a Hidden field, which can be overriden by any derived adapter.
If no mapping exists, then null will be returned.
Base class implementation returns HiddenField

Parameters:

componentId - as Sting id for the Component

metaItem - as MetaItem meta data for rendering logic

rawModel - is the current data defined in a IModel for the MetaItem. The resultant model in the returned Component may NOT be same as the one passed to the inner component, hence always use the derived one. This is because there maybe a mismatch in the form of core/raw data and one required for final presentation. For example the input maybe a Comma Separated list of Strings, however for presentation in a List box we may convert the Model to a ListModel.

modelObject - as Object, that represents the main Entity (overall context)

user - as com.neurosys.security.auth.domain.User for any Authorization related needs @nullable true

Returns:

Component @nullable true

translateCurrentSelectionModel

protected org.apache.wicket.model.IModel translateCurrentSelectionModel(org.apache.wicket.model.IModel defaultModel,
                                                                        Object modelObject,
                                                                        MetaItem metaItem)

Helper method:
The Object model may not be the type expected by the component type defined in this Adapter, so provide a conversion from raw data to desired UI type.
The default method uses getModelTransformer() if it finds one or else it will return the original IModel passed.

Parameters:

defaultModel - of the component

modelObject - of the container entity

metaItem - as MetaItem

Returns:

See Also:

DefaultWicketTemplateRenderAdapter#validateAndTransform} and the use of {@link TwoWayTransformer} on how the Model is Transformed back during submission. Provide any translation here.

processSubmit

public Object processSubmit(MetaItem metaItem,
                            org.apache.wicket.Component fieldEntityComponent,
                            Object value,
                            User user)

Call on submit of component. Should ideally also update the model behind input Component fieldEntityComponent
If modelTransformer is a TwoWayTransformer then this method can be skipped.

Parameters:

metaItem - as MetaItem

fieldEntityComponent - as Component, the same component that the RenderAdapter created in getComponent(String, MetaItem, IModel, Object, User)

value - as Object

user - as User

Returns:

getModelTransformer

public org.apache.commons.collections.Transformer getModelTransformer()

An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.
This is to dynamically handle complex data types that need to be transformed to a model acceptable to the Display Unit.

The Core Model for the field/attribute may not be suitable for consumption, so allow custom Transformers to re-model it and pass it on to the final rendering component/widget.

Example: A Multi-Select drop down may demand a Collection of current selections (multiple), however the model maybe represented as a Comma separated list. This would require a Transformeration from the String to a genuine Collection data structure.

Can be null:

true

setModelTransformer

public void setModelTransformer(org.apache.commons.collections.Transformer modelTransformer)

An OPTIONAL Transformer or a TwoWayTransformer that knows how to Marshal the data model to presentation, and in the case of a TwoWayTransformer then back from presentation to Data model.
This is to dynamically handle complex data types that need to be transformed to a model acceptable to the Display Unit.

The Core Model for the field/attribute may not be suitable for consumption, so allow custom Transformers to re-model it and pass it on to the final rendering component/widget.

Example: A Multi-Select drop down may demand a Collection of current selections (multiple), however the model maybe represented as a Comma separated list. This would require a Transformeration from the String to a genuine Collection data structure.

Can be null:

true

markComponentReadOnly

protected void markComponentReadOnly(org.apache.wicket.Component c)

filter

protected org.apache.wicket.Component filter(org.apache.wicket.Component c,
                                             MetaItem mi,
                                             User user)

Apply Authorization etc