Package com.broadleafcommerce.metadata.dsl.core

Class ExplanatoryMessage

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.ExplanatoryMessage

All Implemented Interfaces:

Serializable

public final class ExplanatoryMessage
extends Object
implements Serializable

A wrapper around a label that supports text as well as placement of where that text appears

Author:

Phillip Verheyden (phillipuniverse)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExplanatoryMessage.Placement
static enum	ExplanatoryMessage.Type

Constructor Summary

Constructors

Constructor	Description
ExplanatoryMessage(InternationalizedMessage message)
ExplanatoryMessage(InternationalizedMessage message, ExplanatoryMessage.Placement placement, ExplanatoryMessage.Type type)
ExplanatoryMessage(String message)	Initializes the given text with the default placement of ExplanatoryMessage.Placement.RIGHT and the default type of ExplanatoryMessage.Type.INFO.
ExplanatoryMessage(String message, ExplanatoryMessage.Placement placement)	Initializes the given text with a customized placement and the default type of ExplanatoryMessage.Type.INFO
ExplanatoryMessage(String message, ExplanatoryMessage.Placement placement, ExplanatoryMessage.Type type)	Initializes the given text with a customized placement and type
ExplanatoryMessage(String message, ExplanatoryMessage.Type type)	Initializes the given text with a specific type and the default placement of ExplanatoryMessage.Placement.RIGHT

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
InternationalizedMessage	getMessage()	The user-facing name of the text
ExplanatoryMessage.Placement	getPlacement()	Where the text or icon appears in relation to the field
ExplanatoryMessage.Type	getType()	The type of text to display
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExplanatoryMessage

public ExplanatoryMessage(String message)

Initializes the given text with the default placement of ExplanatoryMessage.Placement.RIGHT and the default type of ExplanatoryMessage.Type.INFO.

Parameters:

message - the text to display, can be a key in a message bundle for I18n

ExplanatoryMessage

public ExplanatoryMessage(String message,
 ExplanatoryMessage.Type type)

Initializes the given text with a specific type and the default placement of ExplanatoryMessage.Placement.RIGHT

Parameters:

message - the text to display to the user

type - the type of text to display

ExplanatoryMessage

public ExplanatoryMessage(String message,
 ExplanatoryMessage.Placement placement)

Initializes the given text with a customized placement and the default type of ExplanatoryMessage.Type.INFO

Parameters:

message - the text to display to the user

placement - where the text should display in relationship to the field

ExplanatoryMessage

public ExplanatoryMessage(String message,
 ExplanatoryMessage.Placement placement,
 ExplanatoryMessage.Type type)

Initializes the given text with a customized placement and type

Parameters:

message - the text to display to the user

placement - where the text should display in relationship to the field

type - the type of text to display

ExplanatoryMessage

public ExplanatoryMessage(InternationalizedMessage message)

ExplanatoryMessage

public ExplanatoryMessage(InternationalizedMessage message,
 ExplanatoryMessage.Placement placement,
 ExplanatoryMessage.Type type)

Method Details

getMessage

public InternationalizedMessage getMessage()

The user-facing name of the text

getPlacement

public ExplanatoryMessage.Placement getPlacement()

Where the text or icon appears in relation to the field

getType

public ExplanatoryMessage.Type getType()

The type of text to display

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object