BBTranslations

java.lang.Object
- BBTranslator.BBTranslations

```
public class BBTranslations
extends Object
```
The BBTranslations class is a BBj CustomObject that gets and adds translations for localization support.

Field Summary

Fields
Modifier and Type	Field and Description
`BBjNumber`	`Dirty` A field variable that specifies the BBTranslations have been modified
`BBTranslations`	`Parent!` A field variable that contains the parent translations
`SortedProperties`	`Properties!` A field variable that contains the properties
`static BBjNumber`	`TRANSLATION_KEY_ERROR` A field variable that defines the TRANSLATION_KEY_ERROR error number

Constructor Summary

Constructors
Constructor and Description

BBTranslations(BBTranslationBundle p_bundle!, BBTranslations p_parent!, Locale p_locale!)
BBTranslations constructor

Constructors
Constructor and Description
`BBTranslations(BBTranslationBundle p_bundle!, BBTranslations p_parent!, Locale p_locale!)` BBTranslations constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(Locale p_locale!, BBTranslations p_translations!)` Adds a child translation to the translations
`void`	`addTranslation(BBjString p_key$, BBjString p_value$)` Adds a translation to the translations given a key and value
`void`	`addTranslation(BBjString p_key$, BBjString p_value$, BBjNumber p_skip_existing)` Adds a translation to the translations given a key and value, optionally skipping existing keys
`void`	`addTranslations(HashMap p_translations!)` Adds the translations provided in the passed hash map to the translations
`void`	`addTranslations(HashMap p_translations!, BBjNumber p_skip_existing)` Adds the translations provided in the passed hash map to the translations, optionally skipping existing entries
`Locale`	`findTranslationLocale(BBjString p_key$)` Returns the locale that contains the passed translation key
`HashMap`	`getChildren()` Returns the children of the translations in a HashMap
`static Locale`	`getClientLocale()` Returns the locale used by the client
`static BBjString`	`getClientLocaleString()` Returns the locale string used by the client
`Collection`	`getKeys()` Returns a collection translation keys
`Locale`	`getLocale()` Returns the locale of the translations
`BBTranslations`	`getParent()` Returns the parent of the translations
`SortedProperties`	`getProperties()` Returns the translations properties
`BBjString`	`getPropertiesFileName(Locale p_locale!)` Returns a properties file name
`BBjNumber`	`getSize()` Returns the number of translations
`BBjString`	`getTranslation(BBjString p_key$)` Returns the translated string given a key, if the translation is not found, then the passed in key is returned
`BBjString`	`getTranslation(BBjString p_key$, BBjString p_defaultValue!)` Returns the translated string given a key, if the translation is not found, then the passed in default value is returned
`BBjString`	`getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound)` Returns the translated string given a key, if the translation is not found, then the passed in default value is returned.
`BBjString`	`getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd)` Returns the translated string given a key, if the translation is not found, then the passed in default value is returned.
`BBjString`	`getTranslation(BBjString p_key$, BBjString p_defaultValue!, BBjNumber p_addIfNotFound, BBjNumber p_forceAdd, BBjNumber p_skipParentLocale)` Returns the translated string given a key, if the translation is not found, then the passed in default value is returned.
`BBjNumber`	`isDefault()` Returns true if this is the default translations, otherwise false is returned
`void`	`removeChild(Locale p_locale!)` Removes a child translation from the translations
`void`	`removeChildren()` Removes all children BBTranslationBundles
`void`	`removeTranslation(BBjString p_key$)` Removes a translation given a key
`void`	`removeTranslations()` Removes all translations
`void`	`setTranslation(BBjString p_key$, BBjString p_value$)` Sets a translation value

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Parent!
```
public BBTranslations Parent!
```
    A field variable that contains the parent translations
  - Properties!
```
public SortedProperties Properties!
```
    A field variable that contains the properties
  - Dirty
```
public BBjNumber Dirty
```
    A field variable that specifies the BBTranslations have been modified
  - TRANSLATION_KEY_ERROR
```
public static BBjNumber TRANSLATION_KEY_ERROR
```
    A field variable that defines the TRANSLATION_KEY_ERROR error number
- Constructor Detail
  - BBTranslations
```
public BBTranslations(BBTranslationBundle p_bundle!,
BBTranslations p_parent!,
Locale p_locale!)
```
    BBTranslations constructor
    
    Parameters:
    
    p_bundle! - Specifies the bundle in which the translations belong
    
    p_parent! - Specifies the parent translations
    
    p_locale! - Specifies the Java locale for the translations
- Method Detail
  - addChild
```
public void addChild(Locale p_locale!,
BBTranslations p_translations!)
```
    Adds a child translation to the translations
    
    Parameters:
    
    p_locale! - Specifies the Java Locale of the child translations
    
    p_translations! - Specifies the BBTranslations object to add as a child
  - removeChild
```
public void removeChild(Locale p_locale!)
```
    Removes a child translation from the translations
    
    Parameters:
    
    p_locale! - Specifies the Java locale for the translations
  - removeChildren
```
public void removeChildren()
```
    Removes all children BBTranslationBundles
  - getPropertiesFileName
```
public BBjString getPropertiesFileName(Locale p_locale!)
```
    Returns a properties file name
    
    Parameters:
    
    p_locale! - Specifies the Java locale for the translations
  - getSize
```
public BBjNumber getSize()
```
    Returns the number of translations
  - getKeys
```
public Collection getKeys()
```
    Returns a collection translation keys
  - getTranslation
```
public BBjString getTranslation(BBjString p_key$)
```
    Returns the translated string given a key, if the translation is not found, then the passed in key is returned
    
    Parameters:
    
    p_key$ - Specifies the key to get a translation
  - getTranslation
```
public BBjString getTranslation(BBjString p_key$,
BBjString p_defaultValue!)
```
    Returns the translated string given a key, if the translation is not found, then the passed in default value is returned
    
    Parameters:
    
    p_key$ - Specifies the key to get a translation
    
    p_defaultValue! - Specifies the return value if the key is not found. By default, the key will be returned when not found
  - getTranslation
```
public BBjString getTranslation(BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound)
```
    Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added if not found.
    
    Parameters:
    
    p_key$ - Specifies the key to get a translation
    
    p_defaultValue! - Specifies the return value if the key is not found. By default, the key will be returned when not found
    
    p_addIfNotFound - Specifies if the key with the defaultValue should be added when not found. 0 = do not add, 1 = add
  - getTranslation
```
public BBjString getTranslation(BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound,
BBjNumber p_forceAdd)
```
    Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found.
    
    Parameters:
    
    p_key$ - Specifies the key to get a translation
    
    p_defaultValue! - Specifies the return value if the key is not found. By default, the key will be returned when not found
    
    p_addIfNotFound - Specifies if the key with the defaultValue should be added when not found. 0 = do not add, 1 = add
    
    p_forceAdd - Specifies if the key should be added when not found. 0 = do not add, 1 = add
  - getTranslation
```
public BBjString getTranslation(BBjString p_key$,
BBjString p_defaultValue!,
BBjNumber p_addIfNotFound,
BBjNumber p_forceAdd,
BBjNumber p_skipParentLocale)
```
    Returns the translated string given a key, if the translation is not found, then the passed in default value is returned. The key/value can be added forcefully or if not found. The parent locale translation can be optionally skipped.
    
    Parameters:
    
    p_key$ - Specifies the key to get a translation
    
    p_defaultValue! - Specifies the return value if the key is not found. By default, the key will be returned when not found
    
    p_addIfNotFound - Specifies if the key with the defaultValue should be added when not found. 0 = do not add, 1 = add
    
    p_forceAdd - Specifies if the key should be added when not found. 0 = do not add, 1 = add
    
    p_skipParentLocale - Specifies if the parent locale translations should be skipped. 0 = skip, 1 = do not skip
  - findTranslationLocale
```
public Locale findTranslationLocale(BBjString p_key$)
```
    Returns the locale that contains the passed translation key
    
    Parameters:
    
    p_key$ - Specifies the translation for the desired locale
  - addTranslations
```
public void addTranslations(HashMap p_translations!)
```
    Adds the translations provided in the passed hash map to the translations
    
    Parameters:
    
    p_translations! - Specifies a HashMap where the key is the Java locale and the value is the translation value
  - addTranslations
```
public void addTranslations(HashMap p_translations!,
BBjNumber p_skip_existing)
```
    Adds the translations provided in the passed hash map to the translations, optionally skipping existing entries
    
    Parameters:
    
    p_translations! - Specifies a HashMap where the key is the Java locale and the value is the translation value
    
    p_skip_existing - Specifies whether to skip existing translations. 0 = do not skip, 1 = skip
  - addTranslation
```
public void addTranslation(BBjString p_key$,
BBjString p_value$)
```
    Adds a translation to the translations given a key and value
    
    Parameters:
    
    p_key$ - Specifies the key of the translation to add
    
    p_value$ - Specifies the value of the translation to add
  - addTranslation
```
public void addTranslation(BBjString p_key$,
BBjString p_value$,
BBjNumber p_skip_existing)
```
    Adds a translation to the translations given a key and value, optionally skipping existing keys
    
    Parameters:
    
    p_key$ - Specifies the key of the translation to add
    
    p_value$ - Specifies the value of the translation to add
    
    p_skip_existing - Specifies whether to skip existing keys. 0 = do not skip, 1 = skip
  - setTranslation
```
public void setTranslation(BBjString p_key$,
BBjString p_value$)
```
    Sets a translation value
    
    Parameters:
    
    p_key$ - Specifies the key of the translation to set
    
    p_value$ - Specifies the value of the translation
  - removeTranslations
```
public void removeTranslations()
```
    Removes all translations
  - removeTranslation
```
public void removeTranslation(BBjString p_key$)
```
    Removes a translation given a key
    
    Parameters:
    
    p_key$ - Specifies the key of the translation to remove
  - getLocale
```
public Locale getLocale()
```
    Returns the locale of the translations
  - getParent
```
public BBTranslations getParent()
```
    Returns the parent of the translations
  - getChildren
```
public HashMap getChildren()
```
    Returns the children of the translations in a HashMap
  - getProperties
```
public SortedProperties getProperties()
```
    Returns the translations properties
  - isDefault
```
public BBjNumber isDefault()
```
    Returns true if this is the default translations, otherwise false is returned
  - getClientLocale
```
public static Locale getClientLocale()
```
    Returns the locale used by the client
  - getClientLocaleString
```
public static BBjString getClientLocaleString()
```
    Returns the locale string used by the client

Class BBTranslations

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Parent!

Properties!

Dirty

TRANSLATION_KEY_ERROR

Constructor Detail

BBTranslations

Method Detail

addChild

removeChild

removeChildren

getPropertiesFileName

getSize

getKeys

getTranslation

getTranslation

getTranslation

getTranslation

getTranslation

findTranslationLocale

addTranslations

addTranslations

addTranslation

addTranslation

setTranslation

removeTranslations

removeTranslation

getLocale

getParent

getChildren

getProperties

isDefault

getClientLocale

getClientLocaleString