Save This Page
Home » xwork-2.1.1-src » com.opensymphony.xwork2 » [javadoc | source]
com.opensymphony.xwork2
public class: TextProviderSupport [javadoc | source]
java.lang.Object
   com.opensymphony.xwork2.TextProviderSupport

All Implemented Interfaces:
    ResourceBundleTextProvider

Default TextProvider implementation.
Constructor:
 public TextProviderSupport() 
 public TextProviderSupport(Class clazz,
    LocaleProvider provider) 
    Constructor.
    Parameters:
    clazz - a clazz to use for reading the resource bundle.
    provider - a locale provider.
 public TextProviderSupport(ResourceBundle bundle,
    LocaleProvider provider) 
    Constructor.
    Parameters:
    bundle - the resource bundle.
    provider - a locale provider.
Method from com.opensymphony.xwork2.TextProviderSupport Summary:
getText,   getText,   getText,   getText,   getText,   getText,   getText,   getText,   getText,   getTexts,   getTexts,   setBundle,   setClazz,   setLocaleProvider
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.opensymphony.xwork2.TextProviderSupport Detail:
 public String getText(String key) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class.
 public String getText(String key,
    String defaultValue) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    List args) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    String[] args) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    String defaultValue,
    String arg) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    String defaultValue,
    List args) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    String defaultValue,
    String[] args) 
    Get a text from the resource bundles associated with this action. The resource bundles are searched, starting with the one associated with this particular action, and testing all its superclasses' bundles. It will stop once a bundle is found that contains the given text. This gives a cascading style that allow global texts to be defined for an application base class. If no text is found for this text name, the default value is returned.
 public String getText(String key,
    String defaultValue,
    List args,
    ValueStack stack) 
    Gets a message based on a key using the supplied args, as defined in java.text.MessageFormat , or, if the message is not found, a supplied default value is returned. Instead of using the value stack in the ActionContext this version of the getText() method uses the provided value stack.
 public String getText(String key,
    String defaultValue,
    String[] args,
    ValueStack stack) 
    Gets a message based on a key using the supplied args, as defined in java.text.MessageFormat , or, if the message is not found, a supplied default value is returned. Instead of using the value stack in the ActionContext this version of the getText() method uses the provided value stack.
 public ResourceBundle getTexts() 
    Get the resource bundle associated with this action. This will be based on the actual subclass that is used.
 public ResourceBundle getTexts(String aBundleName) 
    Get the named bundle.

    You can override the getLocale() methodName to change the behaviour of how to choose locale for the bundles that are returned. Typically you would use the TextProvider interface to get the users configured locale, or use your own methodName to allow the user to select the locale and store it in the session (by using the SessionAware interface).

 public  void setBundle(ResourceBundle bundle) 
 public  void setClazz(Class clazz) 
 public  void setLocaleProvider(LocaleProvider localeProvider)