Class CmsSendEmailGroupsDialog
java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsWidgetDialog
org.opencms.workplace.tools.workplace.broadcast.CmsSendEmailGroupsDialog
- All Implemented Interfaces:
org.opencms.widgets.I_CmsWidgetDialog
Dialog to send a new email to the selected groups.
- Since:
- 6.5.6
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringlocalized messages Keys prefix.protected CmsMessageInfoMessage info object.static final String[]Defines which pages are valid for this dialog.static final StringParameter name constant.Fields inherited from class org.opencms.workplace.CmsWidgetDialog
ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgetsFields inherited from class org.opencms.workplace.CmsDialog
ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_ACTION_VALUE_FOR_CHANGED_INDEX, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATEFields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEWFields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE -
Constructor Summary
ConstructorsConstructorDescriptionCmsSendEmailGroupsDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.CmsSendEmailGroupsDialog(org.opencms.jsp.CmsJspActionElement jsp) Public constructor with JSP action element. -
Method Summary
Modifier and TypeMethodDescriptionvoidCommits the edited project to the db.protected StringcreateDialogHtml(String dialog) Creates the dialog HTML for all defined widgets of the named dialog (page).protected voidCreates the list of widgets for this dialog.Returns a warning if users have been excluded.Returns the selected groups.protected String[]Returns the allowed pages for this dialog.Returns the list of selected groups.protected StringReturns a semicolon separated list of user names.protected voidInitializes the message info object to work with depending on the dialog state and request parameters.protected voidprotected voidinitWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) voidsetExcludedUsers(String excludedUsers) Sets the warning message if users have been excluded.voidsetParamGroups(String paramGroups) Sets the list of selected groups.protected voidShould be overridden for parameter validation.Methods inherited from class org.opencms.workplace.CmsWidgetDialog
actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialogMethods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitleMethods inherited from class org.opencms.workplace.tools.CmsToolDialog
computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyleMethods inherited from class org.opencms.workplace.CmsWorkplace
addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferencesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opencms.widgets.I_CmsWidgetDialog
button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle
-
Field Details
-
KEY_PREFIX
localized messages Keys prefix.- See Also:
-
PAGES
Defines which pages are valid for this dialog. -
PARAM_GROUPS
Parameter name constant.- See Also:
-
m_msgInfo
Message info object.
-
-
Constructor Details
-
CmsSendEmailGroupsDialog
Public constructor with JSP action element.- Parameters:
jsp- an initialized JSP action element
-
CmsSendEmailGroupsDialog
public CmsSendEmailGroupsDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.- Parameters:
context- the JSP page contextreq- the JSP requestres- the JSP response
-
-
Method Details
-
actionCommit
Commits the edited project to the db.- Specified by:
actionCommitin classCmsWidgetDialog
-
getExcludedUsers
Returns a warning if users have been excluded.- Returns:
- a warning
-
getGroups
Returns the selected groups.- Returns:
- the selected groups
-
getParamGroups
Returns the list of selected groups.- Returns:
- the list of selected groups
-
setExcludedUsers
Sets the warning message if users have been excluded.- Parameters:
excludedUsers- the warning message
-
setParamGroups
Sets the list of selected groups.- Parameters:
paramGroups- the list of selected groups to set
-
createDialogHtml
Description copied from class:CmsWidgetDialogCreates the dialog HTML for all defined widgets of the named dialog (page).To get a more complex layout variation, you have to overwrite this method in your dialog class.
- Overrides:
createDialogHtmlin classCmsWidgetDialog- Parameters:
dialog- the dialog (page) to get the HTML for- Returns:
- the dialog HTML for all defined widgets of the named dialog (page)
- See Also:
-
defineWidgets
Creates the list of widgets for this dialog.- Specified by:
defineWidgetsin classCmsWidgetDialog
-
getPageArray
Description copied from class:CmsWidgetDialogReturns the allowed pages for this dialog.- Specified by:
getPageArrayin classCmsWidgetDialog- Returns:
- the allowed pages for this dialog
- See Also:
-
getToNames
Returns a semicolon separated list of user names.- Returns:
- a semicolon separated list of user names
-
initMessageObject
Initializes the message info object to work with depending on the dialog state and request parameters. -
initMessages
- Overrides:
initMessagesin classorg.opencms.workplace.CmsWorkplace- See Also:
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) - Overrides:
initWorkplaceRequestValuesin classCmsWidgetDialog- See Also:
-
validateParamaters
Description copied from class:CmsWidgetDialogShould be overridden for parameter validation.The exception is never seen by the user, so it can be just a
new.Exception()- Overrides:
validateParamatersin classCmsWidgetDialog- Throws:
Exception- if the parameters are not valid- See Also:
-