com.qcadoo.view.api

Interface ComponentMessagesHolder

All Known Subinterfaces:

AwesomeDynamicListComponent, CheckBoxComponent, ComponentState, FieldComponent, FormComponent, GridComponent, InputWithActionComponent, LookupComponent, ViewDefinitionState

public interface ComponentMessagesHolder

ComponentMessagesHolder is simple container of component-related messages to display.

Since:

1.2.1

Method Summary

Modifier and Type	Method and Description
void	addMessage(ErrorMessage errorMessage) Adds message to this component with type set to MessageType.FAILURE.
void	addMessage(GlobalMessage globalMessage) Adds message to this component with type set to MessageType.INFO.
void	addMessage(String messageTranslationKey, ComponentState.MessageType type, boolean autoClose, boolean extraLarge, String... args) Adds message (translated using given key) to this component.
void	addMessage(String messageTranslationKey, ComponentState.MessageType type, boolean autoClose, String... args) Adds message (translated using given key) to this component.
void	addMessage(String messageTranslationKey, ComponentState.MessageType type, String... args) Adds message (translated using given key) to this component.
void	addTranslatedMessage(String translatedMessage, ComponentState.MessageType type) Adds already translated message to this component.
void	addTranslatedMessage(String translatedMessage, ComponentState.MessageType type, boolean autoClose) Adds already translated message to this component.
void	addTranslatedMessage(String translatedMessage, ComponentState.MessageType type, boolean autoClose, boolean extraLarge) Adds already translated message to this component.

Method Detail

addMessage

void addMessage(ErrorMessage errorMessage)

Adds message to this component with type set to MessageType.FAILURE. Message will automatically close after some time.

Parameters:

errorMessage - validation error message

addMessage

void addMessage(GlobalMessage globalMessage)

Adds message to this component with type set to MessageType.INFO. Message will automatically close after some time.

Parameters:

globalMessage - validation message

addMessage

void addMessage(String messageTranslationKey,
                ComponentState.MessageType type,
                boolean autoClose,
                boolean extraLarge,
                String... args)

Adds message (translated using given key) to this component.

Parameters:

messageTranslationKey - translation key for message content

type - message type

autoClose - true if this message should automatically close after some time

args - message's arguments

extraLarge -

addMessage

void addMessage(String messageTranslationKey,
                ComponentState.MessageType type,
                boolean autoClose,
                String... args)

Adds message (translated using given key) to this component.

Parameters:

messageTranslationKey - translation key for message content

type - message type

autoClose - true if this message should automatically close after some time

args - message's arguments

addMessage

void addMessage(String messageTranslationKey,
                ComponentState.MessageType type,
                String... args)

Adds message (translated using given key) to this component. Message will automatically close after some time.

Parameters:

messageTranslationKey - translation key for message content

type - message type

args - message's arguments

addTranslatedMessage

void addTranslatedMessage(String translatedMessage,
                          ComponentState.MessageType type)

Adds already translated message to this component. Message will automatically close after some time.

Parameters:

translatedMessage - translated message content

type - message type

autoClose - true if this message should automatically close after some time

addTranslatedMessage

void addTranslatedMessage(String translatedMessage,
                          ComponentState.MessageType type,
                          boolean autoClose)

Adds already translated message to this component.

Parameters:

translatedMessage - translated message content

type - message type

autoClose - true if this message should automatically close after some time

addTranslatedMessage

void addTranslatedMessage(String translatedMessage,
                          ComponentState.MessageType type,
                          boolean autoClose,
                          boolean extraLarge)

Adds already translated message to this component.

Parameters:

translatedMessage - translated message content

type - message type

autoClose - true if this message should automatically close after some time

extraLarge -