org.olat.core.util.mail
Class MailTemplateForm

java.lang.Object
  org.olat.core.gui.components.Component
      org.olat.core.gui.components.form.Form
          org.olat.core.util.mail.MailTemplateForm

public class MailTemplateForm
extends Form

Description:
The MailTemplateForm allows the user to enter a mailtext based on the MailTemplate

Initial Date: 21.11.2006

Author:

Florian Gnaegi, frentix GmbH
http://www.frentix.com

Field Summary

Fields inherited from class org.olat.core.gui.components.form.Form

CANCEL_IDENTIFICATION, ELEM_BUTTON_COMMAND_ID, EVNT_FORM_CANCELLED, EVNT_VALIDATION_NOK, EVNT_VALIDATION_OK, SUBMIT_IDENTIFICATION

Constructor Summary

MailTemplateForm(java.util.Locale locale, MailTemplate template, boolean useCancel, Controller listeningController)
Constructor for the mail notification form

Method Summary

boolean	sendMailSwitchEnabled()
void	updateTemplateFromForm(MailTemplate template) Update the given templates with the values entered in the form
boolean	validate()

Methods inherited from class org.olat.core.gui.components.form.Form

addFormElement, addSubmitKey, addSubmitKey, addVisibilityDependsOnSelectionRule, getCheckBoxElement, getDateElement, getElementCount, getFormElement, getHTMLRendererSingleton, getIntegerElement, getMultipleSelectionElement, getNameIterator, getPasswordElement, getRadioButtonElement, getSelectedSubmitKey, getSingleSelectionElement, getTextAreaElement, getTextElement, getVisibilityDependsOnSelectionRules, getWikiMarkupTextAreaElement, hasMandatoryFields, hasWikiMarkupFields, isDisplayOnly, isValid, removeCancelButton, removeFormElements, setAllFormElements, setCancelButton, setCancelKey, setDisplayOnly, setSubmitKey, validate

Methods inherited from class org.olat.core.gui.components.Component

addListener, debuginfoGetListeners, dispatchRequest, getAndClearLatestFiredEvent, getComponentName, getDispatchID, getExtendedDebugInfo, getLatestDispatchedController, getListenerInfo, getParent, getSpanAsDomReplaceable, getTimestamp, getTranslator, isDirty, isDirtyForUser, isDomReplaceable, isEnabled, isVisible, setDirty, setDomReplaceable, setEnabled, setSpanAsDomReplaceable, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MailTemplateForm

public MailTemplateForm(java.util.Locale locale,
                        MailTemplate template,
                        boolean useCancel,
                        Controller listeningController)

Constructor for the mail notification form

Parameters:

locale -

template - Default values taken from this template

useCancel -

listeningController - Controller that listens to form events

Method Detail

validate

public boolean validate()

Specified by:

validate in class Form

Returns:

true: form validates, false: form contains invalid data

See Also:

Form.validate()

sendMailSwitchEnabled

public boolean sendMailSwitchEnabled()

Returns:

true: mail switch is enabled; false: otherwhise

updateTemplateFromForm

public void updateTemplateFromForm(MailTemplate template)

Update the given templates with the values entered in the form

Parameters:

template -