From 836ae86f93864a78da87a5173ae852b60fa9fab7 Mon Sep 17 00:00:00 2001
From: GPC Deployer
Date: Mon, 1 Jan 2024 12:23:59 +0000
Subject: [PATCH] Deploying to gh-pages - 12:23:58
---
snapshot/api/deprecated-list.html | 10 +-
.../grails/plugin/formfields/Application.html | 48 +-
.../formfields/BeanPropertyAccessor.html | 30 +-
.../BeanPropertyAccessorFactory.html | 33 +-
.../formfields/BeanPropertyAccessorImpl.html | 38 +-
.../DelegatingBeanPropertyAccessorImpl.html | 39 +-
.../plugin/formfields/FieldsGrailsPlugin.html | 48 +-
.../FormFieldsTagLib.BeanAndPrefix.html | 10 +-
.../FormFieldsTagLib.BeanAndPrefixStack.html | 16 +-
.../plugin/formfields/FormFieldsTagLib.html | 53 +-
.../formfields/FormFieldsTemplateService.html | 48 +-
.../formfields/PropertyPathAccessor.html | 31 +-
.../plugin/formfields/package-summary.html | 6 +-
snapshot/api/groovy.ico | Bin 9662 -> 0 bytes
snapshot/api/help-doc.html | 10 +-
snapshot/api/index-all.html | 16 +-
snapshot/api/index.html | 2 +-
snapshot/api/overview-frame.html | 2 +-
snapshot/api/overview-summary.html | 8 +-
snapshot/index.html | 2918 ++++++++++++++++-
20 files changed, 3191 insertions(+), 175 deletions(-)
diff --git a/snapshot/api/deprecated-list.html b/snapshot/api/deprecated-list.html
index 179ca5c7..62f64c3a 100644
--- a/snapshot/api/deprecated-list.html
+++ b/snapshot/api/deprecated-list.html
@@ -23,9 +23,9 @@
-
- Deprecated API
-
+
+ Deprecated API (fields "${RELEASE_VERSION}" API)
+
@@ -34,7 +34,7 @@
@@ -96,7 +96,7 @@ Contents
Frames
No Frames
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/Application.html b/snapshot/api/grails/plugin/formfields/Application.html
index ce212cf6..854adc50 100644
--- a/snapshot/api/grails/plugin/formfields/Application.html
+++ b/snapshot/api/grails/plugin/formfields/Application.html
@@ -26,9 +26,9 @@
-
- Application (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ Application (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -113,6 +113,26 @@ [Groovy] Class Application<
+
+
+
+
+ Inherited fields
+
+ Fields inherited from class
+ Fields
+
+
+ class grails.boot.config.GrailsAutoConfiguration
+ __$stMC
+
+
+
+
+
+
+
+
@@ -147,6 +167,24 @@ Methods Summary
+
+ Inherited Methods Summary
+
+
+ Inherited Methods
+
+ Methods inherited from class
+ Name
+
+
+
+ class grails.boot.config.GrailsAutoConfiguration
+ grails.boot.config.GrailsAutoConfiguration#getApplicationContext(), grails.boot.config.GrailsAutoConfiguration#getGrailsApplication(), grails.boot.config.GrailsAutoConfiguration#doWithSpring(), grails.boot.config.GrailsAutoConfiguration#doWithDynamicMethods(), grails.boot.config.GrailsAutoConfiguration#doWithApplicationContext(), grails.boot.config.GrailsAutoConfiguration#onConfigChange(java.util.Map), grails.boot.config.GrailsAutoConfiguration#onStartup(java.util.Map), grails.boot.config.GrailsAutoConfiguration#setApplicationContext(org.springframework.context.ApplicationContext), grails.boot.config.GrailsAutoConfiguration#grailsApplicationPostProcessor(), grails.boot.config.GrailsAutoConfiguration#getConfig(), grails.boot.config.GrailsAutoConfiguration#onShutdown(java.util.Map), grails.boot.config.GrailsAutoConfiguration#packageNames(), grails.boot.config.GrailsAutoConfiguration#invokeMethod(java.lang.String, java.lang.Object), grails.boot.config.GrailsAutoConfiguration#getMetaClass(), grails.boot.config.GrailsAutoConfiguration#setMetaClass(groovy.lang.MetaClass), grails.boot.config.GrailsAutoConfiguration#setProperty(java.lang.String, java.lang.Object), grails.boot.config.GrailsAutoConfiguration#getProperty(java.lang.String), grails.boot.config.GrailsAutoConfiguration#classes(), grails.boot.config.GrailsAutoConfiguration#packages(), grails.boot.config.GrailsAutoConfiguration#wait(long, int), grails.boot.config.GrailsAutoConfiguration#wait(long), grails.boot.config.GrailsAutoConfiguration#wait(), grails.boot.config.GrailsAutoConfiguration#equals(java.lang.Object), grails.boot.config.GrailsAutoConfiguration#toString(), grails.boot.config.GrailsAutoConfiguration#hashCode(), grails.boot.config.GrailsAutoConfiguration#getClass(), grails.boot.config.GrailsAutoConfiguration#notify(), grails.boot.config.GrailsAutoConfiguration#notifyAll()
+
+
+
+
+
@@ -224,7 +262,7 @@ static void main (java.lang.String[] args)
Field Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/BeanPropertyAccessor.html b/snapshot/api/grails/plugin/formfields/BeanPropertyAccessor.html
index 59a9d6b6..88f27546 100644
--- a/snapshot/api/grails/plugin/formfields/BeanPropertyAccessor.html
+++ b/snapshot/api/grails/plugin/formfields/BeanPropertyAccessor.html
@@ -26,9 +26,9 @@
-
- BeanPropertyAccessor (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ BeanPropertyAccessor (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -138,7 +138,7 @@ Methods Summary
- GrailsDomainClass
+ grails.core.GrailsDomainClass
getBeanClass ()
Returns: the GORM domain type of `beanType`.
@@ -156,7 +156,7 @@ Methods Summary
- Constrained
+ org.grails.scaffolding.model.property.Constrained
getConstraints ()
Returns: the constraints of the property at the end of the path, e.g. for `address.home.street` then the constraints of `street` are returned.
@@ -168,19 +168,19 @@ Methods Summary
- PersistentProperty
+ org.grails.datastore.mapping.model.PersistentProperty
getDomainProperty ()
Returns: the GORM persistent property descriptor for the property at the end of the path, e.g. for `address.home.street` then the descriptor of `street` is returned.
- PersistentEntity
+ org.grails.datastore.mapping.model.PersistentEntity
getEntity ()
Returns: the GORM domain type of `beanType`.
- java.util.List<FieldError>
+ java.util.List<org.springframework.validation.FieldError>
getErrors ()
Returns: the resolved messages for any validation errors present on the property at the end of the path.
@@ -280,7 +280,7 @@ Method Detail
@java.lang.Deprecated
-GrailsDomainClass getBeanClass ()
+grails.core.GrailsDomainClass getBeanClass ()
deprecated: use getEntity
Returns: the GORM domain type of `beanType`. This will be null if `beanType` is not a domain class.
@@ -307,7 +307,7 @@ java.lang.Class getBeanType ()
@@ -439,7 +440,7 @@ @java.lang.Override
@java.lang.Override
-Constrained getConstraints ()
+org.grails.scaffolding.model.property.Constrained getConstraints ()
@@ -457,7 +458,7 @@ @java.lang.Override
@java.lang.Override
-PersistentProperty getDomainProperty ()
+org.grails.datastore.mapping.model.PersistentProperty getDomainProperty ()
@@ -466,7 +467,7 @@ @java.lang.Override
@java.lang.Override
-PersistentEntity getEntity ()
+org.grails.datastore.mapping.model.PersistentEntity getEntity ()
@@ -475,7 +476,7 @@ @java.lang.Override
@java.lang.Override
-java.util.List<FieldError> getErrors ()
+java.util.List<org.springframework.validation.FieldError> getErrors ()
@@ -602,7 +603,7 @@ @java.lang.Override
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/FieldsGrailsPlugin.html b/snapshot/api/grails/plugin/formfields/FieldsGrailsPlugin.html
index fb04f19f..a12a462e 100644
--- a/snapshot/api/grails/plugin/formfields/FieldsGrailsPlugin.html
+++ b/snapshot/api/grails/plugin/formfields/FieldsGrailsPlugin.html
@@ -26,9 +26,9 @@
-
- FieldsGrailsPlugin (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ FieldsGrailsPlugin (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -113,6 +113,26 @@ [Groovy] Class Field
+
+
+
+
+ Inherited fields
+
+ Fields inherited from class
+ Fields
+
+
+ class grails.plugins.Plugin
+ __$stMC
+
+
+
+
+
+
+
+
@@ -178,6 +198,24 @@ Methods Summary
+
+ Inherited Methods Summary
+
+
+ Inherited Methods
+
+ Methods inherited from class
+ Name
+
+
+
+ class grails.plugins.Plugin
+ grails.plugins.Plugin#getApplicationContext(), grails.plugins.Plugin#getGrailsApplication(), grails.plugins.Plugin#getArtefacts(), grails.plugins.Plugin#setGrailsApplication(grails.core.GrailsApplication), grails.plugins.Plugin#doWithSpring(), grails.plugins.Plugin#doWithDynamicMethods(), grails.plugins.Plugin#doWithApplicationContext(), grails.plugins.Plugin#onChange(java.util.Map), grails.plugins.Plugin#onConfigChange(java.util.Map), grails.plugins.Plugin#onStartup(java.util.Map), grails.plugins.Plugin#beans(groovy.lang.Closure), grails.plugins.Plugin#setApplicationContext(org.springframework.context.ApplicationContext), grails.plugins.Plugin#setPlugin(grails.plugins.GrailsPlugin), grails.plugins.Plugin#setPluginManager(grails.plugins.GrailsPluginManager), grails.plugins.Plugin#getPluginManager(), grails.plugins.Plugin#getEnabled(), grails.plugins.Plugin#getPlugin(), grails.plugins.Plugin#getConfig(), grails.plugins.Plugin#getEnvironment(), grails.plugins.Plugin#setEnvironment(grails.util.Environment), grails.plugins.Plugin#onShutdown(java.util.Map), grails.plugins.Plugin#isEnabled(), grails.plugins.Plugin#invokeMethod(java.lang.String, java.lang.Object), grails.plugins.Plugin#setEnabled(boolean), grails.plugins.Plugin#getMetaClass(), grails.plugins.Plugin#setMetaClass(groovy.lang.MetaClass), grails.plugins.Plugin#getManager(), grails.plugins.Plugin#setProperty(java.lang.String, java.lang.Object), grails.plugins.Plugin#getProperty(java.lang.String), grails.plugins.Plugin#wait(long, int), grails.plugins.Plugin#wait(long), grails.plugins.Plugin#wait(), grails.plugins.Plugin#equals(java.lang.Object), grails.plugins.Plugin#toString(), grails.plugins.Plugin#hashCode(), grails.plugins.Plugin#getClass(), grails.plugins.Plugin#notify(), grails.plugins.Plugin#notifyAll()
+
+
+
+
+
@@ -290,7 +328,7 @@ @java.lang.Override
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefix.html b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefix.html
index 6ee69457..f27c730a 100644
--- a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefix.html
+++ b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefix.html
@@ -26,9 +26,9 @@
-
- FormFieldsTagLib.BeanAndPrefix (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ FormFieldsTagLib.BeanAndPrefix (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -268,7 +268,7 @@ java.lang.String prefix
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefixStack.html b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefixStack.html
index ef694f37..d5bcc3bd 100644
--- a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefixStack.html
+++ b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.BeanAndPrefixStack.html
@@ -26,9 +26,9 @@
-
- FormFieldsTagLib.BeanAndPrefixStack (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ FormFieldsTagLib.BeanAndPrefixStack (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -177,11 +177,7 @@ Inherited Methods Summary
class java.util.Stack
- java.util.Stack#push(java.lang.Object), java.util.Stack#pop(), java.util.Stack#peek(), java.util.Stack#empty(), java.util.Stack#search(java.lang.Object), java.util.Stack#add(java.lang.Object), java.util.Stack#add(int, java.lang.Object), java.util.Stack#remove(int), java.util.Stack#remove(java.lang.Object), java.util.Stack#get(int), java.util.Stack#equals(java.lang.Object), java.util.Stack#toString(), java.util.Stack#hashCode(), java.util.Stack#clone(), java.util.Stack#indexOf(java.lang.Object, int), java.util.Stack#indexOf(java.lang.Object), java.util.Stack#clear(), java.util.Stack#isEmpty(), java.util.Stack#lastIndexOf(java.lang.Object, int), java.util.Stack#lastIndexOf(java.lang.Object), java.util.Stack#contains(java.lang.Object), java.util.Stack#replaceAll(java.util.function.UnaryOperator), java.util.Stack#size(), java.util.Stack#subList(int, int), java.util.Stack#toArray([Ljava.lang.Object;), java.util.Stack#toArray(), java.util.Stack#iterator(), java.util.Stack#spliterator(), java.util.Stack#addAll(java.util.Collection), java.util.Stack#addAll(int, java.util.Collection), java.util.Stack#addElement(java.lang.Object), java.util.Stack#elementAt(int), java.util.Stack#elements(), java.util.Stack#forEach(java.util.function.Consumer), java.util.Stack#set(int, java.lang.Object), java.util.Stack#capacity(), java.util.Stack#ensureCapacity(int), java.util.Stack#trimToSize(), java.util.Stack#copyInto([Ljava.lang.Object;), java.util.Stack#setSize(int), java.util.Stack#firstElement(), java.util.Stack#lastElement(), java.util.Stack#setElementAt(java.lang.Object, int), java.util.Stack#removeElementAt(int), java.util.Stack#insertElementAt(java.lang.Object, int), java.util.Stack#removeElement(java.lang.Object), java.util.Stack#removeAllElements(), java.util.Stack#containsAll(java.util.Collection), java.util.Stack#removeAll(java.util.Collection), java.util.Stack#retainAll(java.util.Collection), java.util.Stack#listIterator(), java.util.Stack#listIterator(int), java.util.Stack#removeIf(java.util.function.Predicate), java.util.Stack#sort(java.util.Comparator), java.util.Stack#wait(long, int), java.util.Stack#wait(long), java.util.Stack#wait(), java.util.Stack#getClass(), java.util.Stack#notify(), java.util.Stack#notifyAll(), java.util.Stack#stream(), java.util.Stack#parallelStream()
-
-
- class java.util.Vector
- java.util.Vector#add(java.lang.Object), java.util.Vector#add(int, java.lang.Object), java.util.Vector#remove(int), java.util.Vector#remove(java.lang.Object), java.util.Vector#get(int), java.util.Vector#equals(java.lang.Object), java.util.Vector#toString(), java.util.Vector#hashCode(), java.util.Vector#clone(), java.util.Vector#indexOf(java.lang.Object, int), java.util.Vector#indexOf(java.lang.Object), java.util.Vector#clear(), java.util.Vector#isEmpty(), java.util.Vector#lastIndexOf(java.lang.Object, int), java.util.Vector#lastIndexOf(java.lang.Object), java.util.Vector#contains(java.lang.Object), java.util.Vector#replaceAll(java.util.function.UnaryOperator), java.util.Vector#size(), java.util.Vector#subList(int, int), java.util.Vector#toArray([Ljava.lang.Object;), java.util.Vector#toArray(), java.util.Vector#iterator(), java.util.Vector#spliterator(), java.util.Vector#addAll(java.util.Collection), java.util.Vector#addAll(int, java.util.Collection), java.util.Vector#addElement(java.lang.Object), java.util.Vector#elementAt(int), java.util.Vector#elements(), java.util.Vector#forEach(java.util.function.Consumer), java.util.Vector#set(int, java.lang.Object), java.util.Vector#capacity(), java.util.Vector#ensureCapacity(int), java.util.Vector#trimToSize(), java.util.Vector#copyInto([Ljava.lang.Object;), java.util.Vector#setSize(int), java.util.Vector#firstElement(), java.util.Vector#lastElement(), java.util.Vector#setElementAt(java.lang.Object, int), java.util.Vector#removeElementAt(int), java.util.Vector#insertElementAt(java.lang.Object, int), java.util.Vector#removeElement(java.lang.Object), java.util.Vector#removeAllElements(), java.util.Vector#containsAll(java.util.Collection), java.util.Vector#removeAll(java.util.Collection), java.util.Vector#retainAll(java.util.Collection), java.util.Vector#listIterator(), java.util.Vector#listIterator(int), java.util.Vector#removeIf(java.util.function.Predicate), java.util.Vector#sort(java.util.Comparator), java.util.Vector#wait(long, int), java.util.Vector#wait(long), java.util.Vector#wait(), java.util.Vector#getClass(), java.util.Vector#notify(), java.util.Vector#notifyAll(), java.util.Vector#stream(), java.util.Vector#parallelStream()
+ java.util.Stack#push(java.lang.Object), java.util.Stack#pop(), java.util.Stack#peek(), java.util.Stack#empty(), java.util.Stack#search(java.lang.Object), java.util.Stack#add(java.lang.Object), java.util.Stack#add(int, java.lang.Object), java.util.Stack#remove(java.lang.Object), java.util.Stack#remove(int), java.util.Stack#get(int), java.util.Stack#equals(java.lang.Object), java.util.Stack#toString(), java.util.Stack#hashCode(), java.util.Stack#clone(), java.util.Stack#indexOf(java.lang.Object, int), java.util.Stack#indexOf(java.lang.Object), java.util.Stack#clear(), java.util.Stack#isEmpty(), java.util.Stack#lastIndexOf(java.lang.Object, int), java.util.Stack#lastIndexOf(java.lang.Object), java.util.Stack#contains(java.lang.Object), java.util.Stack#replaceAll(java.util.function.UnaryOperator), java.util.Stack#size(), java.util.Stack#subList(int, int), java.util.Stack#toArray(), java.util.Stack#toArray([Ljava.lang.Object;), java.util.Stack#iterator(), java.util.Stack#spliterator(), java.util.Stack#addAll(java.util.Collection), java.util.Stack#addAll(int, java.util.Collection), java.util.Stack#addElement(java.lang.Object), java.util.Stack#elementAt(int), java.util.Stack#elements(), java.util.Stack#forEach(java.util.function.Consumer), java.util.Stack#set(int, java.lang.Object), java.util.Stack#capacity(), java.util.Stack#ensureCapacity(int), java.util.Stack#trimToSize(), java.util.Stack#copyInto([Ljava.lang.Object;), java.util.Stack#setSize(int), java.util.Stack#firstElement(), java.util.Stack#lastElement(), java.util.Stack#setElementAt(java.lang.Object, int), java.util.Stack#removeElementAt(int), java.util.Stack#insertElementAt(java.lang.Object, int), java.util.Stack#removeElement(java.lang.Object), java.util.Stack#removeAllElements(), java.util.Stack#containsAll(java.util.Collection), java.util.Stack#removeAll(java.util.Collection), java.util.Stack#retainAll(java.util.Collection), java.util.Stack#listIterator(), java.util.Stack#listIterator(int), java.util.Stack#removeIf(java.util.function.Predicate), java.util.Stack#sort(java.util.Comparator), java.util.Stack#wait(long, int), java.util.Stack#wait(long), java.util.Stack#wait(), java.util.Stack#getClass(), java.util.Stack#notify(), java.util.Stack#notifyAll(), java.util.Stack#stream(), java.util.Stack#parallelStream()
@@ -288,7 +284,7 @@ java.lang.String toString ()
Field Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.html b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.html
index 4efac009..2e464668 100644
--- a/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.html
+++ b/snapshot/api/grails/plugin/formfields/FormFieldsTagLib.html
@@ -26,9 +26,9 @@
-
- FormFieldsTagLib (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ FormFieldsTagLib (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -197,7 +197,7 @@ Properties Summary
- CodecLookup
+ org.grails.encoder.CodecLookup
codecLookup
@@ -219,7 +219,7 @@ Properties Summary
- DomainModelService
+ org.grails.scaffolding.model.DomainModelService
domainModelService
@@ -230,7 +230,7 @@ Properties Summary
- DomainPropertyFactory
+ org.grails.scaffolding.model.property.DomainPropertyFactory
fieldsDomainPropertyFactory
@@ -246,7 +246,7 @@ Properties Summary
- LocaleResolver
+ org.springframework.web.servlet.LocaleResolver
localeResolver
@@ -256,27 +256,32 @@ Properties Summary
- java.util.Collection<MappingContext>
+ java.util.Collection<org.grails.datastore.mapping.model.MappingContext>
mappingContexts
+ org.springframework.context.MessageSource
+ messageSource
+
+
+
static java.lang.Object
namespace
-
+
java.lang.Object
table
Renders a collection of beans in a table
-
+
java.lang.Object
widget
attr: bean Name of the source bean in the GSP model.
-
+
java.lang.Object
with
attr: bean REQUIRED Name of the source bean in the GSP model.
@@ -451,7 +456,7 @@
- CodecLookup codecLookup
+ org.grails.encoder.CodecLookup codecLookup
@@ -486,7 +491,7 @@ java.lang.Object displayWidget
- DomainModelService domainModelService
+ org.grails.scaffolding.model.DomainModelService domainModelService
@@ -508,7 +513,7 @@ java.lang.Object field
- DomainPropertyFactory fieldsDomainPropertyFactory
+ org.grails.scaffolding.model.property.DomainPropertyFactory fieldsDomainPropertyFactory
@@ -534,7 +539,7 @@ java.lang.Object input
- LocaleResolver localeResolver
+ org.springframework.web.servlet.LocaleResolver localeResolver
@@ -542,7 +547,7 @@ LocaleResolver localeReso
- @Value('${grails.plugin.fields.localizeNumbers:true}')
+ @org.springframework.beans.factory.annotation.Value('${grails.plugin.fields.localizeNumbers:true}')
java.lang.Boolean localizeNumbers
@@ -551,8 +556,16 @@ @Value('${grails.plugin.fields.localizeNumbers:true}')
- @Autowired(required = false)
-java.util.Collection<MappingContext> mappingContexts
+ @org.springframework.beans.factory.annotation.Autowired(required = false)
+java.util.Collection<org.grails.datastore.mapping.model.MappingContext> mappingContexts
+
+
+
+
+
+
+
+ org.springframework.context.MessageSource messageSource
@@ -728,7 +741,7 @@ java.lang.CharSequence renderStringInput (java.util.Map mode
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/FormFieldsTemplateService.html b/snapshot/api/grails/plugin/formfields/FormFieldsTemplateService.html
index 9efd2825..d038a235 100644
--- a/snapshot/api/grails/plugin/formfields/FormFieldsTemplateService.html
+++ b/snapshot/api/grails/plugin/formfields/FormFieldsTemplateService.html
@@ -26,9 +26,9 @@
-
- FormFieldsTemplateService (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ FormFieldsTemplateService (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -126,6 +126,12 @@ Field Summary
+ static java.lang.String
+ DISABLE_LOOKUP_CACHE
+
+
+
+
static java.lang.String
SETTING_WIDGET_PREFIX
@@ -152,17 +158,17 @@ Properties Summary
- GrailsApplication
+ grails.core.GrailsApplication
grailsApplication
- GrailsConventionGroovyPageLocator
+ org.grails.web.gsp.io.GrailsConventionGroovyPageLocator
groovyPageLocator
- GrailsPluginManager
+ grails.plugins.GrailsPluginManager
pluginManager
@@ -207,7 +213,7 @@ Methods Summary
protected java.lang.String
- getWidget (Constrained cp, java.lang.Class propertyType)
+ getWidget (org.grails.scaffolding.model.property.Constrained cp, java.lang.Class propertyType)
@@ -263,6 +269,14 @@ Inherited Methods Summary
Field Detail
+
+
+
+ public static final java.lang.String DISABLE_LOOKUP_CACHE
+
+
+
+
@@ -286,8 +300,8 @@ Property Detail
- @Autowired
-GrailsApplication grailsApplication
+ @org.springframework.beans.factory.annotation.Autowired
+grails.core.GrailsApplication grailsApplication
@@ -295,8 +309,8 @@ @Autowired
- @Autowired
-GrailsConventionGroovyPageLocator groovyPageLocator
+ @org.springframework.beans.factory.annotation.Autowired
+org.grails.web.gsp.io.GrailsConventionGroovyPageLocator groovyPageLocator
@@ -304,8 +318,8 @@ @Autowired
- @Autowired
-GrailsPluginManager pluginManager
+ @org.springframework.beans.factory.annotation.Autowired
+grails.plugins.GrailsPluginManager pluginManager
@@ -343,10 +357,10 @@ java.lang.String getTemplateFor (java.lang.String property)<
-
+
- protected java.lang.String getWidget (Constrained cp, java.lang.Class propertyType)
+ protected java.lang.String getWidget (org.grails.scaffolding.model.property.Constrained cp, java.lang.Class propertyType)
@@ -408,7 +422,7 @@ static java.lang.String toPropertyNameFormat (java.lang
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/PropertyPathAccessor.html b/snapshot/api/grails/plugin/formfields/PropertyPathAccessor.html
index 545c0ef5..46053ff6 100644
--- a/snapshot/api/grails/plugin/formfields/PropertyPathAccessor.html
+++ b/snapshot/api/grails/plugin/formfields/PropertyPathAccessor.html
@@ -26,9 +26,9 @@
-
- PropertyPathAccessor (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
-
+
+ PropertyPathAccessor (fields "${RELEASE_VERSION}" API)
+
@@ -37,7 +37,7 @@
@@ -107,6 +107,7 @@ [Groovy] Class Pro
@groovy.transform.CompileStatic
@groovy.transform.Canonical(includes = ['beanType', 'propertyName', 'propertyType'])
class PropertyPathAccessor
+extends java.lang.Object
@@ -210,7 +211,7 @@ Methods Summary
- GrailsDomainClass
+ grails.core.GrailsDomainClass
getBeanClass ()
@@ -222,7 +223,7 @@ Methods Summary
- Constrained
+ org.grails.scaffolding.model.property.Constrained
getConstraints ()
@@ -234,19 +235,19 @@ Methods Summary
- PersistentProperty
+ org.grails.datastore.mapping.model.PersistentProperty
getDomainProperty ()
- PersistentEntity
+ org.grails.datastore.mapping.model.PersistentEntity
getEntity ()
- java.util.List<FieldError>
+ java.util.List<org.springframework.validation.FieldError>
getErrors ()
@@ -405,7 +406,7 @@ Method Detail
@@ -421,7 +422,7 @@ java.util.List<java.lang.Class> getBeanSuperclasses ()
- Constrained getConstraints ()
+ org.grails.scaffolding.model.property.Constrained getConstraints ()
@@ -437,7 +438,7 @@ java.lang.String getDefaultLabel ()
- PersistentProperty getDomainProperty ()
+ org.grails.datastore.mapping.model.PersistentProperty getDomainProperty ()
@@ -445,7 +446,7 @@ PersistentProperty ge
- PersistentEntity getEntity ()
+ org.grails.datastore.mapping.model.PersistentEntity getEntity ()
@@ -453,7 +454,7 @@ PersistentEntity getEnt
- java.util.List<FieldError> getErrors ()
+ java.util.List<org.springframework.validation.FieldError> getErrors ()
@@ -555,7 +556,7 @@ boolean isRequired ()
Field Property Constructor Method
-
+ Groovy Documentation
diff --git a/snapshot/api/grails/plugin/formfields/package-summary.html b/snapshot/api/grails/plugin/formfields/package-summary.html
index e8fabfa8..9c90f7bb 100644
--- a/snapshot/api/grails/plugin/formfields/package-summary.html
+++ b/snapshot/api/grails/plugin/formfields/package-summary.html
@@ -22,7 +22,7 @@
-grails.plugin.formfields
+grails.plugin.formfields (fields "${RELEASE_VERSION}" API)
@@ -31,7 +31,7 @@
@@ -232,7 +232,7 @@ Package grails.plugin.formfields
-
+ Groovy Documentation
diff --git a/snapshot/api/groovy.ico b/snapshot/api/groovy.ico
index 9e9b8d81a21db6c99daf3cd76320407a45a1b0d5..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 100644
GIT binary patch
literal 0
HcmV?d00001
literal 9662
zcmeHMd0fuv7JqxQju}i0qd^U!MD}4y`@Ygb`=*7`UX+R!T9s1LN(PmZrHyQnjA76e
zm5NdsJC$|ZJI1-^{HC}2zOUEFa_`(f?$77z`Tc(H^PJ~<&U4Or&hv}K62gBoXR`2r
zan_zmEY>I%izSJ`S1daOz5oC9UKS9--fV<0ALt$Z_P=%!r~Zhc2vGzr|91!lgklfq
zp5D=K)Q9@gn7>mWvM2GFh)_l74;t9t@T)IBcM=^n-20nRUj~0OYIw-kBZv8q9RB(8
zA%h243keA=!G6v?pfNO-WRR@?)a+>X(z7LNr_P>IJw-;ML1Ln4hq&m-m)N&^>}ZjrUymFbjJlek3>SnQ$wH9K|D+zY
z)`JmJLk17jm6iqVB(1(T$40k$!W6Okv7^8Ihv-+sONW2)nKjDf=pofJ$EWryvWrOne!{Y|B*%v@
zkeS%|z3j9GGpCGOuJWB!mJL8s*fWSGq-sVEp3_Fu%O_
zPtM5KrnMAoZj}8su#a^M>W2D|E~GcDi9vY^C`7uoj~z4OHpY7)o824d<3B{$o$C5ngliRr;}riv|Iq&(}X`WpK-m2Dx6uXA&M8>bI>
zPkN9~nO`Xc<1^Wyl^^p@@k!$vF(!5+Z;A(sY074oUElr
zijDFKey_C(Vi}uQH0)=5=50L4mnk19rmTUv!A>CKVGh$>mx7F&8O#Z=2e~*OAXyZ%
zZ&qW~IB}g~|rkE{a$3d6Gx`
zNIw7E6vLEDrI(w)WOJ=|!%_$4t#by0qp1Sr(HxYADM#oQCxYaHX|>}{unEbSp$u)xfhSr*F+b7-vbej|Cz~ml&o6uae-bPj1
zK_xY?TU>O+3*4s-khdLz>Lo!JTX~-30!JhHmr7CY&s4XEGX6k&sUX{v{287WZ*oWb
z&P84nH55EKXf?H9?#
zEwk6DlTTa)nt9Po9KFr&7i?Jh26ys%T6cbX(lc=~tlS3QN4djf)R9{kL1Q>;Ky`^i
zw8!lUW50TW^@|>IS49j!@LU7?_Z#MFs@!CVbr{)B=U@UX!J379k>BqrCMH{G^Kh6S
z?!xS6g1Ga)o9Sc4GnRamzYh}!xGxX~&HNacgf%SIuFH@#?P>fzB&4%&`YbO?^?xYF
zc>a^}J=Kns?YsmMhCMLfloAT!!%JJO3OZST_G6eFc
zxThRQd6?Fe18FBC9vOoChxDd(r#g$`MmfpM`UN}bAGZv1Zc<40XZA^|rKmRKw?E}WZVr;R`fv2%aFLDm;_1shj&na1*Mee<
zGlsk6@TVG^e0sX%_KE#=sLCwN`Rcp)E2ReUaFVn$cq6_!9H^$0
zi}zvb3CgY9n77uMsVT^|oc{bRKmQrh;_Z0uv_aBJ2yXtu8{CX4tk*AZqBW;{MgAkm
z{^ZLX+fhrg{5JdX^LgKA4u3i;sqF}dS<>RSkw4Yb{Qkp^@-*JRV*T<4&fY~aBPf1#
z4r~HR3muTcJxJP052UU2!Qx^bIJTAd84lQ&u&nJc13QdW0>6I5pW>J5QI)I^m@`%U
z8GgHNZe@--(OFHYjGx+1bgzp^Y|_ZyZz%|BBZ?%
zEH|y=8Mm@H3qo;R(5)(F{b()h(XYsND6Z(-q+PfXl&rLCzMnC14|1nEl)rvpEs&Wo
zC}W-NEsGfU4%!1a=N5`#`_?jMo&At|^xbn1-SHzhC5D52WMD6r#RNm}+5HfE_h*5K
zx%Crx=B4!Z=Zp2*EciA^YJK*!idqc0H=^
zMb>rnr~Nx2JbP=O5w$lPvRcmd%HYV`@vsh(?_C1d)^f0@!MH`+W8Qg*-=Df?ONr6G
z`>yjND>KASw;;~7TP4EnCGEv}`xC(CLLLO(sDPY@^^o6r6$&~Vd656;D(q-H3n>*v
zu&Hn-#N};&6ZzSYTwVyl*Z;
zvl$BS)Iok*HSB4*2>Gp-VDHUZIPkFX-+iz@zl{ATw*c+1vEwY*p3ei_{qdl_(d&_c
z(##jLCCBR`ufBdiVQmStk|^5j-szIy-Ab{ny*mnQt9C(B`%iH2Q4^GOU5C={7AX4!
zAUUPo*P#gYF1S|@-nGSGT$TbVX~D0IbQZMeDa?pR?zGJFI
zPWgCWFeumvuICFN@6Kf?>%0c#-K}us@r{oL$vM>30!0rRA-bso%#Ngk`nFIovDUh5
zqCWTRXM+YTK+^B~{gCuzA53%$Ka}coS0~#2xxywtFx(pt-WT@4-n(^h1m`@C{Et6w
zgA-5Mq2fJo0>{ue8h@m-1rFVBg3V2pU{Rh9npht$aa&Svu08(-o)_hj2ko^2^Cgjd
z$Hgv5@<=F8_q}Jb(X&&2qYo^~i2;|YT-ecm5su;972R!c@^L$ydeYI0O1x+Aw5R3z
z?G)-s{VTfK;Mk)UD8ADG;WdZBv?K*IvO-^5x){~k=*xECUPau;BR-TnqZ)pX6D~>i
z3_hCf`@}cd_nKU!2WVx6fn`}5tg9)5J-2G1qO%oFb+^Om#~pAQxpGkT_
z^dx;Bq0iiHWb(iB$(^t`KMr(K);x8z(Q0rol)r+1<5`H4e~jH3?p*(|46`MbESk;V6ZC+EDxoF_xXL0*nArDeyxSW51OH}vkgvnp*{@o9-mJmU>Je&{b{u(p;^}$w)C5zjsoO|CE0};;12%8e}!LEX6Cg
zJk95M(pJA3y*TgZ3JHFowJnT^4fC>8u&c-hr>Y$AIJXzPf8GaPsGG}=d0>C?2e2&9
z028dW^>U&?Gkx7_ix`jVK90IA`0b$GMo*T`RbmLrGu+=sIP-t1mc1*&QLZ@2qoj0;
z=gVDNyy|_Dd>VB(`8`v_HBrWIDH^zEXzo}KT0d++tOw2P^`Mp!0_v$juT2wuZ+ZmV
zRR^swxVOeZr^C%mWsTUF5fVs_>Vl8*_4ibey*0>667y_mVZ7_5y>YI;=f>tN*Dltf6ZcrQ2P=S1hw5*2vXaI
z2B!8D8kX8n)Pq`VSRpJH4rAI^)GD%AOe@A>p%^C9FfCS;D2}NtdD?+J@3C#8-#?&b
z}m;ecO8UN5KQ>Jqlv%!?72H3NiMBSBihO
MWNGZjTrAeV03kgoZ~y=R
diff --git a/snapshot/api/help-doc.html b/snapshot/api/help-doc.html
index b94be23c..5855fbed 100644
--- a/snapshot/api/help-doc.html
+++ b/snapshot/api/help-doc.html
@@ -24,17 +24,17 @@
-
- API Help
+
+ API Help (fields "${RELEASE_VERSION}" API)
-
+
@@ -187,7 +187,7 @@ Constant Field Values
Frames
No Frames
-
+ Groovy Documentation
diff --git a/snapshot/api/index-all.html b/snapshot/api/index-all.html
index a0b06c0f..29aea015 100644
--- a/snapshot/api/index-all.html
+++ b/snapshot/api/index-all.html
@@ -23,15 +23,15 @@
-
- Index
-
+
+ Index (fields "${RELEASE_VERSION}" API)
+
@@ -158,7 +158,9 @@ D
DelegatingBeanPropertyAccessorImpl - Class in grails.plugin.formfields
-DelegatingBeanPropertyAccessorImpl(Object, Object, Class, String, DomainProperty) - Constructor in DelegatingBeanPropertyAccessorImpl
+DelegatingBeanPropertyAccessorImpl(Object, Object, Class, String, DomainProperty) - Constructor in DelegatingBeanPropertyAccessorImpl
+
+DISABLE_LOOKUP_CACHE - Field in FormFieldsTemplateService
DISPLAY_STYLE - Field in FormFieldsTagLib
@@ -307,7 +309,7 @@ G
getValue() - Method in PropertyPathAccessor
-getWidget(Constrained, Class) - Method in FormFieldsTemplateService
+getWidget(Constrained, Class) - Method in FormFieldsTemplateService
getWidgetPrefix() - Method in FormFieldsTemplateService
@@ -570,7 +572,7 @@ _
Frames
No Frames
-
+ Groovy Documentation
diff --git a/snapshot/api/index.html b/snapshot/api/index.html
index ea1515e5..20bd9536 100644
--- a/snapshot/api/index.html
+++ b/snapshot/api/index.html
@@ -21,7 +21,7 @@
-Index
+Index (fields "${RELEASE_VERSION}" API)
diff --git a/snapshot/api/overview-frame.html b/snapshot/api/overview-frame.html
index b793889f..3f0d2750 100644
--- a/snapshot/api/overview-frame.html
+++ b/snapshot/api/overview-frame.html
@@ -21,7 +21,7 @@
-Overview (Grails Fields Plugin - 3.0.0.BUILD-SNAPSHOT)
+Overview (fields "${RELEASE_VERSION}" API)
diff --git a/snapshot/api/overview-summary.html b/snapshot/api/overview-summary.html
index 846fa163..0bef2efe 100644
--- a/snapshot/api/overview-summary.html
+++ b/snapshot/api/overview-summary.html
@@ -22,7 +22,7 @@
-Overview
+Overview (fields "${RELEASE_VERSION}" API)
@@ -32,7 +32,7 @@
@@ -66,7 +66,7 @@
diff --git a/snapshot/index.html b/snapshot/index.html
index b0dd78f5..f9033398 100644
--- a/snapshot/index.html
+++ b/snapshot/index.html
@@ -1,9 +1,2919 @@
-
-
+
-
+
+
+
+
+Fields Plugin
+
+
+
+
+
+
+
+
Introduction
+
+
+
The Fields plugin allows you to customize the rendering of input fields for properties of domain objects, command beans and POGOs based on their type, name, etc. The plugin aims to:
+
+
+
+
+Use good defaults for fields.
+
+
+Make it very easy to override the field rendering for particular properties or property types without having to replace entire form templates.
+
+
+Not require you to copy and paste markup for containers, labels and error messages just because you need a different input type.
+
+
+Support inputs for property paths of arbitrary depth and with indexing.
+
+
+Enable other plugins to provide field rendering for special property types that gets picked up automatically (e.g. the Joda Time plugin can provide templates for the various date/time types).
+
+
+Support embedded properties of GORM domain classes.
+
+
+
+
+
+
+
Changelog
+
+
+
Version 4.0.0-RC1 - Grails 4.1.x
+
+
+
New group
id. In your build.gradle file, use:
+
+
+
+
compile 'io.github.gpc:fields:4.0.0-RC1'
+
+
+
+
+
Thank you for all the contributions!
+
+
+
+
Version 3.0.0.RC1 - Grails 4.0.x
+
+
Last version that is on the "old" group org.grails.plugins
+
+
+
+
+
Version 2.2.9.BUILD-SNAPSHOT
+
+
+
+
Version 2.2.8
+
+
+
+BugFix: Table Tag does not render transient fields correctly (Issue #264 )
+
+
+BugFix: Table Tag does not render references correctly! (Issue #269 )
+
+
+BugFix: Fix XSS vulnerability when rendering beans (Issue #278 )
+GitHub diff
+
+
+
+
+
+
Version 2.2.7
+
+
+
+BugFix: The fix for #257 did not work as described, but now it does.
+
+
+Improvement: Documentation has been improved with more examples for the various tags.
+GitHub diff
+
+
+
+
+
+
Version 2.2.6
+
+
+
+Improvement: Documentation of maxProperties
on <f:table/>
+
+
+Improvement: <f:table\>
can now show id
, lastUpdated
and dateCreated
(see f:table doc). Injecting DomainModelService
instead of instantiating DomainModelServiceImpl
in FormsFieldTagLib
(Issue #257 )
+
+
+
+
+
+
+
Version 2.2.4/2.2.5
+
+
+
+Improvement: Introduced maxProperties
attribute to <f:table/>
+
+
+Improvement: Render value that is an association but not to a grom entity
+
+
+Improvement: Rendering numbers is now Locale-aware (can be configured)
+
+
+
+
+
+
+
+
+
Version 2.2.1
+
+
+
+Bug-fix: Autowire beans
+
+
+
+
+
+
+
Version 2.2.0
+
+
+
+Conversion to the Mapping Context API. Usages of the GrailsDomainClass and GrailsDomainClassProperty classes have been removed. If you extend a template that relies on those classes, they have been replaced with PersistentEntity and DomainProperty respectively.
+
+
+Conversion of constraints to a common implementation between grails.validation and grails.gorm.validation. See Constrained .
+
+
+
+
+
+
+
+
Version 2.0
+
+
+
+Redesign for Grails 3.0
+
+
+
+
+
+
+
Version 1.4
+
+
+
+Upgraded plugin to work with Grails 2.3.x (Issue #122)
+
+
+Fixed missing property exception (Issue #134)
+
+
+Fixed encoding in tag libraries (Issue #137)
+
+
+Configuring caching in dev mode (Issue #139)
+
+
+byte[] and Byte[] arrays types now look for files in byteArray folders (general for all array types) (Issue #144)
+
+
+
+
+
+
+
+
+
+
Version 1.0.4
+
+
2012-02-13 : Bugfix release.
+
+
+
+
+
Version 1.0.3
+
+
2012-02-09 : Bugfix release.
+
+
+
+
+
Version 1.0.2
+
+
2012-02-07 : Bugfix release.
+
+
+
+
+
Version 1.0.1
+
+
2012-02-03 : Bugfix release.
+
+
+
+
+
Version 1
+
+
2012-02-01 : Initial release.
+
+
+
+
+
+
+
Usage
+
+
+
The plugin provides a set of tags you can use to render the fields in a form.
+
+
+
In the simplest case you can use f:all
to render a field for every property of a bean (the domain object or command the form will bind to):
+
+
+
+
<g :form… >
+ <f :all bean=" person " />
+</ g:form>
+
+
+
+
To render individual fields you use the f:field
tag:
+
+
+
+
<g :form… >
+ <f :field bean=" person " property=" name " />
+ <f :field bean=" person " property=" address " />
+ <f :field bean=" person " property=" dateOfBirth " />
+</ g:form>
+
+
+
+
The f:field
tag will automatically handle embedded domain properties recursively:
+
+
+
+
<f :field bean=" person " property=" address " />
+
+
+
+
If there is no bean object backing a form but you still want to render the surrounding field markup you can give f:field
a body:
+
+
+
+
<f :field property=" password " >
+ <g :password name=" password " />
+</ f:field>
+
+
+
+
It should be an unusual case but to render just the widget without its surrounding container you can use the f:widget
tag:
+
+
+
+
<f :widget bean=" person " property=" name " />
+
+
+
+
To make it more convenient when rendering lots of properties of the same bean
you can use the f:with
tag to avoid having to specify bean
on any tags nested inside:
+
+
+
+
<g :form… >
+ <f :with bean=" person " >
+ <f :field property=" name " />
+ <f :field property=" address " />
+ <f :field property=" dateOfBirth " />
+ </ f:with>
+ </ g:form>
+
+
+
+
If you need to render a property for display purposes you can use f:display
. It will internally use g:fieldValue
, g:formatBoolean
or g:formatDate
to format the value.
+
+
+
+
<f :display bean=" person " property=" name " />
+
+
+
+
If you need to render the value in a different way you can give f:display
a body instead.
+
+
+
+
<f :display bean=" person " property=" dateOfBirth " >
+ <g :formatDate format=" dd MMM yyyy " date=" ${ value} " />
+</ f:display>
+
+
+
+
By default f:display
simply renders the property value but if you supply a \_display.gsp
template you can render the value in some structured markup, e.g. a table cell or list item. See the Customizing Field Rendering section for how to override templates. For example to render values in a definition list you could use a template like this:
+
+
+
+
<dt>$ {label}</ dt>
+ <dd>$ {value}</ dd>
+
+
+
+
+
+
You can pass any number of extra attributes to the f:with
and f:all
tags that will be propagated to the inner fields and displays.
+See their individual tags sections for more information.
+
+
+
+
Breaking changes
+
+
+
+
Templates
+
+
The names of the templates were changed for more adequate ones:
+
+
+
+
To use the old names (for backwards compatibility), configure the following in Config.groovy
+
+
+
+
grails.plugin.fields.wrapper = " field "
+grails.plugin.fields.displayWrapper = " display "
+grails.plugin.fields.widget = " input "
+
+
+
+
+
Widget attributes
+
+
To pass additional attributes to widgets, prefix them with widget- .
+
+
+
+
+
<f :field property=" birthDate " widget-format=" dd/MM/yyyy " />
+
+
+
+
To use the old prefix (for backwards compatibility), configure the following in Config.groovy
:
+
+
+
+
grails.plugin.fields.widgetPrefix = " input- "
+
+
+
+
+
Changes in tags
+
+
+
+The f:input
tag was deprecated because the name was confusing. Use the new f:widget
tag instead.
+
+
+The f:displayWidget
tag was added. It outputs the widget for display purposes, without the wrapper (similar to the widget
tag).
+
+
+
+
+
+
Localized numbers
+
+
All numbers are now rendered localized. This means that when using Locale.ENGLISH
the number 1000.50 is represented
+as 1,000.50
but with Locale.GERMAN
is represented as 1.000,50
. To use the old behavior (for backwards compatibility)
+without localizing the numbers, configure the following in Config.groovy
:
+
+
+
+
grails.plugin.fields.localizeNumbers = false
+
+
+
+
+
+
+
Customizing Field Rendering
+
+
+
The plugin resolves the GSP template used for each property according to conventions. You can override the rendering based
+on the class and property name or the property type. The f:field
tag looks for a template called _wrapper.gsp
, the f:widget
+tag looks for a template called _widget.gsp
, the f:display
tag looks for a template called _displayWrapper.gsp
.
+
+
+
+
+
+
+
+
+Breaking changes in version 1.5
+
+
+
+
+
+
In version 1.5 a new template was introduced _displayWidget.gsp
. This is the corollary of _widget.gsp
for fields that
+are read-only, i.e. it is responsible for rendering just the markup for the field itself. Furthermore, the default names
+of all the templates were changed in this version, in the interest of clarity and consistency. The changes to the template
+names are summarized below:
+
+
+Table 1. Template Name Changes
+
+
+
+
+
+
+Old Template Name (before v.1.5)
+New Template Name (v.1.5 onwards)
+
+
+
+
+_field.gsp
+_wrapper.gsp
+
+
+_display.gsp
+_displayWrapper.gsp
+
+
+N/A
+_displayWidget.gsp
+
+
+
+
+
Users upgrading to 1.5 from a previous version should either rename their templates (recommended) or add the following
+to grails-app/conf/application.yml
to change the default templates names to the old names
+
+
+
+
grails :
+ plugin :
+ fields :
+ wrapper : field
+ displayWrapper : display
+ widget : input
+ displayWidget : displayWidget
+
+
+
+
Locating Field Templates by Convention
+
+
The template for a field is chosen by a convention using the names of the controller, action, bean class, bean property, theme, etc. All the tags will look for templates in the following directories in decreasing order of preference:
+
+
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/*propertyName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/_themes/*themeName*/*propertyType*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*propertyName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/_themes/*themeName*/*propertyType*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerName*/*actionName*/*propertyName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerName*/*actionName*/_themes/*themeName*/*propertyType*/
+
+
+grails-app/views/*controllerName*/*actionName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerName*/*propertyName*/_themes/*themeName*/
+
+
+grails-app/views/*controllerName*/_themes/*themeName*/*propertyType*/
+
+
+grails-app/views/*controllerName*/_themes/*themeName*/
+
+
+grails-app/views/_fields/_themes/*themeName*/*class*/*propertyName*/
+
+
+grails-app/views/_fields/_themes/*themeName*/*superclass*/*propertyName*/
+
+
+grails-app/views/_fields/_themes/*themeName*/*associationType*/
+
+
+grails-app/views/_fields/_themes/*themeName*/*propertyType*/
+
+
+grails-app/views/_fields/_themes/*themeName*/*propertySuperclass*/
+
+
+grails-app/views/_fields/_themes/*themeName*/default/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/*propertyName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/*propertyType*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*actionName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*propertyName*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/*propertyType*/
+
+
+grails-app/views/*controllerNamespace*/*controllerName*/
+
+
+grails-app/views/*controllerName*/*actionName*/*propertyName*/
+
+
+grails-app/views/*controllerName*/*actionName*/*propertyType*/
+
+
+grails-app/views/*controllerName*/*actionName*/
+
+
+grails-app/views/*controllerName*/*propertyName*/
+
+
+grails-app/views/*controllerName*/*propertyType*/
+
+
+grails-app/views/*controllerName*/
+
+
+grails-app/views/_fields/*class*/*propertyName*/
+
+
+grails-app/views/_fields/*superclass*/*propertyName*/
+
+
+grails-app/views/_fields/*associationType*/
+
+
+grails-app/views/_fields/*propertyType*/
+
+
+grails-app/views/_fields/*propertySuperclass*/
+
+
+grails-app/views/_fields/default/
+
+
+
+
+
The variables referenced in these paths are:
+
+
+Table 2. Referenced Variables
+
+
+
+
+
+
+Name
+Description
+
+
+
+
+controllerName
+The name of the current controller (if any).
+
+
+actionName
+The name of the current action (if any).
+
+
+themeName
+Theme name specified as value of theme attribute (Optional).
+
+
+class
+The bean class. For simple properties this is the class of the object passed to the bean
attribute of the f:field
or f:widget
tag but when the property
attribute was nested this is the class at the end of the chain. For example, if the property path was employees[0].address.street
this will be the class of address
.
+
+
+superclass
+Any superclass or interface of class
excluding Object
, GroovyObject
, Serializable
, Comparable
and Cloneable
and those from GORM.
+
+
+propertyName
+The property name at the end of the chain passed to the property
attribute of the f:field
or f:widget
tag. For example, if the property path was employees[0].address.street
then this will be street
.
+
+
+propertyType
+The type of the property at the end of the chain passed to the property
attribute of the f:field
or f:widget
tag. For example, for a java.lang.String
property this would be string
.
+
+
+propertySuperclass
+Any superclass or interface of propertyType
excluding Object
, GroovyObject
, Serializable
, Comparable
and Cloneable
.
+
+
+associationType
+One of 'oneToOne'
, 'oneToMany'
, 'manyToMany'
or 'manyToOne'
. Only relevant if the property is a domain class association.
+
+
+
+
+
All class names are camel-cased simple forms. For example java.lang.String
becomes string
, and com.project.HomeAddress
becomes homeAddress
.
+
+
+
Templates are resolved in this order so that you can override in the more specific circumstance and fall back to successively more general defaults. For example, you can define a field template for all java.lang.String
properties but override a specific property of a particular class to use more specialized rendering.
+
+
+
Templates in plugins are resolved as well. This means plugins such as Joda Time
can provide default rendering for special property types. A template in your application will take precedence over a template in a plugin at the same level . For example if a plugin provides a grails-app/views/_fields/string/_widget.gsp
the same template in your application will override it but if the plugin provides grails-app/views/_fields/person/name/_widget.gsp
it would be used in preference to the more general template in your application.
+
+
+
For most properties the out-of-the-box defaults should provide a good starting point.
+
+
+
+
Locating Templates Conventionally Example
+
+
Imagine an object of class Employee
that extends the class Person
and has a String name
property.
+
+
+
You can override the template f:field
uses with any of these:
+
+
+
+
+grails-app/views/*controllerName*/*actionName*/name/_themes/*themeName*/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/name/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/string/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/name/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/string/_wrapper.gsp
+
+
+grails-app/views/*controllerName*/_wrapper.gsp
+
+
+grails-app/views/_fields/employee/name/_wrapper.gsp
+
+
+grails-app/views/_fields/person/name/_wrapper.gsp
+
+
+grails-app/views/_fields/string/_wrapper.gsp
+
+
+grails-app/views/_fields/default/_wrapper.gsp
+
+
+
+
+
override the template f:widget
uses with any of these:
+
+
+
+
+grails-app/views/*controllerName*/*actionName*/name/_themes/*themeName*/_widget.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/name/_widget.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/string/_widget.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/_widget.gsp
+
+
+grails-app/views/*controllerName*/name/_widget.gsp
+
+
+grails-app/views/*controllerName*/string/_widget.gsp
+
+
+grails-app/views/*controllerName*/_widget.gsp
+
+
+grails-app/views/_fields/employee/name/_widget.gsp
+
+
+grails-app/views/_fields/person/name/_widget.gsp
+
+
+grails-app/views/_fields/string/_widget.gsp
+
+
+grails-app/views/_fields/default/_widget.gsp
+
+
+
+
+
And override the template f:display uses with any of these:
+
+
+
+
+grails-app/views/*controllerName*/*actionName*/name/_themes/*themeName*/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/name/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/string/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/*actionName*/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/name/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/string/_displayWrapper.gsp
+
+
+grails-app/views/*controllerName*/_displayWrapper.gsp
+
+
+grails-app/views/_fields/employee/name/_displayWrapper.gsp
+
+
+grails-app/views/_fields/person/name/_displayWrapper.gsp
+
+
+grails-app/views/_fields/string/_displayWrapper.gsp
+
+
+grails-app/views/_fields/default/_displayWrapper.gsp
+
+
+
+
+
During template development it is usually recommended to disable template caching in order to allow the plugin to recognize new/renamed/moved templates without restarting the application. See the "Performance" section of the guide for the exact settings.
+
+
+
+
See Template Seach Path
+
+
The plugin logs which locations it is checking for templates as debug log. You can enable this by defining a logger in logback.groovy
+
+
+
+
logger('grails.plugin.formfields.FormFieldsTemplateService', DEBUG,['STDOUT'])
+
+
+
+
The can disable the caching in application.yml using:
+
+
+
+
grails:
+ plugin:
+ fields:
+ disableLookupCache: true
+
+
+
+
+
Default Behaviour - Using Grails Widget Tags
+
+
If no template override is found the plugin will use the standard grails input tags (e.g. g:select
, g:checkbox
, g:field
) for rendering input controls.
+Using f:field
you can pass extra arguments (e.g. optionKey
, optionValue
) through to these tags by prefixing them with widget-
, e.g.
+
+
+
+
<f :field bean=" person " property=" gender " widget-optionValue=" name " />
+
+
+
+
+
Template parameters
+
+
The f:field
and f:widget
tags will pass the following parameters to your templates or to the body of f:field
if you use one:
+
+
+Table 3. Template Parameters
+
+
+
+
+
+
+
+Name
+Type
+Description
+
+
+
+
+bean
+Object
+The bean
attribute as passed to the f:field
or f:widget
tag.
+
+
+property
+String
+The property
attribute as passed to the f:field
or f:widget
tag. This would generally be useful for the name
attribute of a form input.
+
+
+type
+Class
+The property type.
+
+
+label
+String
+The field label text. This is based on the label
attribute passed to the f:field
or f:widget
tag. If no label
attribute was used the label is resolved by convention - see below.
+
+
+value
+Object
+the property value. This can also be overridden or defaulted if the value
or default
attribute was passed to f:field
or f:widget
.
+
+
+constraints
+ConstrainedProperty
+The constraints for the property if the bean is a domain or command object.
+
+
+persistentProperty
+DomainProperty
+The persistent property object if the bean is a domain object.
+
+
+errors
+List<String>
+The error messages for any field errors present on the property. If there are no errors this will be an empty List .
+
+
+required
+boolean
+true
if the field is required, i.e. has a nullable: false
or blank: false
constraint.
+
+
+invalid
+boolean
+true
if the property has any field errors.
+
+
+prefix
+String
+A string (including the trailing period) that should be appended before the input name such as name="${prefix}propertyName"
. The label is also modified.
+
+
+
+
+
In addition f:field
passes the following parameters:
+
+
+Table 4. Parameter Names from f:field
+
+
+
+
+
+
+
+Name
+Type
+Description
+
+
+widget
+String
+The output of f:widget
for the current bean and property if f:field
was used without a tag body, otherwise the output of the tag body.
+
+
+
+
+
+
+
+
+
+
+If the bean
attribute was not supplied to f:field
then bean
, type
, value
and persistentProperty
will all be null
.
+
+
+
+
+
+
+
Field labels
+
+
If the label
attribute is not supplied to the f:field
tag then the label string passed to the field template is resolved by convention. The plugin uses the following order of preference for the label:
+
+
+
+
+An i18n message using the key beanClass .path `.label` . For example when using <f:field bean="personInstance" property="address.city"/>
the plugin will try the i18n key person.address.city.label
. If the property path contains any index it is removed so <f:field bean="authorInstance" property="books<<0>>.title"/>
would use the key author.books.title.label
.
+
+
+An i18n message using the key objectType .propertyName `.label` . For example when using <f:field bean="personInstance" property="address.city"/>
the plugin will try the i18n key address.city.label
.
+
+
+The natural property name. For example when using <f:field bean="personInstance" property="dateOfBirth"/>
the plugin will use the label "Date Of Birth"
.
+
+
+
+
+
+
Locating Field Templates Directly
+
+
Rather than relying on the convention described previously to locate the template(s) to be used for a particular field, it is
+instead possible to directly specify the directory containing the templates. This feature was introduced in version 1.5.
+
+
+
+
+The wrapper
attribute can be used with the f:field or f:display tags to specify the directory containing the _wrapper.gsp
or _displayWrapper.gsp
template to be used
+
+
+The widget
attribute can be used with the f:field or f:display tags to specify the directory containing the _widget.gsp
or _displayWidget.gsp
template to be used
+
+
+If the wrapper and widget templates both have the same value, the templates
attribute can be used instead as a shorthand. For example:
+
+
+
+
+
+
<f :field property=" startDate " templates=" bootstrap3 " />
+
+
+
+
+
+
<f :field property=" startDate " wrapper=" bootstrap3 " widget=" bootstrap3 " />
+
+
+
+
if theme is specified, theme will be searched first to find the templates
+For example
+
+
+
+
<f :field property=" startDate " templates=" custom " theme=" bs-horizontal " />
+
+
+
+
Will search the templates first in \_fields/_themes/bs-horizontal/custom and then \_fields/custom
+
+
+
If a direct location is specified, and the templates cannot be found therein, the plugin will fall back to locating templates
+by convention.
+
+
+
+
Locating Templates Directly Example
+
+
+
+<f :field property=" startDate " wrapper=" custom " theme=" bs-horizontal " />
+
+
+<f :field property=" startDate " wrapper=" bootstrap3 " />
+
+
+<f :field property=" startDate " widget=" time " />
+
+
+<f :field property=" startDate " templates=" time " />
+
+
+<f :display property=" startDate " wrapper=" custom " theme=" bs-horizontal " />
+
+
+
+<f :display property=" startDate " wrapper=" bootstrap3 " />
+
+
+<f :display property=" startDate " widget=" time " />
+
+
+<f :display property=" startDate " templates=" time " />
+
+
+
+
+
+
+
Embedded Properties
+
+
+
Embedded properties are handled in a special way by the f:field
and f:all
tags. If the property
attribute you pass to f:field
is an embedded property then the tag recursively renders each individual property of the embedded class with a surrounding fieldset
. For example if you have a Person
class with a name
property and an Address
embedded class with street
, city
and country
properties <f:field bean="person" property="address">
will effectively do this:
+
+
+
+
<fieldset class =" embedded address " >
+ <legend >Address</ legend>
+ <f :field bean=" person " property=" address.street " />
+ <f :field bean=" person " property=" address.city " />
+ <f :field bean=" person " property=" address.country " />
+</ fieldset>
+
+
+
+
You can customize how embedded properties are surrounded by providing a layout at grails-app/views/layouts/_fields/embedded.gsp
which will override the default layout provided by the plugin.
+
+
+
When you use the f:all
tag it will automatically handle embedded properties in this way.
+
+
+
+
+
Themes
+
+
+
Since version 2.1.4 It is possible to create themes to provide set of templates for different css frameworks or form layouts.
+For example, a bootstrap-fields plugin can provide different themes (eg bs-horizontal, bs-vertical) to support horizontal and vertical form layouts. And another plugin can provide theme for purecss framework.
+
+
+
Themes are put under directory _fields/themes/*themeName*/
.
+
+
+
All of the field tags supports theme attribute which accepts the name of the theme. When a theme name is specified, widget, wrapper, and display templates will be searched in theme directory first as described in Customizing Field Rendering .
+
+
+
+
+
Including Templates in Plugins
+
+
+
Plugins can include field and/or input level templates to support special UI rendering or non-standard property types. Just include the templates in the plugin’s grails-app/views
directory as described in the Customizing Field Rendering section.
+
+
+
+
+
+
+
+
+If you supply templates in a plugin you should consider declaring a <%@page defaultCodec="html" %>
directive so that any HTML unsafe property values are escaped properly regardless of the default codec used by client apps.
+
+
+
+
+
+
+
When template caching is active, only the first page renderings are slow, subsequent ones are fast.
+
+
+
Due to the flexibility needed during template development, this feature can be disabled so it would be possible to recognize newly added field templates without restarting the application. As a result, with bigger webpages, containing a lot of fields, rendering may be fairly slow in development (depending on the number of fields on the page).
+
+
+
+
+
Performance
+
+
+
For template development, the following configuration attribute should be placed in the development environment section of your application’s Config.groovy:
+
+
+
application.groovy
+
+
grails.plugin.fields.disableLookupCache = true
+
+
+
+
+
application.yml
+
+
environments :
+ development :
+ grails :
+ plugin :
+ fields :
+ disableLookupCache : true
+
+
+
+
After the template development has finished, it is recommended to re-enable the template lookup cache in order to have a performant page rendering even during development.
+
+
+
+
+
Reference
+
+
+
Tags
+
+
all
+
+
+
+
f:all
+
+
Purpose
+
+
Renders fields for all properties of an object by using f:field
for each property.
+
+
+
The id
, version
, dateCreated
and lastUpdated
properties are skipped on domain classes. Additionally any property with a display: false
constraint set will be skipped.
+
+
+
+
Attributes
+
+Table 5. Attributes for f:all
+
+
+
+
+
+
+
+Name
+Required
+Description
+
+
+
+
+bean
+if not inside f:with
+The bean whose property is being rendered. This can be the object itself or the name of a page-scope variable.
+
+
+except
+N/A
+A comma-separated list of properties that should be skipped (in addition to the defaults).
+
+
+order
+N/A
+A comma-separated list of properties which represents the order in which the tag should generate fields.
+
+
+prefix
+String
+A string (including the trailing period) that should be appended before the input name such as name="${prefix}propertyName"
. The label is also modified.
+
+
+theme
+String
+Theme to use if available.
+
+
+
+
+
+
+
+
You can pass extra attributes to the all tag that will be propagated to the inner fields.
+
+
+
+
Example
+
+
+
<f :all bean=" person " wrapper=" someWrapper " />
+
+
+
+
In that way all the fields are going to be executed as if they were executed with the extra attribute on them.
+
+
+
+
+
+
+
+
+Remember that if you want to use some of those attributes in the widget templates you need to prefix them with the widget- word (unless you have configured another prefix)
+
+
+
+
+
+
+
+
display
+
+
+
+
f:display
+
+
Purpose
+
+
f:display
renders a property for display. If there is no _displayWrapper
template in scope the tag will simply render the property value.
+
+
+
f:display
template will look for a _displayWrapper
for the wrapper itself and a _displayWidget
for the widget used inside the wrapper template.
+
+
+
If the f:display
tag has a body its output is used as the value passed as the value
model to the _display
template. If there is no body then the raw property value is passed to g:fieldValue
, g:formatDate
or g:formatBoolean
depending on its type and the result is passed as the value
model to the _display
template.
+
+
+
+
+
+
+
+
+In version 1.5 new attributes were added:
+Since then you can specify the folders where the templates are located. You can do this for the wrapper folder, the widget folder ot both (if they are located on the same folder).
+
+
+
+
+
+
+
Examples
+
+
+
<f :display bean=" person " />
+
+<f :display bean=" person " displayStyle=" table " />
+
+<f :display bean=" person " property=" name " />
+
+
+<f :display bean=" person " property=" name " theme=" purecss " />
+
+
+<f :display bean=" person " property=" name " wrapper=" bootstrap3 " />
+
+
+<f :display bean=" person " property=" name " widget=" maskedInput " />
+
+
+<f :display bean=" person " property=" name " templates=" maskedInput " />
+
+<f :display bean=" person " property=" dateOfBirth " >
+ <g :formatDate format=" dd MMM yyyy " date=" ${ value} " />
+</ f:display>
+
+
+
+
+
Attributes
+
+Table 6. Attributes for f:display
+
+
+
+
+
+
+
+Name
+Required
+Description
+
+
+
+
+bean
+if not inside f:with
+The bean whose property is being rendered. This can be the object itself or the name of a page-scope variable.
+
+
+property
+No
+The path to the property. This can include any level of nesting and numeric or string indexes. For example employees[0].address[home].street
is a valid path. If absent, all properties will be displayed via the grails-app/views/templates/_fields/_list.gsp
(see the template code below).
+
+
+value
+No
+Overrides the actual value of the property.
+
+
+default
+No
+A default value for the property that will be used if the actual property value is false
.
+
+
+label
+No
+Overrides the field label passed to the template. This value may either be an i18n key or a literal string.
+
+
+displayStyle
+No
+When specified and different from the string default
, this tag will try to use a _display-${displayStyle}
template with a _display template as fallback. `displayStyle="table"
will render embedded components by default with toString()
instead of rendering all nested properties.
+
+
+except
+No
+A comma-separated list of properties that should be skipped.
+
+
+order
+No
+A comma-separated list of properties which represents the order in which the tag should display them.
+
+
+theme
+No
+Theme to use if available. The theme can define a new directory structure in /_fields/_themes/<themename> which will take priority over templates, wrapper and widget if they are specified, as it is injecting the search path first in the list.
+
+
+templates
+No
+Specify the folder inside _fields where to look up for the wrapper and widget template.
+
+
+widget
+No
+Specify the folder inside _fields where to look up for the widget template.
+
+
+wrapper
+No
+Specify the folder inside _fields where to look up for the wrapper template.
+
+
+
+
+
Any additional attributes are passed to the rendered template.
+
+
+
+
+
Special case for rendering all properties of a bean
+
+
When f:display
is used without a property
then all bean properties are rendered. This is done with the grails-app/views/templates/_fields/_list.gsp
template. The default template can be found on GitHub
+
+
+
+
displayWidget
+
+
+
+
f:displayWidget
+
+
Purpose
+
+
f:displayWidget
renders an appropriate widget for a display property, for example an <span>${value}</span>
element for a String
property.
+
+
+
+
+
+
+
+
+Using f:displayWidget
directly will only be necessary for very specialized cases, usually it will be invoked via f:display
.
+
+
+
+
+
+
+
Attributes
+
+
f:displayWidget
accepts exactly the same attributes as the f:display tag (except for wrapper
and templates
attributes).
+
+
+
+
Example of a _displayWidget.gsp
+
+
If you have a domain class with a java.time.LocalDate
you might want to format it specially:
+
+
+
grails-app/views/_fields/localDate/_displayWidget.gsp
+
+
<%@ page import="java.time.format.DateTimeFormatter" %>
+<g:set var="localDatePattern" value="${message(code: 'default.localDate.format',default: 'yyyy-MM-dd')}"/>
+${value?.format(DateTimeFormatter.ofPattern(localDatePattern, request.getLocale()))}
+
+
+
+
+
+
field
+
+
+
+
f:field
+
+
Description
+
+
f:field
renders the widget using either f:widget
or the tag body accompanied by any surrounding markup, typically a container, a label
tag and any validation messages.
+
+
+
By default the f:field
tag will output:
+
+
+
+
<div class =" fieldcontain " >
+ <label for =" foo " >Foo</ label>
+ <!-- the widget as generated by f :widget or the tag body -->
+</ div>
+
+
+
+
The intention is that f:field
should typically be used without
a tag body. For example:
+
+
+
+
<f :field bean=" person " property=" name " />
+
+
+
+
In which case the tag will use f:widget
to generate an appropriate input. Alternatively in more specialized cases you can give f:field
a tag body. For example:
+
+
+
+
<f :field bean=" person " property=" name " >
+ <g :textField name=" ${ property} " value=" ${ value} " />
+</ f:field>
+
+
+
+
Since version 1.5 you can specify which specific templates are going to be used on the view.
+You can accomplish this using new attributes: wrapper , widget and templates . (See attributes section)
+
+
+
Since version 2.1.4 you can specify the theme to be used.
+
+
+
+
<f:field bean="person" property="name" theme="bs-horizontal"/>
+
+
+
+
+
+<f :field bean=" person " property=" name " wrapper=" bootstrap3 " />
+
+
+<f :field bean=" person " property=" name " widget=" maskedInput " />
+
+
+<f :field bean=" person " property=" name " templates=" maskedInput " />
+
+
+
+
+
The f:field
tag handles embedded domain properties in a special way. See Embedded Properties for details.
+
+
+
+
Attributes
+
+Table 7. Attributes for f:field
+
+
+
+
+
+
+
+Name
+Required
+Description
+
+
+
+
+bean
+yes for f:widget
if not inside f:with
, optional for f:field
+The bean whose property is being rendered. This can be the object itself or the name of a page-scope variable.
+
+
+property
+yes
+The path to the property. This can include any level of nesting and numeric or string indexes. For example employees[0].address[home].street
is a valid path. If absent, all properties will be displayed.
+
+
+value
+No
+Overrides the actual value of the property.
+
+
+default
+No
+A default value for the property that will be used if the actual property value is false
.
+
+
+required
+No
+Overrides the required status of the property. By default this is worked out based on the property’s constraints.
+
+
+invalid
+No
+Overrides the validity of the property. By default this is worked out using the bean’s errors property for domain and command objects.
+
+
+label
+No
+Overrides the field label passed to the template. This value may either be an i18n key or a literal string.
+
+
+prefix
+No
+A string (including the trailing period) that should be appended before the input name such as name="${prefix}propertyName"
. The label is also modified.
+
+
+wrapper
+No
+Specifies the name of the folder inside _fields
where the _wrapper.gsp
template is located.
+
+
+widget
+No
+Specifies the name of the folder inside \_fields
where the \_widget.gsp
template is located.
+
+
+templates
+No
+Specifies the name of the folder inside _fields
where the _wrapper.gsp
and _widget.gsp
templates are located. It is a shorthand for specifying both (wrapper
and widget
).
+
+
+theme
+String
+Theme to use if available.
+
+
+
+
+
Any additional attributes are passed to the rendered template. Any additional attributes prefixed with widget-
are instead passed to the widget template or rendered on the default input.
+
+
+
+
Example of overriding a _wrapper.gsp
+
+
If you want to override a f:wrapper
to be used for all widgets then create a file with content like this:
+
+
+
grails-app/views/_fields/default/_wrapper.gsp
+
+
<div class="form-group ${invalid ? 'has-error' : ''}">
+ <label for="${property}">${label} ${required ? '*' : ''}</label>
+
+ <div>
+ <f:widget property="${property}"/>
+ <g:if test="${errors}">
+ <g:each in="${errors}" var="error">
+ <span class="help-block"><g:message error="${error}"/></span>
+ </g:each>
+ </g:if>
+ </div>
+</div>
+
+
+
+
+
+
input
+
+
+
+
f:input (DEPRECATED)
+
+
Deprecated since version 1.5
+
+
+
+
+
table
+
+
+
+
f:table
+
+
Purpose
+
+
<f:table/>
renders some or all properties of a collection of beans in a table using the f:display widget for each property type. If there is no \_display template in scope the tag will simply render the property values.
+
+
+
+
Examples
+
+
+
<f :table collection=" personList " />
+
+<f :table collection=" personList " properties=" firstName, lastName " />
+
+<f :table collection=" personList " properties=" ['firstName', 'lastName'] " />
+
+<f :table collection=" catsAndDogsList " domainClass=" org.zoo.Animal " />
+
+<f :table collection=" catsAndDogsList " domainClass=" org.zoo.Animal " theme=" bs-horizontal " />
+
+
+<f :table collection=" personList " maxProperties=" 3 " />
+
+
+<f :table collection=" personList " except=" []] " />
+
+
+
+
The template for <f:table/>
should be in
+
+
+
+
grails-app/views/templates/_fields/_table.gsp
+
+
+
+
but you can have multiple table templated, if you specify the template property.
+All templates should still be located in view/templates/_fields/
, the example below uses 4 different templates for table.
+
+
+
+
<f:table collection="myList" myProperty="Template: view/templates/_fields/_table.gsp" />
+<f:table collection="${demoList}" template="table3" myProperty="Template: view/templates/_fields/_table3.gsp" />
+<f:table collection="${demoList}" template="tables/table2" myProperty="Template: in view/templates/_fields/tables/_table2.gsp" />
+<f:table collection="${demoList}" template="tables/table" myProperty="Template: view/templates/_fields/tables/_table.gsp" />
+
+
+
+
When theme is specified, the \_display template will be searched first in theme , but the theme property does not directly apply to table.
+
+
+
+
Attributes
+
+
+
+
+
+
+
+
+
+Name
+Required?
+Default
+Description
+
+
+
+
+collection
+yes
+
+The collection of beans to be displayed
+
+
+domainClass
+
+Class
of first element in collection
+The FQN of the domain class of the elements in the collection.
+
+
+properties
+
+First 7 (or less)
+Comma-separated String
or List
of properties to be shown (table columns). Defaults to the first 7 (or less) properties of the domain class ordered by the domain class' constraints
, unless maxProperties
is set below
+
+
+displayStyle
+
+
+Determines the display template used for the bean’s properties. Defaults to table meaning that \_display-table templates will be used when available.
+
+
+except
+
+['id', 'lastUpdated', 'dateCreated']
+A comma-separated String
or List
of properties that should be skipped. Use the empty list to include id
, lastUpdated
and dateCreated
+
+
+order
+
+
+Comma-separated String
or List
of properties which represents the order in which the tag should display them.
+
+
+theme
+String
+
+Theme to use if available.
+
+
+maxProperties
+Number
+7
+The maximum number of properties to display when rendering the table. If zero is specified all columns are shown, otherwise properties[0..<maxProperties]
are shown. maxProperties
can be negative.
+
+
+template
+String
+table
+Alternative template for table rendering. Templates should be in the grails-app/views/templates/_fields/ folder.
+
+
+
+
+
+
Any additional attributes are passed to the rendered template.
+
+
+
+
+
Modifying the _table.gsp
template.
+
+
To make you own version of a f:table
template, the file should be located in grails-app/views/templates/_fields/_table.gsp
+unless a different location is specified with the template property.
+You can find a starting point for a new file on GitHub
+
+
+
Model in the template
+
+
The following model is passed to the _table.gsp
template:
+
+
+
+
+
+
+
+
+Name
+Content
+
+
+
+
+domainClass
+The type of the persistent instance. Either type of the first row in the collection or the domainClass
passed as argument to f:table
+
+
+columnProperties
+Contains a list of Map
describing each table column. See table below for the map content
+
+
+domainProperties
+deprecated: see columnProperties
+
+
+collection
+Rows with data
+
+
+displayStyle
+The attribute displayStyle
passed to the model unmodified
+
+
+theme
+The attribute theme
passed to the model unmodified
+
+
+
+
+
+
+
+
+
+
+
+Name
+Content
+
+
+
+
+bean
+Empty instance of a domainClass
bean
+
+
+property
+The property name
+
+
+name
+Deprecated, see property
+
+
+type
+The property type
+
+
+defaultLabel
+Translated label (deprecated)
+
+
+label
+Translated label
+
+
+constraints
+If the property has constraints
+
+
+required
+Is the property required
+
+
+
+
+
(This is a simplified version of a wrapper
model)
+
+
+
+
+
+
widget
+
+
+
+
f:widget
+
+
Purpose
+
+
f:widget
renders an appropriate widget for a property, for example an <input type="text">
element for a String
property or a <select>
for an enum.
+
+
+
+
+
+
+
+
+Using f:widget
directly will only be necessary for very specialized cases, usually it will be invoked via f:field
.
+
+
+
+
+
+
+
Attributes
+
+
f:widget
accepts exactly the same attributes as the f:field tag (except for wrapper
and templates
attributes).
+
+
+
+
Default rendering
+
+
The <f:widget/>
tag will will by default use sensible defaults when rendering String
, Number
, Boolean
, URL
, Enum
, Date
and associations like oneToOne
, oneToMany
, manyToOne
and manyToMany
.
+
+
+
In a few cases it is possible to control which default widget to use, by specifying it in the beans constraints
.
+
+
+
The following happens with these types:
+
+
+
String
+
+
By default, properties instance of String
renders a <g:field type="text">
type field, but the constraints
in the bean will alter this in these cases:
+
+
+
+
+
+
+
+
+constraint
+Rendered Widget type
+
+
+inList
+<g:select/>
. If the field is not required, a noSelection
is added to the select
+
+
+password: true
+<g:field type="password"/>
+
+
+email: true
+<g:field type="email"/>
+
+
+url: true
+<g:field type="url"/>
+
+
+widget: 'textarea'
+<g:textArea/>
+
+
+
+
+
+
Numeric and primitive types
+
+
By default, properties instance of Number
renders a <g:field type="number">
or <:field type="number decimal"/>
type field, but the constraints
in the bean will alter this in these cases:
+
+
+
+
+
+
+
+
+constraint
+Affects the rendered widget
+
+
+scale
+Sets the step
attribute on the input field
+
+
+min
+Set the min
attribute on the input field
+
+
+max
+Set the max
attribute on the input field
+
+
+
+
+
By default, the value is formatted with the default numberFormatter
based on the request locale.
+
+
+
This behavior can be turned off in the configuration by setting:
+
+
+
+
grails:
+ plugin:
+ fields:
+ localizeNumbers: false
+
+
+
+
+
+
Boolean
+
+
Renders a <g:checkBox/>
+
+
+
+
URL
+
+
Renders a <g:field type="url"/>
+
+
+
+
Enum
+
+
enum
types always renders a <g:select/>
with all the values in the type. To render a subset of enum
values, the inList
constraint can be used.
+
+
+
+
Date, Calendar, java.sql.Date and java.sql.Time
+
+
Renders a <g:datePicker/>
. If Date
, Calendar
, or java.sql.Date
then precision
is set to day
, if java.sql.Time
then minute
+
+
+
+
byte[], Byte[], Blob
+
+
Renders a <g:field type="file"/>
+
+
+
+
oneToOne
, manyToOne
or manyToMany
associations
+
+
All these associations renders a <g:select/>
and if association has a nullable: true
constraint, then a noSelection
attribute is added.
+
+
+
For the manyToMany
association, the multiple
attribute is set.
+
+
+
oneToOne and `manyToOne
renders a
+
+
+
+
oneToMany association
+
+
The oneToMany
association does not render an input type field, but does instead render a list of links to the associated objects.
+
+
+
+
Example of overriding a _widget.gsp
+
+
If you want to override a f:widget
for a String
, then create a file with content like this:
+
+
+
grails-app/views/_fields/string/_widget.gsp
+
+
<g:textField name="${property}" value="${value}" required="${required}" class="form-control"/>
+
+
+
+
+
+
with
+
+
+
f:with
+
+
Purpose
+
+
Places a bean in scope so that the bean attribute can be omitted on contained tags.
+
+
+
+
Example
+
+
+
<f :with bean=" person " >
+ <f :field property=" name " />
+ <f :field property=" address.city " />
+</ f:with>
+
+
+
+
+
Attributes
+
+
+
+
+
+
+
+
+Name
+Required?
+Description
+
+
+
+
+bean
+yes
+The bean whose property is being rendered. This can be the object itself or the name of a page-scope variable.
+
+
+prefix
+String
+A string (including the trailing period) that should be appended before the input name such as name="${prefix}propertyName"
. The label is also modified.
+
+
+
+
+
+
+
+
You can pass any number of extra attributes to the with tag that will be propagated to the inner fields and displays.
+
+
+
+
<f :with bean=" person " wrapper=" someWrapper " >
+ <f :field property=" name " />
+ <f :field property=" address.city " />
+</ f:with>
+
+
+
+
That way you don’t need to repeat the same attribute over and over.
+The code above is the same as:
+
+
+
+
<f :with bean=" person " >
+ <f :field property=" name " wrapper=" someWrapper " />
+ <f :field property=" address.city " wrapper=" someWrapper " />
+</ f:with>
+
+
+
+
+
+
+
You can override the extra attributes on any field just changing the attribute value on the popper field or display
+
+
+
+
<f :with bean=" person " wrapper=" someWrapper " >
+ <f :field property=" name " />
+ <f :field property=" address.city " />
+ <f :field property=" address.zip " wrapper=" differentWrapper " />
+</ f:with>
+
+
+
+
+
+
+
+
+
+Remember that if you want to use some of those attributes in the widget or displayWidget templates you need to prefix them with the widget- word (unless you have configured another prefix)
+
+
+
+
+
+
+
+
+
+
+
+
-
+
\ No newline at end of file