Package com.aquima.interactions.composer

Interface ITextItem

All Superinterfaces:

IElement, Serializable

All Known Implementing Classes:

TextItem

public interface ITextItem
extends IElement

The multilingual text model represents a text node that needs to be displayed in a composite element.

Since:

7.0

Author:

Jon van Leuven

Method Summary

Modifier and Type	Method	Description
String[]	getLanguageCodes()	Returns the set language codes.
TextElement[]	getNodes(String languageCode)	This method returns all the text elements from this text model for a specific language.
IMultilingualText	getPlainText(String defaultLanguageCode, IValueFormatter formatter)	Returns the plain text content of this text item in all available languages.
String	getPlainText(String languageCode, String defaultLanguageCode, IValueFormatter formatter)	Returns the plain text content of this text item in the given language.

Methods inherited from interface com.aquima.interactions.composer.IElement

accept, duplicate, getName, getParent, getPresentationStyles, getProperty, getPropertyKeys, getRuntimeKey, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent, isVisible, setProperty

Method Details

getLanguageCodes

String[] getLanguageCodes()

Returns the set language codes.

Returns:

The language codes, not null.

getNodes

TextElement[] getNodes(String languageCode)

This method returns all the text elements from this text model for a specific language.

Parameters:

languageCode - The language code to get the nodes for.

Returns:

Array containing all the text elements from this text model.

getPlainText

String getPlainText(String languageCode,
 String defaultLanguageCode,
 IValueFormatter formatter)

Returns the plain text content of this text item in the given language.

Parameters:

languageCode - the language in which the plain text should be returned (not null)

defaultLanguageCode - the default language to use (not null)

formatter - the formatter used to format value nodes (not null)

Returns:

the plain text of this text item.

getPlainText

IMultilingualText getPlainText(String defaultLanguageCode,
 IValueFormatter formatter)

Returns the plain text content of this text item in all available languages.

Parameters:

defaultLanguageCode - the default language to use (not null)

formatter - the formatter used to format value nodes (not null)

Returns:

the plain text of this text item