com.neurosys.template.wicket.itemadapters

Class ScriptableCustomItemComponentRenderAdapter

java.lang.Object

com.neurosys.template.wicket.itemadapters.CustomItemComponentRenderAdapter

com.neurosys.template.wicket.itemadapters.ScriptableCustomItemComponentRenderAdapter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ListRenderAdapter

public class ScriptableCustomItemComponentRenderAdapter
extends CustomItemComponentRenderAdapter

A CustomItemComponentRenderAdapter that will also generate an accompany the component with a Script either in the web page header within the component.

Author:

Arjun Dhar

See Also:

scriptComponentId, scriptTransformer, 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
ScriptableCustomItemComponentRenderAdapter()
ScriptableCustomItemComponentRenderAdapter(ScriptableCustomItemComponentRenderAdapter t)

Method Summary

Modifier and Type	Method and Description
protected void	attachScript(org.apache.wicket.Component c, MetaItem metaItem, Object modelObject, User user)
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..
protected String	getInstanceId(MetaItem metaItem, Object modelObject) Javascript code needs to target its component so each instance will need an instanceId.
String	getScriptComponentId()
org.apache.commons.collections.Transformer	getScriptTransformer() A Transformer that converts this components state into markup or script and appends it to the component DOM.
void	setScriptComponentId(String scriptComponentId)
void	setScriptTransformer(org.apache.commons.collections.Transformer scriptTransformer) A Transformer that converts this components state into markup or script and appends it to the component DOM.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableCustomItemComponentRenderAdapter

public ScriptableCustomItemComponentRenderAdapter()

ScriptableCustomItemComponentRenderAdapter

public ScriptableCustomItemComponentRenderAdapter(ScriptableCustomItemComponentRenderAdapter t)

Method Detail

getInstanceId

protected String getInstanceId(MetaItem metaItem,
                               Object modelObject)

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.

Can be null:

true

attachScript

protected void attachScript(org.apache.wicket.Component c,
                            MetaItem metaItem,
                            Object modelObject,
                            User user)

Parameters:

c - as Component to the final component generated by this Adapter

getComponent

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

Description copied from class: CustomItemComponentRenderAdapter

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

Overrides:

getComponent in class CustomItemComponentRenderAdapter

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

getScriptComponentId

public String getScriptComponentId()

setScriptComponentId

public void setScriptComponentId(String scriptComponentId)

getScriptTransformer

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

A Transformer that converts this components state into markup or script and appends it to the component DOM.
The Transformer takes in a Map is a context which contains the following:

• lookup - #getDataList(lookup, MetaItem, Object)
• instanceId - The DOM instance id of the container of this component on UI
• metaItem - MetaItem
• modelObject - Model Object
• user - User

One could you Velocity to render the script using a VelocityTransformer

setScriptTransformer

public void setScriptTransformer(org.apache.commons.collections.Transformer scriptTransformer)

A Transformer that converts this components state into markup or script and appends it to the component DOM.
The Transformer takes in a Map is a context which contains the following:

• lookup - #getDataList(lookup, MetaItem, Object)
• instanceId - The DOM instance id of the container of this component on UI
• metaItem - MetaItem
• modelObject - Model Object
• user - User

One could you Velocity to render the script using a VelocityTransformer