Groovy Documentation

org.grails.plugin.vaadin.scaffolding
[Groovy] Class DefaultVaadinTemplateGenerator

java.lang.Object
  org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator
      org.grails.plugin.vaadin.scaffolding.DefaultVaadinTemplateGenerator

class DefaultVaadinTemplateGenerator
extends org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator

Default implementation of the generator that generates Vaadin artifacts (controllers, views etc.) from the domain model.

Authors:
Francis McKenzie


Field Summary
 
Fields inherited from class org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator
__$stMC, __timeStamp, __timeStamp__239_neverHappen1333450860864
 
Property Summary
String pluginDir

def renderEditorWithArgs

Almost identical to renderEditor in superclass, but uses additional 'parentProperty' param to handle embedded domain class properties, and 'readOnly' param to allow rendering of both edit/create fields and show fields

 
Constructor Summary
DefaultVaadinTemplateGenerator(ClassLoader classLoader, String pluginDir)

Used by the scripts so that they can pass in their AntBuilder instance.

DefaultVaadinTemplateGenerator()

Default constructor.

 
Method Summary
def canWrite(java.io.File testFile)

void generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String destdir)

Copied from superclass - target Controller name is hardcoded, so have to copy in the entire method here just so we can change the name...

void generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, java.io.Writer out)

Copied from superclass - calls overridden getTemplateText() and uses name VaadinController.groovy

void generateView(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String viewName, java.io.Writer out)

Copied from superclass - calls overridden getTemplateText() and renderEditorWithArgs (This was private in superclass in grails 2.0.1, therefore invisible to this class)

void generateViews(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String destdir)

Copied from superclass, as we need to prepend '/vaadin/' to the output view directory

String getPropertyName(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass)

def getTemplateNames()

def getTemplateText(String template)

 
Methods inherited from class org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator
org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setProperty(java.lang.String, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getProperty(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getMetaClass(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setMetaClass(groovy.lang.MetaClass), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#invokeMethod(java.lang.String, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#__$swapInit(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$toString(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$notify(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$notifyAll(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$clone(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$wait(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$wait(long, int), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$wait(long), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$getClass(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$finalize(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$equals(java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#super$1$hashCode(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setResourceLoader(org.springframework.core.io.ResourceLoader), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getResourceLoader(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$dist$invoke$1(java.lang.String, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$dist$set$1(java.lang.String, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$dist$get$1(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setBasedir(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getBasedir(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getEngine(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#isOverwrite(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getPluginManager(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setPluginManager(org.codehaus.groovy.grails.plugins.GrailsPluginManager), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getLOG(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getGrailsApplication(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setGrailsApplication(org.codehaus.groovy.grails.commons.GrailsApplication), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setOverwrite(boolean), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#makeRelativeIfPossible(java.lang.String, java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#makeRelativeIfPossible(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateViews(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getTemplateNames(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.io.Writer), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateView(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.lang.String, java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateView(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.lang.String, java.io.Writer), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#generateTest(org.codehaus.groovy.grails.commons.GrailsDomainClass, java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getTemplateText(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getTemplateResource(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getOverwrite(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setEngine(java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getRenderEditorTemplate(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setRenderEditorTemplate(groovy.text.Template), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getDomainSuffix(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setDomainSuffix(java.lang.String), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getRenderEditor(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#setRenderEditor(java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$generateListView(java.lang.Object, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$generateShowView(java.lang.Object, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$generateEditView(java.lang.Object, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$generateCreateView(java.lang.Object, java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$getPropertyName(org.codehaus.groovy.grails.commons.GrailsDomainClass), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#this$2$canWrite(java.io.File), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#wait(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#wait(long), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#wait(long, int), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#equals(java.lang.Object), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#toString(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#hashCode(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#getClass(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#notify(), org.codehaus.groovy.grails.scaffolding.DefaultGrailsTemplateGenerator#notifyAll()
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

pluginDir

String pluginDir


renderEditorWithArgs

def renderEditorWithArgs
Almost identical to renderEditor in superclass, but uses additional 'parentProperty' param to handle embedded domain class properties, and 'readOnly' param to allow rendering of both edit/create fields and show fields
Parameters:
args - The map of args, containing the following listed params.
property - The property to render
readOnly - Whether or not property is read-only
parentProperty - For embedded properties, this is the embedded property's parent property


 
Constructor Detail

DefaultVaadinTemplateGenerator

DefaultVaadinTemplateGenerator(ClassLoader classLoader, String pluginDir)
Used by the scripts so that they can pass in their AntBuilder instance.


DefaultVaadinTemplateGenerator

DefaultVaadinTemplateGenerator()
Default constructor.


 
Method Detail

canWrite

def canWrite(java.io.File testFile)


generateController

@Override
void generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String destdir)
Copied from superclass - target Controller name is hardcoded, so have to copy in the entire method here just so we can change the name...


generateController

@Override
void generateController(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, java.io.Writer out)
Copied from superclass - calls overridden getTemplateText() and uses name VaadinController.groovy


generateView

@Override
void generateView(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String viewName, java.io.Writer out)
Copied from superclass - calls overridden getTemplateText() and renderEditorWithArgs (This was private in superclass in grails 2.0.1, therefore invisible to this class)


generateViews

@Override
void generateViews(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass, String destdir)
Copied from superclass, as we need to prepend '/vaadin/' to the output view directory


getPropertyName

String getPropertyName(org.codehaus.groovy.grails.commons.GrailsDomainClass domainClass)


getTemplateNames

def getTemplateNames()


getTemplateText

def getTemplateText(String template)


 

Groovy Documentation