com.neurosys.template.wicket.components

Class DynamicInputContainer

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.neurosys.template.wicket.components.DynamicInputContainer

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

public abstract class DynamicInputContainer
extends org.apache.wicket.markup.html.WebMarkupContainer

Define a common WebMarkupContainer to allow configurable generic Search / Input parameters

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
protected List<FacetMeta>	facetMetas
protected List<org.apache.wicket.Component>	rawAddedComponents

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
DynamicInputContainer(String formComponentId, List<FacetMeta> facetMetas, org.apache.wicket.markup.html.WebMarkupContainer container) Create a Form with dynamic search params

Method Summary

Modifier and Type	Method and Description
protected Object	defineParams() Define what Data-Structure will be used to maintain the Form values; so they can be returned as an Event to the listeners
protected abstract EntityDetailsTemplatePanel	getInputTemplatePanel(String id, org.apache.wicket.model.IModel model, EntityTemplate template, CustomTemplateRenderAdapter defaultRenderAdapter) Define the Template panel responsible for rendering the Input params
Object	onSubmit() helper implementation that will process the fields in this Container during Submit
protected Object	transformValue(FacetMeta facetMeta, Object value) An opportunity to modify or transform the raw input value before its passed as a result in the params/event
protected void	updateParamsWithValue(Object params, int index, FacetMeta facetMeta, Object value)

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

rawAddedComponents

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

facetMetas

protected List<FacetMeta> facetMetas

Constructor Detail

DynamicInputContainer

public DynamicInputContainer(String formComponentId,
                             List<FacetMeta> facetMetas,
                             org.apache.wicket.markup.html.WebMarkupContainer container)

Create a Form with dynamic search params

Parameters:

facetMetas - as List of configurable FacetMeta that define the custom Input fields

inputParamsTemplatePanel - as EntityDetailsTemplatePanel type panel, that will be responsible to render the input elements

Method Detail

onSubmit

public Object onSubmit()

helper implementation that will process the fields in this Container during Submit

Parameters:

facetMetas -

rawAddedComponents -

Returns:

the Input as an Object defined by defineParams()

transformValue

protected Object transformValue(FacetMeta facetMeta,
                                Object value)

An opportunity to modify or transform the raw input value before its passed as a result in the params/event

Parameters:

fm - as FacetMeta

value -

Returns:

getInputTemplatePanel

protected abstract EntityDetailsTemplatePanel getInputTemplatePanel(String id,
                                                                    org.apache.wicket.model.IModel model,
                                                                    EntityTemplate template,
                                                                    CustomTemplateRenderAdapter defaultRenderAdapter)

Define the Template panel responsible for rendering the Input params

Parameters:

id - as Component Id

model - as IModel

template - as EntityTemplate

defaultRenderAdapter - as CustomTemplateRenderAdapter

Returns:

inputParamsTemplatePanel as EntityDetailsTemplatePanel type panel, that will be responsible to render the input elements

defineParams

protected Object defineParams()

Define what Data-Structure will be used to maintain the Form values; so they can be returned as an Event to the listeners

Returns:

updateParamsWithValue

protected void updateParamsWithValue(Object params,
                                     int index,
                                     FacetMeta facetMeta,
                                     Object value)

Parameters:

params - as the Datastructure defined by #defineParams(List)

index - as int ; index of the Component in the list (same sequence as input FacetMeta)

facetMeta - as FacetMeta for this item.

value - as the Value input