Package org.apache.struts2.components

Class I18n

java.lang.Object

org.apache.struts2.components.Component

org.apache.struts2.components.I18n

public class I18n
extends Component

Gets a resource bundle and place it on the value stack. This allows the text tag to access messages from any bundle, and not just the bundle associated with the current action.

• name* - the resource bundle's name (eg foo/bar/customBundle)

Example:

 

 <s:i18n name="myCustomBundle">
    The i18n value for key aaa.bbb.ccc in myCustomBundle is <s:property value="text('aaa.bbb.ccc')" />
 </s:i18n>

 
 

 

 <s:i18n name="some.package.bundle" >
      <s:text name="some.key" />
 </s:i18n>

 
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name
protected boolean	pushed

Fields inherited from class org.apache.struts2.components.Component

actionMapper, attributes, COMPONENT_STACK, devMode, escapeHtmlBody, performClearTagStateForTagPoolingServers, stack, standardAttributesMap, throwExceptionOnELFailure

Constructor Summary

Constructors

Constructor	Description
I18n(ValueStack stack)

Method Summary

Modifier and Type	Method	Description
boolean	end(Writer writer, String body)	Callback for the end tag of this component.
void	setLocaleProviderFactory(LocaleProviderFactory localeProviderFactory)
void	setLocalizedTextProvider(LocalizedTextProvider localizedTextProvider)
void	setName(String name)
void	setTextProvider(TextProvider textProvider)
void	setTextProviderFactory(TextProviderFactory textProviderFactory)
boolean	start(Writer writer)	Callback for the start tag of this component.

Methods inherited from class org.apache.struts2.components.Component

addAllAttributes, addParameter, completeExpression, copyAttributes, determineActionURL, determineNamespace, end, escapeHtmlBody, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getAttributes, getComponentStack, getNamespace, getPerformClearTagStateForTagPoolingServers, getStack, getStandardAttributes, isAcceptableExpression, isValidTagAttribute, popComponentStack, setActionMapper, setDevMode, setEscapeHtmlBody, setNotExcludedAcceptedPatterns, setPerformClearTagStateForTagPoolingServers, setThrowExceptionsOnELFailure, setUrlHelper, stripExpression, toString, usesBody

Methods inherited from class java.lang.Object

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

Field Details

pushed

protected boolean pushed

name

protected String name

Constructor Details

I18n

public I18n(ValueStack stack)

Method Details

setLocalizedTextProvider

public void setLocalizedTextProvider(LocalizedTextProvider localizedTextProvider)

setTextProvider

public void setTextProvider(TextProvider textProvider)

setTextProviderFactory

public void setTextProviderFactory(TextProviderFactory textProviderFactory)

setLocaleProviderFactory

public void setLocaleProviderFactory(LocaleProviderFactory localeProviderFactory)

start

public boolean start(Writer writer)

Description copied from class: Component

Callback for the start tag of this component. Should the body be evaluated?

Overrides:

start in class Component

Parameters:

writer - the output writer.

Returns:

true if the body should be evaluated

end

public boolean end(Writer writer,
 String body)
            throws StrutsException

Description copied from class: Component

Callback for the end tag of this component. Should the body be evaluated again?
NOTE: will pop component stack.

Overrides:

end in class Component

Parameters:

writer - the output writer.

body - the rendered body.

Returns:

true if the body should be evaluated again

Throws:

StrutsException

setName

public void setName(String name)