Class Alfresco.module.EmailForm

Email form module.

Field Summary
Field Attributes	Field Name and Description
	components Object container for storing component instances.
	containerDiv Container element for template in DOM.
	options Object container for initialization options
	recipients The selected Recipients usernames
	recipientsCache A cache for the selected Recipients displayNames, using username as key and the displayName as value.

Fields borrowed from class Alfresco.component.Base:: modules, services, widgets

Method Summary
Method Attributes	Method Name and Description
	mandatoryRecipients(field, args, event, form, silent, message) Mandatory validation handler, tests that there is at least one recpient.
	onAuthorityFinderLoaded(response) Called when the authority finder template has been loaded.
	onCancelClick(e, p_obj) Dialog Cancel button event handler
	onDiscardTemplateButtonClick(e, p_obj) Select destination button event handler
	onRecipientsSelected(layer, args) Recipients selected in recipients dialog
	onSelectRecipientsClick(e, p_obj) Select destination button event handler
	onTemplateLoaded(response, emailFormConfig) Event callback when dialog template has been loaded
	onUseTemplateMenuSelect(sType, aArgs, p_obj) Called when an option in the Run Rules menu has been called.
	showDialog(emailFormConfig) Main entry point

Methods borrowed from class Alfresco.component.Base:: attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions

Field Detail

{object} components

Object container for storing component instances.

{HTMLElement} containerDiv

Container element for template in DOM.

options

Object container for initialization options

{Array} recipients

The selected Recipients usernames

recipientsCache

A cache for the selected Recipients displayNames, using username as key and the displayName as value.

Method Detail

mandatoryRecipients(field, args, event, form, silent, message)

Mandatory validation handler, tests that there is at least one recpient.

Parameters:
{object} field: Will be the subject field since the recipient fields are hidden
{object} args: Not used
{object} event: The event that caused this handler to be called, maybe null
{object} form: The forms runtime class instance the field is being managed by
{boolean} silent: Determines whether the user should be informed upon failure
{string} message: Message to display when validation fails, maybe null

onAuthorityFinderLoaded(response)

Called when the authority finder template has been loaded.
Creates a dialog and inserts the authority finder for choosing groups and users to add.

onCancelClick(e, p_obj)

Dialog Cancel button event handler

onDiscardTemplateButtonClick(e, p_obj)

Select destination button event handler

onRecipientsSelected(layer, args)

Recipients selected in recipients dialog

onSelectRecipientsClick(e, p_obj)

Select destination button event handler

onTemplateLoaded(response, emailFormConfig)

Event callback when dialog template has been loaded

onUseTemplateMenuSelect(sType, aArgs, p_obj)

Called when an option in the Run Rules menu has been called.

showDialog(emailFormConfig)

Main entry point

Parameters:
{object} emailFormConfig: Data to fill the form with
emailFormConfig.recipients {array} Array of the recipients usernames to send the email to
emailFormConfig.subject {string) The emails subject
emailFormConfig.message {string} The message of the email
emailFormConfig.template {string} The template for the email

Classes