org.grails.plugin.vaadin
[Groovy] Class VaadinApi

java.lang.Object
  org.grails.plugin.vaadin.VaadinApi

class VaadinApi

Injects the Vaadin API into all Vaadin Classes and Controllers.

A class is considered a Vaadin class if it meets the following requirements:

• Exists under the grails-app directory
• Has a name ending VaadinController or has the word vaadin in its package name, or the package name of any of its superclasses.

Vaadin Controllers

• vaadinApplication: Gets the com.vaadin.Application object for this session.
• message(): Provides same functionality as the Grails 'message' tag
• flash: Gets a Grails-like 'flash' object for the current 'request'
• params: Gets params map for the current 'request'
• redirect: Mimics Grails's redirect function for controllers
• render: Mimics Grails's render function for controllers

All Vaadin Classes

• i18n(): Provides same functionality as the Grails 'message' tag
• getBean(): Specify a Spring bean to retrieve by name

Authors:

Francis McKenzie

log

def log

VaadinApi

VaadinApi()

injectApi

def injectApi(org.codehaus.groovy.grails.commons.GrailsApplication application)

Injects the Vaadin API into the Vaadin classes and controllers in the specified application.

Parameters:

application - The application that contains the Vaadin classes and controllers.

injectApi

def injectApi(org.codehaus.groovy.grails.commons.GrailsClass grailsClass)

Injects the Vaadin API into the specified Vaadin class

Parameters:

vaadinClass - The Vaadin class requiring API injection

injectApi

def injectApi(Class clazz)

Injects the Vaadin API into the specified Vaadin class

Parameters:

vaadinClass - The Vaadin class requiring API injection

injectBaseApi

protected void injectBaseApi(Class clazz)

Injects the Vaadin Base Api into the specified Vaadin class

Parameters:

vaadinClass - The Vaadin class requiring API injection

injectControllersApi

protected void injectControllersApi(Class clazz)

Injects the Vaadin Controllers Api into the specified Vaadin class

Parameters:

vaadinClass - The Vaadin class requiring API injection

isExcludedClass

protected boolean isExcludedClass(Class clazz)

Checks if specified class should be excluded from Api injection

Parameters:

clazz - The class to check

Returns:

True if the class should be excluded form Api injection

Groovy Documentation