com.neurosys.template.model.renderadapters

Class DefaultWicketTemplateRenderAdapter<T>

java.lang.Object

com.neurosys.template.model.renderadapters.DefaultWicketTemplateRenderAdapter<T>

Type Parameters:

T -

All Implemented Interfaces:

CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>, Serializable

public class DefaultWicketTemplateRenderAdapter<T>
extends Object
implements CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

A CustomTemplateRenderAdapter that understands how to render various ContentType from the core content entity.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.template.model.CustomTemplateRenderAdapter

CustomTemplateRenderAdapter.Nothing

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_CHOICE_REMOVE_NO_SELECTION
static String	ATTRIB_CHOICE_RENDER_SETTINGS AutoCompleteSettings or IChoiceRenderer if ContentType.INPUT_AUTO_SUGGEST or ContentType.SELECT is used.
static String	ATTRIB_FRAGMENT_ID Name the generated Fragment using the wicket Id corresponding to this attribute.
static String	ATTRIB_INPUT_TYPE Input type fields can override type from text to say email to support HTL5 validation in the field tag itself.
static String	ATTRIB_LOOKUP Deprecated.
protected AuthorizationModule<Void>	authorizationModule
protected org.apache.wicket.markup.html.WebMarkupContainer	callingTemplate
protected List<org.apache.wicket.Component>	rawAddedComponents Maintain a context of all components added for the Caller
protected FileUploadWrapper	resourceUploader
protected Template	template

Fields inherited from interface com.neurosys.template.model.CustomTemplateRenderAdapter

nothing

Constructor Summary

Constructors

Constructor and Description
DefaultWicketTemplateRenderAdapter(List<org.apache.wicket.Component> rawAddedComponents, FileUploadWrapper resourceUploader, Template template, org.apache.wicket.markup.html.WebMarkupContainer callingTemplate)
DefaultWicketTemplateRenderAdapter(Template template)
DefaultWicketTemplateRenderAdapter(Template template, org.apache.wicket.markup.html.WebMarkupContainer callingTemplate)

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	getComponentForType(MetaItem metaItem, String fieldComponentName, org.apache.wicket.model.IModel model, org.apache.wicket.MarkupContainer container, T modelObject, User user) One can override to customize specific components or impose some manual override over what is dynamically generated.
protected FieldAjaxEventBehavior	getContentEditorAjaxSavingBehavior(org.apache.wicket.ajax.markup.html.AjaxLink link, org.apache.wicket.ajax.IAjaxCallDecorator callDecorator, MetaItem metaItem, T modelObject, ContentFacet facet) If The Adapter uses a Content Editor which is capable of independent facet update hence it requires a FieldAjaxEventBehavior to define how that editor will behave on actions like onClick
static DefaultWicketTemplateRenderAdapter	getInstance()
String	getItemRefId(MetaItem metaItem) A way to identify the panels/components for feedback on submit etc.
protected String	identifyEntity(T entity) Identify an entity; for log purposes etc
protected boolean	isExemptFromProcessing(MetaItem meta, Object value) Some elements maybe processed exceptionally outside the automated process, determine which to leave out
protected void	markComponentHidden(org.apache.wicket.Component c)
protected void	markComponentReadOnly(org.apache.wicket.Component c)
Object	processItem(T entity, MetaItem metaItem, org.apache.wicket.Component coreEntityDataField, User user, Object... contextParams) For each meta item handle processing on submit and derive the value to be submitted/persisted back
void	reset() During Ajax calls a Render Adapter maybe called multiple times.
org.apache.wicket.Component	unwrap(org.apache.wicket.Component entityDataField) Remove the wrapper to pass back the component the custom render adapter created
protected Object	validateAndTransform(MetaItem meta, Object value, org.apache.wicket.Component entityDataField, User user) Submit, Validate the returned object and return the validated/Transformed value, based on the following:

Methods inherited from class java.lang.Object

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

Field Detail

rawAddedComponents

protected transient List<org.apache.wicket.Component> rawAddedComponents

Maintain a context of all components added for the Caller

resourceUploader

protected transient FileUploadWrapper resourceUploader

template

protected transient Template template

callingTemplate

protected transient org.apache.wicket.markup.html.WebMarkupContainer callingTemplate

authorizationModule

protected AuthorizationModule<Void> authorizationModule

ATTRIB_FRAGMENT_ID

public static final String ATTRIB_FRAGMENT_ID

Name the generated Fragment using the wicket Id corresponding to this attribute.

See Also:

Constant Field Values

ATTRIB_LOOKUP

@Deprecated
public static final String ATTRIB_LOOKUP

Deprecated.

A backing Object or a Transformer that returns a backing object like a list to Support Drop Downs and Auto Suggest.
If this is a Transformer then the input will be an Object array of the following in sequence [0]Field Model, [1] Entity Object, [2] MetaItem, [3] user

