new UserMessage(config)
Shows a message for a specified amount of time.
After the time period the message is hidden.
After the time period the message is hidden.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Object | Configuration for this object. The config supplied directly extends the control |
Members
containerCssClass
Properties:
| Name | Type | Description |
|---|---|---|
containerCssClass |
string | The css class to apply to the container element |
displayTime
Properties:
| Name | Type | Description |
|---|---|---|
displayTime |
number | The time the message will be diaplyed for, in milliseconds. |
text
Properties:
| Name | Type | Description |
|---|---|---|
text |
string | The text to display |
Methods
destroy()
Destroys this object
getUI() → {Object}
Gets the UI for this message
Returns:
A jQuery object that contains this info box
- Type
- Object
hide()
Hides this message.
setMessage(message)
Set a new message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
string | Sets a new message |
show()
Shows this message. If the message is out of view it will be moved into view.