Package com.aquima.interactions.composer

Interface IContentItem

All Superinterfaces:

ICompositeElement, IElement, Serializable

All Known Implementing Classes:

ContentItem

public interface IContentItem
extends ICompositeElement

The content interface represents a content 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	getDescription()	This method returns the description of the content item.
String[]	getLanguageCodes()	Returns the language codes used in this content item.
IMultilingualText	getPlainText(String defaultLanguageCode, IValueFormatter formatter)	Returns the plain text content of this content item in all available languages.
String	getPlainText(String languageCode, String defaultLanguageCode, IValueFormatter formatter)	Returns the plain text content of this content item in the given language.

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

accept, equalsContent, getContentStyle, getElement, getElement, getElementCount, getElements

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

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

Method Details

getDescription

String getDescription()

This method returns the description of the content item.

Returns:

the description of the content item, may be null.

getPlainText

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

Returns the plain text content of this content 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 content item.

getPlainText

IMultilingualText getPlainText(String defaultLanguageCode,
 IValueFormatter formatter)

Returns the plain text content of this content 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 content item

getLanguageCodes

String[] getLanguageCodes()

Returns the language codes used in this content item.

Returns:

array with unique language codes, may be empty but never null.