See Also:

FacetMeta.getLookup(), Constant Field Values

ATTRIB_CHOICE_RENDER_SETTINGS

public static final String ATTRIB_CHOICE_RENDER_SETTINGS

AutoCompleteSettings or IChoiceRenderer if ContentType.INPUT_AUTO_SUGGEST or ContentType.SELECT is used.

See Also:

Constant Field Values

ATTRIB_CHOICE_REMOVE_NO_SELECTION

public static final String ATTRIB_CHOICE_REMOVE_NO_SELECTION

See Also:

SelectRenderAdapter.isRemoveNoSelectionOption(), Constant Field Values

ATTRIB_INPUT_TYPE

public static final String ATTRIB_INPUT_TYPE

Input type fields can override type from text to say email to support HTL5 validation in the field tag itself.

See Also:

Constant Field Values

Constructor Detail

DefaultWicketTemplateRenderAdapter

public DefaultWicketTemplateRenderAdapter(Template template,
                                          org.apache.wicket.markup.html.WebMarkupContainer callingTemplate)

DefaultWicketTemplateRenderAdapter

public DefaultWicketTemplateRenderAdapter(Template template)

DefaultWicketTemplateRenderAdapter

public DefaultWicketTemplateRenderAdapter(List<org.apache.wicket.Component> rawAddedComponents,
                                          FileUploadWrapper resourceUploader,
                                          Template template,
                                          org.apache.wicket.markup.html.WebMarkupContainer callingTemplate)

Method Detail

getInstance

public static DefaultWicketTemplateRenderAdapter getInstance()

markComponentHidden

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

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

getComponentForType

public org.apache.wicket.Component getComponentForType(MetaItem metaItem,
                                                       String fieldComponentName,
                                                       org.apache.wicket.model.IModel model,
                                                       org.apache.wicket.MarkupContainer container,
                                                       T modelObject,
                                                       User user)

One can override to customize specific components or impose some manual override over what is dynamically generated. When selecting type if both Field and ContentFacetMeta exist then ContentFacetMeta is given preference as it is defined by Config in a Template

Other than the usual types TEXT, HIDDEN, PASSWORD, CHECK_BOX, IMG, TEXT_AREA, some complex types supported and their rendering is as follows
(Note that the fragment name convention is <ContentType name>_<Field/property Name> for REF, JSON, JSON_ARRAY, ARRAY and <ContentType name> for other complex types):

• ContentType.IMG - Core field name 'currentImg' of type StaticImageComponent - Renders the image and the ability to upload a new one
• ContentType.REF - Core field name 'input' of type HiddenField - A reference to some values. the values can be derived from other input support defined on the UI.
  Example Colors. One may choose to use a Color palette to represent the colors available. The palette can be defined directly by the UI and only the resultant values selected can be put in the core hidden field associated with the server component.
• ContentType.ARRAY - Core field name 'input' of type HiddenField - Supports an array of comma separated values (Strings)
• ContentType.JSON - Core field name 'input' of type HiddenField - If an Object is being used then it will be marshaled/serialized into JSON format automatically and processed as such.
  The Object de-serialization should ideally support to and from JSON format.
• ContentType.JSON_ARRAY - Core field 'name' input of type HiddenField - If an Array of Object(s) is being used then it will be marshaled/serialized into JSON format automatically and processed as such.
  The Object de-serialization should ideally support to and from JSON format.

  
        Usage Sample :
			<wicket:panel>

		<tr wicket:id="items">			
			<td><span wicket:id="fieldName" /><div wicket:id="feedback" style='background-color:#EEEEEE'></div></td>
			<td><div wicket:id="productField"></div></td>
		</tr>

		<!-- Specific complex types -->
		<wicket:fragment wicket:id="IMG">
			<img wicket:id="currentImg" onerror='onImgError(this, "img/common/no-image.gif")' /><br>
			<input wicket:id="file" type='file' />			
		</wicket:fragment>

		<wicket:fragment wicket:id="REF_colors">
			Color(s): -- Deprecated, colors now ARRAY type
			<input wicket:id="input" type='hidden' />			
		</wicket:fragment>
		<wicket:fragment wicket:id="ARRAY_colors">
			Color(s):
			<input wicket:id="input" type='hidden' />			
		</wicket:fragment>
		<wicket:fragment wicket:id="JSON_size">
			Size:
			<input wicket:id="input" type='hidden' />			
		</wicket:fragment>
		<wicket:fragment wicket:id="JSON_ARRAY_relatedGroups">
			Related Groups:
			<input wicket:id="input" type='hidden' />			
		</wicket:fragment>
		<wicket:fragment wicket:id="FILE_BIN">
			<a wicket:id='link'></a>
			<input wicket:id="file" type='file' />
		</wicket:fragment>

	</wicket:panel>
  

