/**
* Copyright (C) 2005-2016 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* This mixin is intended to be mixed into any buttons or menu items that require an action that creates a new
* [dialog]{@link module:alfresco/dialogs/AlfDialog} that contains a [form]{@link module:alfresco/forms/Form}.
*
* Examples of use include the create content menu items in the document library.
*
* @module alfresco/dialogs/_AlfCreateFormDialogMixin
* @extends module:alfresco/core/Core
* @author Dave Draper
* @deprecated Since 1.0.25 - use the [DialogService]{@link module:alfresco/services/DialogService} instead.
*/
define(["dojo/_base/declare",
"alfresco/core/Core",
"dojo/_base/lang",
"alfresco/dialogs/AlfDialog",
"alfresco/forms/Form",
"dojo/when"],
function(declare, AlfCore, lang, AlfDialog, /*jshint unused:false*/ AlfForm, when) {
return declare([AlfCore], {
/**
* Create a new 'publishTopic' for the action and generates a new 'pubSubScope' and then sets
* up subscriptions for handling show dialog and cancel dialog requests.
*
* @instance
*/
postCreate: function alfresco_dialogs__CreateFormDialogMixin__postCreate() {
this.inherited(arguments);
if (!this.dialogConfirmationButtonTitle)
{
this.dialogConfirmationButtonTitle = this.message("services.ActionService.button.ok");
}
if (!this.dialogCancellationButtonTitle)
{
this.dialogCancellationButtonTitle = this.message("services.ActionService.button.cancel");
}
// Generate a new UUID for the publishTopic and then override the configuration so that
// the publishications are global. Then immediately subscribe globally to that generated
// UUID. This should ensure that only this instance will handle the publications. This
// should avoid the form being created/displayed accidentally...
this.publishTopic = this.generateUuid(); // This gets passed to the button, etc
this._formConfirmationTopic = this.generateUuid();
this.publishGlobal = true;
this.alfSubscribe(this.publishTopic, lang.hitch(this, this.onCreateFormDialogRequest), true);
this.alfSubscribe(this._formConfirmationTopic, lang.hitch(this, this.onDialogConfirmation));
},
/**
* Keeps a reference to any dialogs that are created. Old dialogs are destroyed before
* new ones are created.
*
* @instance
* @type {object}
* @default
*/
dialog: null,
/**
* The title for the dialog.
*
* @instance
* @type {string}
* @default
*/
dialogTitle: "",
/**
*
* @instance
* @type {string}
* @default
*/
dialogConfirmationButtonTitle: null,
/**
*
* @instance
* @type {string}
* @default
*/
dialogCancellationButtonTitle: null,
/**
* The configuration for the contents of the dialog to be displayed. This should be provided either on instantiation
* or by the widget that mixes this module in
*
* @instance
* @type {object}
* @default
*/
widgets: null,
/**
* Handles requests to create the [dialog]{@link module:alfresco/dialogs/AlfDialog} containining a
* [form]{@link module:alfresco/forms/Form}. It will delete any previously created dialog (to ensure
* no stale data is displayed) and create a new dialog containing the form defined.
*
* @instance
* @param {object} payload The payload published on the request topic.
*/
onCreateFormDialogRequest: function alfresco_dialogs__CreateFormDialogMixin__onCreateFormDialogRequest(/*jshint unused:false*/ payload) {
// Destroy any previously created dialog...
if (this.dialog)
{
this.dialog.destroyRecursive();
}
if (!this.widgets)
{
this.alfLog("warn", "A request was made to display a dialog but no 'widgets' attribute has been defined", this);
}
else
{
try
{
var createFormConfig = this.createFormConfig(this.widgets);
var dialogConfig = this.createDialogConfig(createFormConfig);
this.dialog = new AlfDialog(dialogConfig);
this.dialog.show();
}
catch (e)
{
this.alfLog("error", "The following error occurred creating a dialog for defined configuration", e, this.dialogConfig, this);
}
}
},
/**
* Creates the configuration object to pass to the dialog.
*
* @instance
* @param {object} formConfig
* @returns {object} The dialog configuration.
*/
createDialogConfig: function alfresco_dialogs__CreateFormDialogMixin__createDialogConfig(formConfig) {
var dialogConfig = {
title: this.message(this.dialogTitle),
pubSubScope: this.pubSubScope, // Scope the dialog content so that it doesn't pollute any other widgets
parentPubSubScope: this.parentPubSubScope,
widgetsContent: [formConfig],
widgetsButtons: [
{
name: "alfresco/buttons/AlfButton",
config: {
label: this.dialogConfirmationButtonTitle,
disableOnInvalidControls: true,
additionalCssClasses: "alfresco-dialogs-_AlfCreateFormDialogMixin confirmation call-to-action",
publishTopic: this._formConfirmationTopic
}
},
{
name: "alfresco/buttons/AlfButton",
config: {
label: this.dialogCancellationButtonTitle,
additionalCssClasses: "alfresco-dialogs-_AlfCreateFormDialogMixin cancellation",
publishTopic: "ALF_CLOSE_DIALOG"
}
}
]
};
return dialogConfig;
},
/**
* Creates and returns the [form]{@link module:alfresco/forms/Form} configuration to be added to the [dialog]{@link module:alfresco/dialog/AlfDialog}
*
* @instance
* @param {object} widgets This is the configuration of the fields to be included in the form.
* @returns {object} The configuration for the form to add to the dialog
*/
createFormConfig: function alfresco_dialogs__CreateFormDialogMixin__createFormConfig(widgets) {
var formConfig = {
name: "alfresco/forms/Form",
config: {
displayButtons: false,
widgets: widgets
}
};
return formConfig;
},
/**
* This is the topic that will be published when the dialog is "confirmed" (e.g. the "OK" button is clicked)
*
* @instance
* @type {string}
* @default
*/
formSubmissionTopic: null,
/**
* Whether or not the [formSubmissionTopic]{@link module:alfresco/dialogs/_AlfCreateFormDialogMixin#formSubmissionTopic}
* should be published globally.
*
* @instance
* @type {boolean}
* @default
*/
formSubmissionGlobal: true,
/**
* Whether or not the [formSubmissionTopic]{@link module:alfresco/dialogs/_AlfCreateFormDialogMixin#formSubmissionTopic}
* should be published on the mixing widgets parent pubSubScope.
*
* @instance
* @type {boolean}
* @default
*/
formSubmissionToParent: false,
/**
* This handles the user clicking the confirmation button on the dialog (typically, and by default the "OK" button). This has a special
* handler to process the payload and construct a simple object reqpresenting the
* content of the inner [form]{@link module:alfresco/forms/Form}.
*
* @instance
* @param {object} payload The dialog content
*/
onDialogConfirmation: function alfresco_dialogs__CreateFormDialogMixin__onDialogConfirmation(payload) {
if (payload &&
payload.dialogContent)
{
when(payload.dialogContent, lang.hitch(this, function(dialogContent) {
if (dialogContent && dialogContent.length)
{
var data = {};
var formData = dialogContent[0].getValue();
this.alfPublish(this.formSubmissionTopic, formData, this.formSubmissionGlobal, this.formSubmissionToParent);
}
else
{
this.alfLog("error", "The format of the dialog content was not as expected, the 'formSubmissionTopic' will not be published", payload, this);
}
}));
}
}
});
});
Alfresco Aikau Widgets