org.codehaus.groovy.grails.plugins.web.api

Class TagLibraryApi

java.lang.Object

org.codehaus.groovy.grails.plugins.web.api.CommonWebApi

org.codehaus.groovy.grails.plugins.web.api.TagLibraryApi

All Implemented Interfaces:

java.io.Serializable, org.codehaus.groovy.grails.plugins.support.aware.GrailsApplicationAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

public class TagLibraryApi
extends org.codehaus.groovy.grails.plugins.web.api.CommonWebApi

API for Tag libraries in a Grails application.

Since:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class org.codehaus.groovy.grails.plugins.web.api.CommonWebApi

RAW_CODEC_NAME

Constructor Summary

Constructors

Constructor and Description
TagLibraryApi()
TagLibraryApi(org.codehaus.groovy.grails.plugins.GrailsPluginManager pluginManager)

Method Summary

Modifier and Type	Method and Description
org.codehaus.groovy.grails.web.util.GrailsPrintWriter	getOut(java.lang.Object instance) Obtains the currently output writer
GroovyPageBinding	getPageScope(java.lang.Object instance) Obtains the page scope instance
TagLibraryLookup	getTagLibraryLookup()
java.lang.Object	methodMissing(java.lang.Object instance, java.lang.String methodName, java.lang.Object argsObject) Method missing implementation that handles tag invocation by method name
java.lang.Object	propertyMissing(java.lang.Object instance, java.lang.String name) Prpoerty missing implementation that looks up tag library namespaces or tags in the default namespace
void	setGspTagLibraryLookup(TagLibraryLookup lookup)
void	setOut(java.lang.Object instance, java.io.Writer newOut) Sets the current output writer
void	setTagLibraryLookup(TagLibraryLookup lookup)
void	throwTagError(java.lang.Object instance, java.lang.String message) Throws a GrailsTagException
java.lang.Object	withCodec(java.lang.Object instance, java.lang.Object codecInfo, groovy.lang.Closure<?> body)

Methods inherited from class org.codehaus.groovy.grails.plugins.web.api.CommonWebApi

currentRequestAttributes, getActionName, getApplicationContext, getControllerClass, getControllerName, getControllerNamespace, getFlash, getGrailsApplication, getGrailsAttributes, getParams, getPluginContextPath, getRequest, getResponse, getServletContext, getSession, getWebRequest, raw, setApplicationContext, setGrailsApplication, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TagLibraryApi

public TagLibraryApi()

TagLibraryApi

public TagLibraryApi(org.codehaus.groovy.grails.plugins.GrailsPluginManager pluginManager)

Method Detail

throwTagError

public void throwTagError(java.lang.Object instance,
                          java.lang.String message)

Throws a GrailsTagException

Parameters:

instance - The tag library instance

message - The error message

getPageScope

public GroovyPageBinding getPageScope(java.lang.Object instance)

Obtains the page scope instance

Parameters:

instance - The tag library

Returns:

The page scope instance

getOut

public org.codehaus.groovy.grails.web.util.GrailsPrintWriter getOut(java.lang.Object instance)

Obtains the currently output writer

Parameters:

instance - The tag library instance

Returns:

The writer to use

setOut

public void setOut(java.lang.Object instance,
                   java.io.Writer newOut)

Sets the current output writer

Parameters:

instance - The tag library instance

newOut - The new output writer

methodMissing

public java.lang.Object methodMissing(java.lang.Object instance,
                                      java.lang.String methodName,
                                      java.lang.Object argsObject)

Method missing implementation that handles tag invocation by method name

Parameters:

instance - The instance

methodName - The method name

argsObject - The arguments

Returns:

The result

propertyMissing

public java.lang.Object propertyMissing(java.lang.Object instance,
                                        java.lang.String name)

Prpoerty missing implementation that looks up tag library namespaces or tags in the default namespace

Parameters:

instance - The tag library instance

name - The property name

Returns:

A tag namespace or a tag in the default namespace

Throws:

groovy.lang.MissingPropertyException - When no tag namespace or tag is found

setGspTagLibraryLookup

@Autowired
public void setGspTagLibraryLookup(TagLibraryLookup lookup)

setTagLibraryLookup

public void setTagLibraryLookup(TagLibraryLookup lookup)

getTagLibraryLookup

public TagLibraryLookup getTagLibraryLookup()

withCodec

public java.lang.Object withCodec(java.lang.Object instance,
                                  java.lang.Object codecInfo,
                                  groovy.lang.Closure<?> body)