SLING-INF.content.devwidgets.createpage.javascript.createpage.js Maven / Gradle / Ivy
/*
* Licensed to the Sakai Foundation (SF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The SF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
/*
* Dependencies
*
* /dev/lib/misc/trimpath.template.js (TrimpathTemplates)
*/
/*global $ */
require(["jquery", "sakai/sakai.api.core"], function($, sakai) {
/**
* @name sakai_global.createpage
*
* @class createpage
*
* @description
* createpage widget
*
* @version 0.0.1
* @param {String} tuid Unique id of the widget
* @param {Boolean} showSettings Show the settings of the widget or not
*/
sakai_global.createpage = function(tuid, showSettings){
/////////////////////////////
// Configuration variables //
/////////////////////////////
// jQuery DOM objects
var $rootel = $("#" + tuid);
var $createpageContainer = $("#createpage_container", $rootel);
var $selectPageType = $("#createpage_page_type", $rootel);
var $inputPageTitleContainer = $("#createpage_title_container", $rootel);
var $inputPageTitle = $("#createpage_title", $rootel);
var $createpageForm = $("#createpage_form", $rootel);
var $createpageSubmit = $("#createpage_save", $rootel);
var $createpageCancel = $("#createpage_cancel", $rootel);
var $createpageProcessing = $("#createpage_processing", $rootel);
var $createpageTemplates = $("#createpage_templates", $rootel);
var $createpageTemplatesTemplate = $("#createpage_templates_template", $rootel);
// CSS Selectors
var errorMsgClass = "createpage_error_msg";
var invalidFieldClass = "invalid";
var buttonClass = "s3d-button";
var radioButtons = "createpagetemplate_radio";
///////////////////////
// Utility functions //
///////////////////////
/**
* This function is called before the jqModal hides. It removes any error
* notices, resets values for select and text inputs and hides templates
*/
var resetModalDialog = function (hash) {
// hide the overlay
hash.w.hide();
hash.o.remove();
// remove any errors
$("." + errorMsgClass).hide();
$inputPageTitle.removeClass(invalidFieldClass);
// clear input
$inputPageTitle.val("");
// reset page type select element
$selectPageType.val("blank");
// hide templates
$createpageTemplates.hide();
// hide processing message
hideProcessing();
};
/**
* Mark the page title field as erroneous and show an error message
*/
var showPageTitleError = function () {
$("." + errorMsgClass).show();
$inputPageTitle.addClass(invalidFieldClass);
$inputPageTitle.focus();
};
/**
* Show page templates available to the user
*/
var showTemplates = function () {
var json = {
templates: []
};
if(sakai_global.sitespages && sakai_global.sitespages.mytemplates) {
// create a custom list of templates with just the info we care about
for(var t in sakai_global.sitespages.mytemplates) {
if(sakai_global.sitespages.mytemplates.hasOwnProperty(t)) {
var template = {
"id": t,
"name": sakai_global.sitespages.mytemplates[t].name,
"desc": sakai_global.sitespages.mytemplates[t].description
};
json.templates.push(template);
}
}
}
// pass the array to HTML view
$createpageTemplates.html(sakai.api.Util.TemplateRenderer($createpageTemplatesTemplate,
json));
$createpageTemplates.show();
// select the first item
$("input:radio:first", $createpageContainer).attr("checked","checked");
// if no templates, disable the create button
if(json.templates.length === 0) {
$createpageSubmit.attr("disabled","disabled");
}
};
/**
* Show the "Processing..." message to the user
*/
var showProcessing = function () {
$("#createpage_container " + "." + buttonClass).hide();
$createpageProcessing.show();
};
/**
* Hide the "Processing..." message to the user
*/
var hideProcessing = function () {
$createpageProcessing.hide();
$("#createpage_container " + "." + buttonClass).show();
};
////////////////////
// Event Handlers //
////////////////////
/**
* Validate input and initiate creating pages when the user submits the form
*/
$createpageForm.submit(function () {
// check if we have valid input
var pageTitle = $inputPageTitle.val();
if(!pageTitle) {
showPageTitleError();
} else {
// we've got a valid title
showProcessing(); // display "Processing..."
var pageType = $selectPageType.val();
if(pageType === "blank") {
sakai_global.sitespages.createNewPage(pageTitle, "", handleNewPageCreation);
} else if(pageType === "template") {
// fetch the selected template and its content to create a new page
var selectedTemplate = $("input:radio:checked", $createpageContainer).val();
sakai_global.sitespages.createNewPage(pageTitle,
sakai_global.sitespages.mytemplates[selectedTemplate]["pageContent"]["sakai:pagecontent"],
handleNewPageCreation);
} else {
sakai_global.sitespages.addDashboardPage(pageTitle, handleNewPageCreation);
}
}
return false;
});
/**
* Callback function called upon completion of sakai_global.sitespages.createNewPage
* called on submit event of the create page form.
* @param {Boolean} success true if the call succeeded, false otherwise
*/
var handleNewPageCreation = function (success) {
hideProcessing();
if(success) {
// hide the modal
$createpageContainer.jqmHide();
} else {
debug.error("createpage.js - handleNewPageCreation: creating page failed.");
sakai.api.Util.notification.show($("#createpage_createpage").text(),
$("#createpage_cannot_create_page").text(),
sakai.api.Util.notification.type.ERROR);
}
};
/**
* Show available templates when the user selects Create page from template
* in the page type dropdown. If the other types are selected, focus the
* input are immediately.
*/
$selectPageType.change(function () {
var pageType = $selectPageType.val();
if(pageType === "template") {
// display templates
showTemplates();
} else {
// hide templates, ensure submit button is visible
$createpageTemplates.hide();
$createpageSubmit.removeAttr("disabled");
}
$inputPageTitle.focus();
});
/**
* Delete the template when the user clicks the delete link
*/
$createpageContainer.delegate(".createpage_delete_template_link", "click",
function () {
var templateDeleted = this.id.split("_")[1];
delete sakai_global.sitespages.mytemplates[templateDeleted];
// Save updated template preferences
sakai.api.Server.saveJSON("/~" + sakai.api.Util.safeURL(sakai.data.me.user.userid) + "/private/templates",
sakai_global.sitespages.mytemplates, function(success, response) {
if (success) {
showTemplates();
} else {
debug.error("createpage.js: Failed to delete template with id="+templateDeleted);
}
}, true);
});
//////////////////////////////
// Initialization function //
//////////////////////////////
/**
* Public init function that shows the createpage modal dialog
*/
sakai_global.createpage.initialise = function(){
// add jqModal functionality to the container
$createpageContainer.jqm({
modal: true,
overlay: 20,
toTop: true,
onHide: resetModalDialog
})
.jqmAddClose($createpageCancel);
// Load page templates
sakai_global.sitespages.loadTemplates();
$createpageSubmit.removeAttr("disabled");
sakai.api.Util.bindDialogFocus($createpageContainer);
// show container
$createpageContainer.jqmShow();
$inputPageTitle.focus();
};
};
sakai.api.Widgets.widgetLoader.informOnLoad("createpage");
});
© 2015 - 2025 Weber Informatics LLC | Privacy Policy