|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.util.LocalizationImpl
public class LocalizationImpl
Constructor Summary | |
---|---|
LocalizationImpl()
|
Method Summary | |
---|---|
Object |
deserialize(JSONObject jsonObject)
Deserializes the JSON object into a map of locales and localized strings. |
String[] |
getAvailableLocales(String xml)
Gets the available locales from the localizations XML |
String |
getDefaultLocale(String xml)
Gets the default locale from the localizations XML. |
String |
getLocalization(String xml,
String requestedLanguageId)
Gets the localized string from the localizations XML. |
String |
getLocalization(String xml,
String requestedLanguageId,
boolean useDefault)
Gets the localized string from the localizations XML, optionally using the default language if the no localization exists for the requested language. |
Map<Locale,String> |
getLocalizationMap(PortletRequest portletRequest,
String parameter)
Gets a map of locales and localized strings for the parameter in the portlet request. |
Map<Locale,String> |
getLocalizationMap(String xml)
Gets a map of locales and localized strings from the localizations XML. |
String |
getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter)
Gets an xml of locales and localized strings for the parameter in the portlet request. |
Map<Locale,String> |
getLocalizedParameter(PortletRequest portletRequest,
String parameter)
|
String |
getPreferencesValue(PortletPreferences preferences,
String key,
String languageId)
Gets the localized preferences value for the key. |
String |
getPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
Gets the localized preferences value for the key, optionally using the default language if the no localization exists for the requested language. |
String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
String languageId)
Gets the localized preferences values for the key. |
String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
Gets the localized preferences values for the key, optionally using the default language if the no localization exists for the requested language. |
String |
removeLocalization(String xml,
String key,
String requestedLanguageId)
Removes the localization for the language from the localizations XML. |
String |
removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata)
Removes the localization for the language from the localizations XML, optionally storing the localized strings as CDATA in the XML. |
void |
setLocalizedPreferencesValues(PortletRequest portletRequest,
PortletPreferences preferences,
String parameter)
Sets the localized preferences values for the parameter in the portlet request. |
void |
setPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
String value)
Sets the localized preferences value for the key. |
void |
setPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
String[] values)
Sets the localized preferences values for the key. |
String |
updateLocalization(String xml,
String key,
String value)
Updates the localized string for the system default language in the localizations XML. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId)
Updates the localized string for the language in the localizations XML. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId)
Updates the localized string for the language in the localizations XML and changes the default language. |
String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId,
boolean cdata)
Updates the localized string for the language in the localizations XML and changes the default language, optionally storing the localized strings as CDATA in the XML. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalizationImpl()
Method Detail |
---|
public Object deserialize(JSONObject jsonObject)
Localization
deserialize
in interface Localization
jsonObject
- the JSON object to deserialize
public String[] getAvailableLocales(String xml)
Localization
getAvailableLocales
in interface Localization
xml
- the localizations XML to get the available locales from
public String getDefaultLocale(String xml)
Localization
getDefaultLocale
in interface Localization
xml
- the localizations XML to get the default locale from
public String getLocalization(String xml, String requestedLanguageId)
Localization
getLocalization
in interface Localization
xml
- the localizations XML to get the localized string fromrequestedLanguageId
- the id of the language to get the
localization for
public String getLocalization(String xml, String requestedLanguageId, boolean useDefault)
Localization
getLocalization
in interface Localization
xml
- the localizations XML to get the localized string fromrequestedLanguageId
- the id of the language to get the
localization foruseDefault
- whether to use the default language if no localization
exists for the requested language
useDefault
is
false
and no localization exists for the requested
language, an empty string will be returned.public Map<Locale,String> getLocalizationMap(PortletRequest portletRequest, String parameter)
Localization
getLocalizationMap
in interface Localization
portletRequest
- the portlet request to get the locales and
localized strings fromparameter
- the prefix of the parameters containing the localized
strings. Each localization will be loaded from a parameter with
this prefix, followed by an underscore, and the language id.
public Map<Locale,String> getLocalizationMap(String xml)
Localization
getLocalizationMap
in interface Localization
xml
- the localizations XML to get the locales and localized
strings from
public String getLocalizationXmlFromPreferences(PortletPreferences preferences, PortletRequest portletRequest, String parameter)
Localization
getLocalizationXmlFromPreferences
in interface Localization
preferences
- the preferences container to get the localized value
fromportletRequest
- the portlet request to get the locales and
localized strings fromparameter
- the prefix of the parameters containing the localized
strings. Each localization will be loaded from a parameter with
this prefix, followed by an underscore, and the language id.
public Map<Locale,String> getLocalizedParameter(PortletRequest portletRequest, String parameter)
getLocalizedParameter
in interface Localization
public String getPreferencesValue(PortletPreferences preferences, String key, String languageId)
Localization
getPreferencesValue
in interface Localization
preferences
- the preferences container to get the localized value
fromkey
- the preferences key to get the localized value forlanguageId
- the id of the language to get the localization for
public String getPreferencesValue(PortletPreferences preferences, String key, String languageId, boolean useDefault)
Localization
getPreferencesValue
in interface Localization
preferences
- the preferences container to get the localized value
fromkey
- the preferences key to get the localized value forlanguageId
- the id of the language to get the localization foruseDefault
- whether to use the default language if no localization
exists for the requested language
useDefault
is
false
and no localization exists for the requested
language, an empty string will be returned.public String[] getPreferencesValues(PortletPreferences preferences, String key, String languageId)
Localization
getPreferencesValues
in interface Localization
preferences
- the preferences container to get the localized values
fromkey
- the preferences key to get localized values forlanguageId
- the id of the language to get the localizations for
public String[] getPreferencesValues(PortletPreferences preferences, String key, String languageId, boolean useDefault)
Localization
getPreferencesValues
in interface Localization
preferences
- the preferences container to get the localized values
fromkey
- the preferences key to get localized values forlanguageId
- the id of the language to get the localizations foruseDefault
- whether to use the default language if no localization
exists for the requested language
useDefault
is
false
and no localization exists for the requested
language, an empty array will be returned.public String removeLocalization(String xml, String key, String requestedLanguageId)
Localization
removeLocalization
in interface Localization
xml
- the localizations XML to remove the localization for the
language fromkey
- the name of the localized string, such as "Title"requestedLanguageId
- the id of the language to remove from the
localizations XML
public String removeLocalization(String xml, String key, String requestedLanguageId, boolean cdata)
Localization
removeLocalization
in interface Localization
xml
- the localizations XML to remove the localization for the
language fromkey
- the name of the localized string, such as "Title"requestedLanguageId
- the id of the language to remove from the
localizations XMLcdata
- whether to store localized strings as CDATA in the XML
public void setLocalizedPreferencesValues(PortletRequest portletRequest, PortletPreferences preferences, String parameter) throws Exception
Localization
setLocalizedPreferencesValues
in interface Localization
portletRequest
- the portlet request to get the localized values
frompreferences
- the preferences container to set the localized values
inparameter
- the prefix of the parameters containing the localized
strings. Each localization will be loaded from a parameter with
this prefix, followed by an underscore, and the language id.
Exception
- if an exception occurredpublic void setPreferencesValue(PortletPreferences preferences, String key, String languageId, String value) throws Exception
Localization
setPreferencesValue
in interface Localization
preferences
- the preferences container to store the localized
value inkey
- the preferences key to set the localized value forlanguageId
- the id of the language to set the localization forvalue
- the localized value
Exception
- if an exception occurredpublic void setPreferencesValues(PortletPreferences preferences, String key, String languageId, String[] values) throws Exception
Localization
setPreferencesValues
in interface Localization
preferences
- the preferences container to store the localized
values inkey
- the preferences key to set the localized values forlanguageId
- the id of the language to set the localizations forvalues
- the localized values
Exception
- if an exception occurredpublic String updateLocalization(String xml, String key, String value)
Localization
updateLocalization
in interface Localization
xml
- the localizations XML to update the localized string inkey
- the name of the localized string, such as "Title"value
- the localized string
public String updateLocalization(String xml, String key, String value, String requestedLanguageId)
Localization
updateLocalization
in interface Localization
xml
- the localizations XML to update the localized string inkey
- the name of the localized string, such as "Title"value
- the localized stringrequestedLanguageId
- the id of the language to update the
localization for
public String updateLocalization(String xml, String key, String value, String requestedLanguageId, String defaultLanguageId)
Localization
updateLocalization
in interface Localization
xml
- the localizations XML to update the localized string inkey
- the name of the localized string, such as "Title"value
- the localized stringrequestedLanguageId
- the id of the language to update the
localization fordefaultLanguageId
- the id of the default language
public String updateLocalization(String xml, String key, String value, String requestedLanguageId, String defaultLanguageId, boolean cdata)
Localization
updateLocalization
in interface Localization
xml
- the localizations XML to update the localized string inkey
- the name of the localized string, such as "Title"value
- the localized stringrequestedLanguageId
- the id of the language to update the
localization fordefaultLanguageId
- the id of the default languagecdata
- whether to store localized strings as CDATA in the XML
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |