com.neurosys.template.wicket.itemadapters

Class ListRenderAdapter

java.lang.Object

com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

com.neurosys.template.wicket.itemadapters.ScriptableCustomItemComponentRenderAdapter

com.neurosys.template.wicket.itemadapters.ListRenderAdapter

All Implemented Interfaces:

Serializable

public class ListRenderAdapter
extends ScriptableCustomItemComponentRenderAdapter

Renders a List from a data model (expected to be a List). The list will have an input hidden field, to marshal the changes in list typically in comma separated or JSON array format. Either way, the input field text will be conveyed to the CustomItemComponentRenderAdapter.getModelTransformer() , before its passed back to the calling API.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

CustomItemComponentRenderAdapter.ContextualTwoWayTransformer

Field Summary

Fields inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

authorizationModule, modelTransformer

Constructor Summary

Constructors

Constructor and Description
ListRenderAdapter()
ListRenderAdapter(ListRenderAdapter t)

Method Summary

Modifier and Type	Method and Description
org.apache.wicket.Component	getComponent(String componentId, MetaItem metaItem, org.apache.wicket.model.IModel model, Object modelObject, User user) Some fields/attribute may require display of options for selection or Auto-Suggest etc..
org.apache.commons.collections.Transformer	getDataTransformer() The actual Model for List rendering and the model for the data field may not be the same.
protected String	getInstanceId(MetaItem metaItem, Object modelObject) Javascript code needs to target its component so each instance will need an instanceId.
protected org.apache.wicket.model.IModel	getRawDataModel(org.apache.wicket.model.IModel model) The actual Model for List rendering and the model for the data field may not be the same.
boolean	isBindModelToRawData() The model to the component is what is provided as an Object to the whole component.
protected void	markComponentReadOnly(org.apache.wicket.Component c)
void	setBindModelToRawData(boolean bindModelToRawData) The model to the component is what is provided as an Object to the whole component.
void	setDataTransformer(org.apache.commons.collections.Transformer dataTransformer) The actual Model for List rendering and the model for the data field may not be the same.

Methods inherited from class com.neurosys.template.wicket.itemadapters.ScriptableCustomItemComponentRenderAdapter

attachScript, getScriptComponentId, getScriptTransformer, setScriptComponentId, setScriptTransformer

Methods inherited from class com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

filter, getDataList, getLookup, getModelTransformer, processSubmit, setModelTransformer, translateCurrentSelectionModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ListRenderAdapter

public ListRenderAdapter()

ListRenderAdapter

public ListRenderAdapter(ListRenderAdapter t)

Method Detail

markComponentReadOnly

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

Overrides:

markComponentReadOnly in class CustomItemComponentRenderAdapter

getInstanceId

protected String getInstanceId(MetaItem metaItem,
                               Object modelObject)

Description copied from class: ScriptableCustomItemComponentRenderAdapter

Javascript code needs to target its component so each instance will need an instanceId.
An overriding class can provide the ionstanceId as context to the Script to be generated.

Overrides:

getInstanceId in class ScriptableCustomItemComponentRenderAdapter

getRawDataModel

protected org.apache.wicket.model.IModel getRawDataModel(org.apache.wicket.model.IModel model)

The actual Model for List rendering and the model for the data field may not be the same. The data field by default takes on the default model supplied, however in some cases this can be a problem. This helps customize the data field String value.

The List Data model is decided by CustomItemComponentRenderAdapter.translateCurrentSelectionModel(IModel, Object, MetaItem). However, the raw data supplied in the data field may require additional transformation to String.

Parameters:

model - as IModel from the component

Returns:

IModel for the data hidden field

See Also:

dataTransformer, bindModelToRawData

getComponent

public org.apache.wicket.Component getComponent(String componentId,
                                                MetaItem metaItem,
                                                org.apache.wicket.model.IModel model,
                                                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 A List representation of the Model with a Script (if any)

Overrides:

getComponent in class ScriptableCustomItemComponentRenderAdapter

Parameters:

componentId - as Sting id for the Component

metaItem - as MetaItem meta data for rendering logic

model - 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

See Also:

ScriptableCustomItemComponentRenderAdapter

getDataTransformer

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

The actual Model for List rendering and the model for the data field may not be the same. The data field by default takes on the default model supplied, however in some cases this can be a problem. This helps customize the data field String value.

The List Data model is decided by CustomItemComponentRenderAdapter.translateCurrentSelectionModel(IModel, Object, MetaItem). However, the raw data supplied in the data field may require additional transformation to String.

See Also:

getRawDataModel(IModel)

setDataTransformer

public void setDataTransformer(org.apache.commons.collections.Transformer dataTransformer)

The actual Model for List rendering and the model for the data field may not be the same. The data field by default takes on the default model supplied, however in some cases this can be a problem. This helps customize the data field String value.

The List Data model is decided by CustomItemComponentRenderAdapter.translateCurrentSelectionModel(IModel, Object, MetaItem). However, the raw data supplied in the data field may require additional transformation to String.

See Also:

getRawDataModel(IModel)

isBindModelToRawData

public boolean isBindModelToRawData()

The model to the component is what is provided as an Object to the whole component. However, this component is also backed by a String based hidden data field.
In some cases concern/manipulation maybe directly on the data field.
If true, one can set this to true to process any submits related to changes in the data field.

See Also:

dataTransformer, getRawDataModel(IModel)

Default value:

false

setBindModelToRawData

public void setBindModelToRawData(boolean bindModelToRawData)

The model to the component is what is provided as an Object to the whole component. However, this component is also backed by a String based hidden data field.
In some cases concern/manipulation maybe directly on the data field.
If true, one can set this to true to process any submits related to changes in the data field.

See Also:

dataTransformer, getRawDataModel(IModel)

Default value:

false