ExplanatoryMessage (Broadleaf Metadata Common 1.7.3-GA API)

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 class ExplanatoryMessage.Placement

Constructor Summary

Constructors
Constructor	Description
`ExplanatoryMessage(InternationalizedMessage message)`
`ExplanatoryMessage(InternationalizedMessage message, ExplanatoryMessage.Placement placement)`
`ExplanatoryMessage(String message)`	Initializes the given text with the default placement of `ExplanatoryMessage.Placement.RIGHT`.
`ExplanatoryMessage(String message, ExplanatoryMessage.Placement placement)`	Initializes the given text with a customized placement

Method Summary

All Methods Instance Methods Concrete Methods
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
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExplanatoryMessage
```
public ExplanatoryMessage(String message)
```
    Initializes the given text with the default placement of ExplanatoryMessage.Placement.RIGHT.
    
    Parameters:
    
    message - the text to display, can be a key in a message bundle for I18n
  - ExplanatoryMessage
```
public ExplanatoryMessage(String message,
                          ExplanatoryMessage.Placement placement)
```
    Initializes the given text with a customized placement
    
    Parameters:
    
    text - the text to display to the user
    
    placement - where the text should display in relationship to the field
  - ExplanatoryMessage
```
public ExplanatoryMessage(InternationalizedMessage message)
```
  - ExplanatoryMessage
```
public ExplanatoryMessage(InternationalizedMessage message,
                          ExplanatoryMessage.Placement placement)
```
- Method Detail
  - 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
  - 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