Class SweetDevRia.Alert

Alert Message Component
Defined in: Alert.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SweetDevRia.Alert(id)

Field Summary
Field Attributes	Field Name and Description
<static>	SweetDevRia.Alert.HIDE_EVENT This event type is fired when hide alert component
<static>	SweetDevRia.Alert.SHOW_EVENT This event type is fired when show alert component

Method Summary
Method Attributes	Method Name and Description
	afterHide() This method is called after hiding the alert.
	afterShow() This method is called after showing the alert.
	beforeHide() This method is called before hiding the alert.
	beforeShow() This method is called before showing the alert.
<private>	createAlertDiv() Create the HTML render of the component
<private>	createButton(text, methodName) Create a button for this alert
<private>	getCssClass() Get the main class name for this alert
<private>	getCssIconClass() Get the icon class name for this alert
	hide() Hide the alert
	onCancel() Function triggered on "Cancel" action.
	onClose() Function triggered on "Close" action.
	onNo() Function triggered on "No" action.
	onOk() Function triggered on "Ok" action.
	onYes() Function triggered on "Yes" action.
	setActionType(message) Change the component's actionType property.
	setMessage(message) Change the component's message
	setModal(message) Change the component's modal property
	setType(message) Change the component's type property.
	show() Show the alert

Class Detail

SweetDevRia.Alert(id)

Parameters:
{String} id: The id of the component

Field Detail

<static> SweetDevRia.Alert.HIDE_EVENT

This event type is fired when hide alert component

<static> SweetDevRia.Alert.SHOW_EVENT

This event type is fired when show alert component

Method Detail

afterHide()

This method is called after hiding the alert. To be overridden !!

afterShow()

This method is called after showing the alert. To be overridden !!

{boolean} beforeHide()

This method is called before hiding the alert. To be overridden !!

Returns:: True if this method can be called, else false.

{boolean} beforeShow()

This method is called before showing the alert. To be overridden !!

Returns:: True if this method can be called, else false.

<private> {HTMLElement} createAlertDiv()

Create the HTML render of the component

Returns:: the HTML render of the element

<private> {HTMLElement} createButton(text, methodName)

Create a button for this alert

Parameters:
{String} text: the text to insert in the button
{String} methodName: the function called on this button action

Returns:: the button created

<private> {String} getCssClass()

Get the main class name for this alert

Returns:: this alert main classname

<private> {String} getCssIconClass()

Get the icon class name for this alert

Returns:: this alert icon classname

hide()

Hide the alert

onCancel()

Function triggered on "Cancel" action. To be overridden.

onClose()

Function triggered on "Close" action. To be overridden.

onNo()

Function triggered on "No" action. To be overridden.

onOk()

Function triggered on "Ok" action. To be overridden.

onYes()

Function triggered on "Yes" action. To be overridden.

setActionType(message)

Change the component's actionType property. Possible values are SweetDevRia.Alert.NONE, SweetDevRia.Alert.OK, SweetDevRia.Alert.OK_CANCEL, SweetDevRia.Alert.YES_NO , SweetDevRia.Alert.YES_NO_CANCEL, SweetDevRia.Alert.CLOSE

Parameters:
{String} message: the new actionType property

setMessage(message)

Change the component's message

Parameters:
{String} message: the new message

setModal(message)

Change the component's modal property

Parameters:
{Boolean} message: the new modal property

setType(message)

Change the component's type property. Possible values are SweetDevRia.Alert.PLAIN, SweetDevRia.Alert.INFO, SweetDevRia.Alert.WARN, SweetDevRia.Alert.ERROR

Parameters:
{String} message: the new type property

show()

Show the alert

Classes

Class SweetDevRia.Alert