Package de.xima.fc.workflow

Class SummaryKeyValueText

java.lang.Object

de.xima.fc.workflow.SummaryKeyValueText

All Implemented Interfaces:

ISummaryKeyValueText, Serializable

public final class SummaryKeyValueText
extends Object
implements ISummaryKeyValueText

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SummaryKeyValueText(String displayText, boolean displayTextHtml, boolean displayTextI18n, String displayTextStyle, String displayTextStyleClass)
SummaryKeyValueText(String displayText, boolean displayTextHtml, boolean displayTextI18n, String displayTextStyle, String displayTextStyleClass, Serializable[] parameters)

Method Summary

Modifier and Type	Method	Description
static ISummaryKeyValueText	empty()
String	getDisplayText()
String	getDisplayTextStyle()
String	getDisplayTextStyleClass()
Serializable[]	getParameters()
boolean	isDisplayTextHtml()
boolean	isDisplayTextI18n()
static ISummaryKeyValueText	with(String text)
static ISummaryKeyValueText	with(String text, boolean html)
static ISummaryKeyValueText	with(String text, boolean html, String style, String styleClass)
static ISummaryKeyValueText	withI18n(String i18nKey)
static ISummaryKeyValueText	withI18n(String i18nKey, boolean html)
static ISummaryKeyValueText	withI18n(String i18nKey, boolean html, String style, String styleClass)
static ISummaryKeyValueText	withI18n(String i18nKey, boolean html, String style, String styleClass, Serializable... parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SummaryKeyValueText

public SummaryKeyValueText(String displayText,
                           boolean displayTextHtml,
                           boolean displayTextI18n,
                           String displayTextStyle,
                           String displayTextStyleClass)

SummaryKeyValueText

public SummaryKeyValueText(String displayText,
                           boolean displayTextHtml,
                           boolean displayTextI18n,
                           String displayTextStyle,
                           String displayTextStyleClass,
                           Serializable[] parameters)

Method Detail

getDisplayText

public String getDisplayText()

Specified by:

getDisplayText in interface ISummaryKeyValueText

Returns:

The data to display.

getDisplayTextStyle

public String getDisplayTextStyle()

Specified by:

getDisplayTextStyle in interface ISummaryKeyValueText

Returns:

Inline style for the text .

getDisplayTextStyleClass

public String getDisplayTextStyleClass()

Specified by:

getDisplayTextStyleClass in interface ISummaryKeyValueText

Returns:

Style class for the text.

getParameters

public Serializable[] getParameters()

Specified by:

getParameters in interface ISummaryKeyValueText

Returns:

Optional parameters for the message, when ISummaryKeyValueText.isDisplayTextI18n() is true.

isDisplayTextHtml

public boolean isDisplayTextHtml()

Specified by:

isDisplayTextHtml in interface ISummaryKeyValueText

Returns:

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

isDisplayTextI18n

public boolean isDisplayTextI18n()

Specified by:

isDisplayTextI18n in interface ISummaryKeyValueText

Returns:

Whether the text 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.

empty

public static ISummaryKeyValueText empty()

Returns:

A new text wrapper with no text.

with

public static ISummaryKeyValueText with(String text)

Parameters:

text - Localized text .

Returns:

A new text wrapper for the given text.

with

public static ISummaryKeyValueText with(String text,
                                        boolean html)

Parameters:

text - Localized text .

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

Returns:

A new text wrapper for the given text.

with

public static ISummaryKeyValueText with(String text,
                                        boolean html,
                                        String style,
                                        String styleClass)

Parameters:

text - Localized text .

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

style - Inline style for text.

styleClass - Style class for text

Returns:

A new text wrapper for the given text.

withI18n

public static ISummaryKeyValueText withI18n(String i18nKey)

Parameters:

i18nKey - Key for the text.

Returns:

A new text wrapper for the given text.

withI18n

public static ISummaryKeyValueText withI18n(String i18nKey,
                                            boolean html)

Parameters:

i18nKey - Key for the text.

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

Returns:

A new text wrapper for the given text.

withI18n

public static ISummaryKeyValueText withI18n(String i18nKey,
                                            boolean html,
                                            String style,
                                            String styleClass)

Parameters:

i18nKey - Key for the text.

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

style - Inline style for text.

styleClass - Style class for text

Returns:

A new text wrapper for the given text.

withI18n

public static ISummaryKeyValueText withI18n(String i18nKey,
                                            boolean html,
                                            String style,
                                            String styleClass,
                                            Serializable... parameters)

Parameters:

i18nKey - Key for the text.

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

style - Inline style for text.

styleClass - Style class for text

parameters - Optional parameters for the i18n message.

Returns:

A new text wrapper for the given text.