Child pages
  • Localization

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  1. the UI Tags
  2. Messages and Errors from the ValidationAware interface (implemented by ActionSupport and ValidationAwareSupport)
  3. Within actions action classes that extend ActionSupport through the getText() method

...

Tip
titlePackage hierarchy
Wiki Markup
{snippet:id=packagenote|javadoc=true|url=com.opensymphony.xwork2.util/LocalizedTextUtil.java}

Default action's class

If you configure action as follow

Code Block
xml
xml
<action name="index">
   <result>/index.jsp</result>
</action>

it will use a default class defined with default-class-ref in struts-default.xml which is com.opensymphony.xwork2.ActionSupport. It means you have two options here to get I18N working in that case:

  • define com/opensymphony/xwork2/ActionSupport.properties and put messages there
  • point default-class-ref to your base class and then defined appropriated .properties file (corresponding to class' name or package)

Examples

There are several ways to access the message resources, including getText, the text tag, and the i18n tag.

...

Wiki Markup
{snippet:id=i18nExample|javadoc=true|lang=xml|url=org.apache.struts2.components.Property}
Note

The default implementation of TextProvider which is used in ActionSupport perform evaluation of value read from bundle base on the provided key, see Localizing Output for an example.

Using the text tag

The text tag retrieves a message from the default resource bundle.

...

Wiki Markup
{snippet:id=globalresource|javadoc=true|url=com.opensymphony.xwork2.util.LocalizedTextUtil}

Formatting Dates and Numbers

See Formatting Dates and Numbers for more details and examples.

Comparison with Struts 1

Struts 1 users should be familiar with the application.properties resource bundle, where you can put all the messages in the application that are going to be translated. Struts 2, though, splits the resource bundles per action or model class, and you may end up with duplicated messages in those resource bundles. A quick fix for that is to create a file called ActionSupport.properties in com/opensymphony/xwork2 and put it on your classpath. This will only work well if all your actions subclass XWork2's ActionSupport.

...