org.displaytag.localization
Interface I18nResourceProvider

All Known Implementing Classes:

I18nJstlAdapter, I18nSpringAdapter, I18nStrutsAdapter, I18nWebworkAdapter

public interface I18nResourceProvider

Interface for resource providers. Given a resourceKey and a defaultValue, a resource provider returns the String which should be displayed. For column headers resourceKey will be the value of the titleKey attribute, defaultValue will be the value of the property attribute. Different resource providers can be plugged using the displaytag.properties file.

Version:

$Revision: 1.2 $ ($Author: fgiust $)

Author:

Fabrizio Giustina

Method Summary

java.lang.String

getResource(java.lang.String resourceKey, java.lang.String defaultValue, javax.servlet.jsp.tagext.Tag tag, javax.servlet.jsp.PageContext context) Returns a localized String.

Method Detail

getResource

public java.lang.String getResource(java.lang.String resourceKey,
                                    java.lang.String defaultValue,
                                    javax.servlet.jsp.tagext.Tag tag,
                                    javax.servlet.jsp.PageContext context)

Returns a localized String. A resource provider is free to use both resourceKey or defaultValue for the lookup. For example in column titles defaultValue is the value of the property attribute and can be used as a default if titleKey is not specified.

Parameters:

resourceKey - used-specified resource key

defaultValue - default or fallback value

tag - calling tag (TableTag), which can be used to find needed ancestor tags

context - jsp page context

Returns:

localized String.