|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.control.LyController
leon.control.LyAreaController
leon.control.LyUserInputController
leon.control.LyMailController
public class LyMailController
This class implements a sending email input dialog/window to ask the requested values from the
user. This controller is associated with a builder (LyMailBuilder
) and a behavior (LyMailBehavior
) that implements LyMailBehaviorInterface
.
Field Summary | |
---|---|
static java.lang.String |
__VERSION
File Version |
static java.lang.String |
ATTACHED_FILE
Form field identifier: a file that can be sent with the email message. |
static java.lang.String |
AUTH_LOGIN
Form field identifier: smtp user name for authentication. |
static java.lang.String |
AUTH_PASSWORD
Form field identifier: smtp password for authentication. |
static java.lang.String |
AUTH_REALM
Form field identifier: smtp realm for CRAM-MD5 authentication. |
static java.lang.String |
AUTHENTICATION
Form field identifier: smtp server requires authentication. |
static java.lang.String |
FROM_MAIL_ADDRESS
Form field identifier: email address of the sender. |
static java.lang.String |
FROM_USER_NAME
Form field identifier: user name of the sender. |
static java.lang.String |
HTML_MESSAGE
Form field identifier: a file that contains the HTML content of the email message. |
static java.lang.String |
MAIL_PREVIEW_CONTENT
Form field identifier: the generated content of a consultation email message. |
static java.lang.String |
MAIL_PREVIEW_SENDER
Form field identifier: the generated name of the sender, with its email address. |
static java.lang.String |
MAIL_PREVIEW_SUBJECT
Form field identifier: the generated subject of a consultation email message. |
static java.lang.String |
MAIL_SUBJECT
Form field identifier: email subject field. |
static java.lang.String |
RAW_MESSAGE
Form field identifier: the unformatted email message. |
static java.lang.String |
RECIPIENT_USER_CLASS
Form field identifier: the class that holds the receivers' users as objects. |
static java.lang.String |
RECIPIENT_USER_FIELD
Form field identifier: the field of the class that contains the email address. |
static java.lang.String |
SELECTED_RECIPIENTS
Form field identifier: the relation field that holds the recipient users. |
static java.lang.String |
SEND_SELECTED
Form field identifier: sets the controller to send the selected objects or use the selected objects as the receivers. |
static java.lang.String |
SMTP_PORT
Form field identifier: server port to use for the connection. |
static java.lang.String |
SMTP_SERVER
Form field identifier: smtp server to send the email message. |
Fields inherited from class leon.control.LyAreaController |
---|
DEFAULT_MENU_ITEM_IMAGE_SIZE, DEMAND_APPLY, DEMAND_CANCEL, DEMAND_CLOSE, DEMAND_CREATE_CHART, DEMAND_DELETE_CHART, DEMAND_DELETE_OBJECTINFOS, DEMAND_DELETE_PREFERENCE, DEMAND_UPDATE_VIEW, DEMAND_VALIDATE |
Fields inherited from class leon.control.LyController |
---|
_nbControllers, _nextId, CONTROLLER_ID_SEP, DEFAULT_IMAGE_FORMAT, DEMAND_HELP, ID_SEP |
Constructor Summary | |
---|---|
LyMailController(LySession session,
LyController parent,
LyAction action,
LyClassInfo classInfo,
LyObjectList context)
This constructor creates a new LyMailController object. |
|
LyMailController(LySession session,
LyController parent,
LyAction action,
LyObjectList context)
This constructor creates a new LyMailController object. |
Method Summary | |
---|---|
java.io.File |
getAttachedFile()
Accessor to the attached file of the custom email message. |
boolean |
getAuthentication()
Accessor to the authentication parameter. |
java.lang.String |
getAuthLogin()
Accessor to the login used on SMTP authentication. |
java.lang.String |
getAuthPassword()
Accessor to the password used on SMTP authentication. |
java.lang.String |
getAuthRealm()
Accessor to the realm used on CRAM-MD5 authentication. |
java.lang.Class<?> |
getBehaviorInterface()
Method that gives the interface that must be implemented by the behavior associated to this controller. |
java.lang.String |
getFromAddress()
Accessor to the email address of the sender. |
java.lang.String |
getFromUserName()
Accessor to the user name of the sender. |
java.lang.String |
getGeneratedHtmlContent()
Generates a formatted message content that represents the selected objects. |
java.lang.String |
getGeneratedRawContent()
Generates the textual content of a generated email message. |
java.lang.String |
getGeneratedSender()
Generates the sender name of an email message using the given user name and email address in the meta-model. |
java.lang.String |
getGeneratedSubject()
Generates the subject of an email message when the selected objects are sent to multiple recipients. |
java.io.File |
getHtmlMessage()
Accessor to the file that contains the formatted part of the custom email message. |
java.lang.String |
getRawMessage()
Accessor to the raw message of the custom email message. |
int |
getSmtpPort()
Accessor to the SMTP port number. |
java.lang.String |
getSmtpServer()
Accessor to the SMTP server address. |
java.lang.String |
getSubject()
Accessor to the subject of a custom email message. |
java.lang.String |
getToUserClass()
Accessor to the identifier of the class that contains the recipients for the email message. |
java.lang.String |
getToUserField()
Accessor to the identifier of the field that contains the email addresses for the email message's recipients. |
boolean |
isSendSelected()
Indicates that the selected objects have to be sent. |
void |
sendMail()
Sends a message associated to the given objects. |
void |
showView()
Make the view visible to the user. |
void |
validateMail()
Checks every aspect of all the values already retrieved with retrieveValues() and
generates the appropriate error if some values are missing. |
Methods inherited from class leon.control.LyUserInputController |
---|
actionDemand, addBoolean, addBoolean, addChoice, addChoice, addDate, addDate, addFile, addFile, addLabel, addLabel, addList, addList, addNumber, addNumber, addRelation, addRelation, addText, addText, addText, getClassInfo, getComponent, getFormComponent, getImage, getInputId, getTitleBar, getViewController, isDialog, isViewResizable, reset, setBehavior, setBuilder, setDialog, setImage, setInputId, setTitleBar |
Methods inherited from class leon.control.LyController |
---|
activateViewDemand, demandPerformed, dragDropDemand, getApplication, getClassInfo, getId, getImage, getImage, getImage, getImage, getImageFromPrefix, getImageFromPrefix, getImageFromPrefix, getName, getObjectId, getSession, getUserData, getView, getViewManager, helpDemand, hideView, isFreed, isIdle, selectionDemand, setBuilderClass, setLastModified, setName, setUserData, showError, showError, showWarning, updateViewFromValues |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final java.lang.String SMTP_SERVER
public static final java.lang.String SMTP_PORT
public static final java.lang.String AUTHENTICATION
public static final java.lang.String AUTH_LOGIN
public static final java.lang.String AUTH_PASSWORD
public static final java.lang.String AUTH_REALM
public static final java.lang.String SEND_SELECTED
public static final java.lang.String MAIL_SUBJECT
public static final java.lang.String FROM_USER_NAME
public static final java.lang.String FROM_MAIL_ADDRESS
public static final java.lang.String RECIPIENT_USER_CLASS
public static final java.lang.String RECIPIENT_USER_FIELD
public static final java.lang.String SELECTED_RECIPIENTS
public static final java.lang.String ATTACHED_FILE
public static final java.lang.String HTML_MESSAGE
public static final java.lang.String RAW_MESSAGE
public static final java.lang.String MAIL_PREVIEW_SENDER
public static final java.lang.String MAIL_PREVIEW_SUBJECT
public static final java.lang.String MAIL_PREVIEW_CONTENT
Constructor Detail |
---|
public LyMailController(LySession session, LyController parent, LyAction action, LyObjectList context)
session
- current session associated to the controller. The controller automatically
registers on the specified session.parent
- parent controller (or null for 'root' controller). Controller hierarchy
indicates a child controller (for example a dialog created from a main view)action
- related action. If an action is specified, the controller uses action
parameters (action name, action specific XML view description ...)context
- current context (may be null if the view is not contextual to a list of
objects).public LyMailController(LySession session, LyController parent, LyAction action, LyClassInfo classInfo, LyObjectList context)
session
- current session associated to the controller. The controller automatically
registers on the specified session.parent
- parent controller (or null for 'root' controller). Controller hierarchy
indicates a child controller (for example a dialog created from a main view)action
- related action. If an action is specified, the controller uses action
parameters (action name, action specific XML view description ...)classInfo
- This parameter is not used. Kept from introspection compatibility.context
- current context (may be null if the view is not contextual to a list of
objects).Method Detail |
---|
public java.lang.Class<?> getBehaviorInterface()
LyUserInputController
getBehaviorInterface
in class LyUserInputController
LyUserInputController.getBehaviorInterface()
public void validateMail()
retrieveValues()
and
generates the appropriate error if some values are missing.
public void sendMail()
_sendSelected
attribute is
true, then the given objects will be sent through the LyMailBehavior.sendMail(LyMailController, LyClassInfo, LyFieldInfo, LyObjectList)
method.
Else the objects will specify email users to send a custom email message with the LyMailBehavior.sendMail(LyMailController, LyObjectList, LyFieldInfo)
method.
public java.lang.String getGeneratedSubject()
public java.lang.String getGeneratedRawContent()
public java.lang.String getGeneratedHtmlContent()
public java.lang.String getGeneratedSender()
public void showView()
LyAreaController
showView
in class LyAreaController
LyAreaController.showView()
public boolean getAuthentication()
public java.lang.String getAuthLogin()
public java.lang.String getAuthPassword()
public java.lang.String getAuthRealm()
public java.lang.String getSmtpServer()
public int getSmtpPort()
public java.lang.String getFromUserName()
public java.lang.String getFromAddress()
public java.lang.String getToUserClass()
public java.lang.String getToUserField()
public java.lang.String getSubject()
public java.lang.String getRawMessage()
public java.io.File getHtmlMessage()
public java.io.File getAttachedFile()
public boolean isSendSelected()
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |