Package de.xima.fc.interfaces.workflow.mixin

Interface ISummaryKeyValuePair

All Superinterfaces:

Serializable

All Known Implementing Classes:

SummaryKeyValuePair

public interface ISummaryKeyValuePair
extends Serializable

A key value pair. Usually a list of these is displayed in a table on the UI.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

IKeyValueSummarizableElement

Method Summary

Modifier and Type	Method	Description
String	getDisplayKey()
String	getDisplayKeyStyle()
String	getDisplayKeyStyleClass()
String	getDisplayValue()
String	getDisplayValueStyle()
String	getDisplayValueStyleClass()
boolean	isDisplayKeyHtml()
boolean	isDisplayKeyI18n()
boolean	isDisplayValueHtml()
boolean	isDisplayValueI18n()

Method Detail

getDisplayKey

String getDisplayKey()

Returns:

The data to display in the key column of the table.

getDisplayValue

String getDisplayValue()

Returns:

The data to display in the value column of the table.

isDisplayKeyI18n

boolean isDisplayKeyI18n()

Returns:

Whether the key is an i18n key for a resource bundle, or literal text. If the former, the key is looked up in the custom resource bundle of the workflow element handler first, then in the built-in resource bundle of formcycle.

isDisplayValueI18n

boolean isDisplayValueI18n()

Returns:

Whether the value is an i18n key for a resource bundle, or literal text. If the former, the key is looked up in the custom resource bundle of the workflow element handler first, then in the built-in resource bundle of formcycle.

isDisplayKeyHtml

boolean isDisplayKeyHtml()

Returns:

Whether the key contains HTML content. If true, the getDisplayKey() will be inserted into the HTML without any post-processing. Otherwise, special characters are escaped for HTML.

isDisplayValueHtml

boolean isDisplayValueHtml()

Returns:

Whether the value contains HTML content. If true, the getDisplayValue() will be inserted into the HTML without any post-processing. Otherwise, special characters are escaped for HTML.

getDisplayKeyStyle

String getDisplayKeyStyle()

Returns:

Inline style for the key column of the table. Is specified in the TD HTML tag.

getDisplayKeyStyleClass

String getDisplayKeyStyleClass()

Returns:

Style class for the key column of the table. Is specified in the TD HTML tag.

getDisplayValueStyle

String getDisplayValueStyle()

Returns:

Inline style for the value column of the table. Is specified in the TD HTML tag.

getDisplayValueStyleClass

String getDisplayValueStyleClass()

Returns:

Style class for the value column of the table. Is specified in the TD HTML tag.