If the model for the component is null, then it will use MetaItem.getFacetMeta() default value

For SELECT type, please prefer to use a IChoiceRenderer instead of FacetMeta.getDisplayTransformer(); his is because the drop-down has no way to reverse map the output display to the input model. One can do it like this:

public class OrgnaizationChoiceRenderer implements IChoiceRenderer {
    private static final long serialVersionUID = 1L;

    public Object getDisplayValue(T object) {
        if(object != null) {
            return object.getDisplayName();
        }
        else {
            return "None";
        }
    }

    public String getIdValue(T object, int index) {
        if(object instanceof Organization) {
            return object.getName();
        }
        else {
            // AbstractSingleSelectChoice.NO_SELECTION_VALUE == "-1"
            return "-1";
        }
    }
}        

With the corresponding Spring code for a Single SELECT as:

{@literal 

        
        
        
             
            
                
                
                    
                    
                
            
        
        
    
         }

With the corresponding Spring code for a MULTI-SELECT as:

{@literal 
        
        
        
        
             
            
                
                
            
        
        
    
         }

Specified by:

getComponentForType in interface CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Parameters:

metaItem - as MetaItem

fieldComponentName - as the rendering fieldComponentName or Id (of the component to be created)

model - as MODEL of the value extracted from the original modelObject for the MetaItem. This is a variable that would typically be extracted from the modeObject using the MetaItem, however there is complex logic that can vary and hence is expected to be provided to this method.

container - as CONTAINER_COMPONENT containing the produced component

modelObject - as the core domain Object/Entity

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

Returns:

COMPONENT

See Also:

SelectRenderAdapter

isExemptFromProcessing

protected boolean isExemptFromProcessing(MetaItem meta,
                                         Object value)

Some elements maybe processed exceptionally outside the automated process, determine which to leave out

unwrap

public org.apache.wicket.Component unwrap(org.apache.wicket.Component entityDataField)

Remove the wrapper to pass back the component the custom render adapter created

validateAndTransform

protected Object validateAndTransform(MetaItem meta,
                                      Object value,
                                      org.apache.wicket.Component entityDataField,
                                      User user)
                               throws javax.validation.ValidationException

Submit, Validate the returned object and return the validated/Transformed value, based on the following:

                                Map attribs = meta.getFacetMeta().getAttributes();
                                if (attribs!=null) {
                                        if (attribs.containsKey("expectedFieldType")) expectedFieldType = (Class)attribs.get("expectedFieldType");
                                        if (attribs.containsKey("expectedFieldRegex")) regEx = (String)attribs.get("expectedFieldRegex");
                                        if (attribs.containsKey("expectedNull")) nullable = (Boolean)attribs.get("expectedNull");
                                        if (attribs.containsKey("nullValidation")) nullValidation = (Boolean)attribs.get("nullValidation");
                                }
 

Parameters:

meta - as MetaItem

value - as Object (but serializable to String).

entityDataField - as Component

user - as User

Returns:

value (same or modified)

Throws:

Exception

javax.validation.ValidationException

processItem

public Object processItem(T entity,
                          MetaItem metaItem,
                          org.apache.wicket.Component coreEntityDataField,
                          User user,
                          Object... contextParams)
                   throws Exception

For each meta item handle processing on submit and derive the value to be submitted/persisted back Context Param 0 - resourceLocationMap as Map to specify the path where a File may be required to be stored

Specified by:

processItem in interface CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Returns:

Object value for the entity form field
Note: null or CustomTemplateRenderAdapter.Nothing (nothing). Nothing should not be persisted or used, it implies it should be ignored.

Throws:

Exception

getContentEditorAjaxSavingBehavior

protected FieldAjaxEventBehavior getContentEditorAjaxSavingBehavior(org.apache.wicket.ajax.markup.html.AjaxLink link,
                                                                    org.apache.wicket.ajax.IAjaxCallDecorator callDecorator,
                                                                    MetaItem metaItem,
                                                                    T modelObject,
                                                                    ContentFacet facet)

If The Adapter uses a Content Editor which is capable of independent facet update hence it requires a FieldAjaxEventBehavior to define how that editor will behave on actions like onClick

identifyEntity

protected String identifyEntity(T entity)

Identify an entity; for log purposes etc

getItemRefId

public String getItemRefId(MetaItem metaItem)

A way to identify the panels/components for feedback on submit etc.

Specified by:

getItemRefId in interface CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>

Parameters:

metaItem - as MetaItem

Returns:

String

reset

public void reset()

Description copied from interface: CustomTemplateRenderAdapter

During Ajax calls a Render Adapter maybe called multiple times.
Some states may need to be reset.

Specified by:

reset in interface CustomTemplateRenderAdapter<T,org.apache.wicket.model.IModel,org.apache.wicket.Component,org.apache.wicket.MarkupContainer>