Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
/* exported gCategoriesPane */
/* globals gSubDialog, Preferences */
Preferences.add({ id: "calendar.categories.names", type: "string" });
var gCategoryList;
var categoryPrefBranch = Services.prefs.getBranch("calendar.category.color.");
/**
* Global Object to hold methods for the categories pref pane
*/
var gCategoriesPane = {
mCategoryDialog: null,
mWinProp: null,
/**
* Initialize the categories pref pane. Sets up dialog controls to show the
* categories saved in preferences.
*/
init() {
// On non-instant-apply platforms, once this pane has been loaded,
// attach our "revert all changes" function to the parent prefwindow's
// "ondialogcancel" event.
const parentPrefWindow = document.documentElement;
if (!parentPrefWindow.instantApply) {
const existingOnDialogCancel = parentPrefWindow.getAttribute("ondialogcancel");
parentPrefWindow.setAttribute(
"ondialogcancel",
"gCategoriesPane.panelOnCancel(); " + existingOnDialogCancel
);
}
// A list of preferences to be reverted when the dialog is cancelled.
// It needs to be a property of the parent to be visible onCancel
if (!("backupPrefList" in parent)) {
parent.backupPrefList = [];
}
gCategoryList = cal.category.fromPrefs();
this.updateCategoryList();
// in linux when opened from modal dialog
this.mWinProp = "centerscreen, chrome, resizable=no";
if (AppConstants.platform != "linux") {
this.mWinProp += ", modal";
}
},
/**
* Updates the listbox containing the categories from the categories saved
* in preferences.
*/
updatePrefs() {
cal.l10n.sortArrayByLocaleCollator(gCategoryList);
Preferences.get("calendar.categories.names").value = cal.category.arrayToString(gCategoryList);
},
updateCategoryList() {
this.updatePrefs();
const listbox = document.getElementById("categorieslist");
listbox.clearSelection();
this.updateButtons();
while (listbox.lastElementChild) {
listbox.lastChild.remove();
}
for (let i = 0; i < gCategoryList.length; i++) {
const newListItem = document.createXULElement("richlistitem");
const categoryName = document.createXULElement("label");
categoryName.setAttribute("id", gCategoryList[i]);
categoryName.setAttribute("flex", "1");
categoryName.setAttribute("value", gCategoryList[i]);
const categoryNameFix = cal.view.formatStringForCSSRule(gCategoryList[i]);
const categoryColor = document.createXULElement("box");
categoryColor.style.width = "150px";
const colorCode = categoryPrefBranch.getCharPref(categoryNameFix, "");
if (colorCode) {
categoryColor.style.backgroundColor = colorCode;
}
newListItem.appendChild(categoryName);
newListItem.appendChild(categoryColor);
listbox.appendChild(newListItem);
}
},
/**
* Adds a category, opening the edit category dialog to prompt the user to
* set up the category.
*/
async addCategory() {
const listbox = document.getElementById("categorieslist");
listbox.clearSelection();
this.updateButtons();
const params = {
title: await document.l10n.formatValue("category-new-label"),
category: "",
color: null,
};
gSubDialog.open(this.mCategoryDialog, { features: "resizable=no" }, params);
},
/**
* Edits the currently selected category using the edit category dialog.
*/
async editCategory() {
const list = document.getElementById("categorieslist");
const categoryNameFix = cal.view.formatStringForCSSRule(gCategoryList[list.selectedIndex]);
const currentColor = categoryPrefBranch.getCharPref(categoryNameFix, "");
const params = {
title: await document.l10n.formatValue("category-edit-label"),
category: gCategoryList[list.selectedIndex],
color: currentColor,
};
if (list.selectedItem) {
gSubDialog.open(this.mCategoryDialog, { features: "resizable=no" }, params);
}
},
/**
* Removes the selected category.
*/
deleteCategory() {
const list = document.getElementById("categorieslist");
if (list.selectedCount < 1) {
return;
}
const categoryNameFix = cal.view.formatStringForCSSRule(gCategoryList[list.selectedIndex]);
this.backupData(categoryNameFix);
try {
categoryPrefBranch.clearUserPref(categoryNameFix);
} catch (ex) {
// If the pref doesn't exist, don't bail out here.
}
// Remove category entry from listbox and gCategoryList.
let newSelection =
list.selectedItem.nextElementSibling || list.selectedItem.previousElementSibling;
const selectedItems = Array.from(list.selectedItems);
for (let i = list.selectedCount - 1; i >= 0; i--) {
const item = selectedItems[i];
if (item == newSelection) {
newSelection = newSelection.nextElementSibling || newSelection.previousElementSibling;
}
gCategoryList.splice(list.getIndexOfItem(item), 1);
item.remove();
}
list.selectedItem = newSelection;
this.updateButtons();
// Update the prefs from gCategoryList
this.updatePrefs();
},
/**
* Saves the given category to the preferences.
*
* @param categoryName The name of the category.
* @param categoryColor The color of the category
*/
async saveCategory(categoryName, categoryColor) {
const list = document.getElementById("categorieslist");
// Check to make sure another category doesn't have the same name
let toBeDeleted = -1;
for (let i = 0; i < gCategoryList.length; i++) {
if (i == list.selectedIndex) {
continue;
}
if (categoryName.toLowerCase() == gCategoryList[i].toLowerCase()) {
const [title, description] = await document.l10n.formatValues([
{ id: "category-overwrite-title" },
{ id: "category-overwrite" },
]);
if (Services.prompt.confirm(null, title, description)) {
if (list.selectedIndex != -1) {
// Don't delete the old category yet. It will mess up indices.
toBeDeleted = list.selectedIndex;
}
list.selectedIndex = i;
} else {
return;
}
}
}
if (categoryName.length == 0) {
const warning = await document.l10n.formatValue("category-blank-warning");
Services.prompt.alert(null, null, warning);
return;
}
const categoryNameFix = cal.view.formatStringForCSSRule(categoryName);
if (list.selectedIndex == -1) {
this.backupData(categoryNameFix);
gCategoryList.push(categoryName);
if (categoryColor) {
categoryPrefBranch.setCharPref(categoryNameFix, categoryColor);
}
} else {
this.backupData(categoryNameFix);
gCategoryList.splice(list.selectedIndex, 1, categoryName);
categoryPrefBranch.setCharPref(categoryNameFix, categoryColor || "");
}
// If 'Overwrite' was chosen, delete category that was being edited
if (toBeDeleted != -1) {
list.selectedIndex = toBeDeleted;
this.deleteCategory();
}
this.updateCategoryList();
const updatedCategory = gCategoryList.indexOf(categoryName);
list.ensureIndexIsVisible(updatedCategory);
list.selectedIndex = updatedCategory;
},
/**
* Enable the edit and delete category buttons.
*/
updateButtons() {
const categoriesList = document.getElementById("categorieslist");
document.getElementById("deleteCButton").disabled = categoriesList.selectedCount <= 0;
document.getElementById("editCButton").disabled = categoriesList.selectedCount != 1;
},
/**
* Backs up the category name in case the dialog is canceled.
*
* @see formatStringForCSSRule
* @param categoryNameFix The formatted category name.
*/
backupData(categoryNameFix) {
const currentColor = categoryPrefBranch.getCharPref(categoryNameFix, "##NEW");
for (let i = 0; i < parent.backupPrefList.length; i++) {
if (categoryNameFix == parent.backupPrefList[i].name) {
return;
}
}
parent.backupPrefList[parent.backupPrefList.length] = {
name: categoryNameFix,
color: currentColor,
};
},
/**
* Event Handler function to be called on doubleclick of the categories
* list. If the edit function is enabled and the user doubleclicked on a
* list item, then edit the selected category.
*/
listOnDblClick(event) {
if (event.target.localName == "listitem" && !document.getElementById("editCButton").disabled) {
this.editCategory();
}
},
/**
* Reverts category preferences in case the cancel button is pressed.
*/
panelOnCancel() {
for (let i = 0; i < parent.backupPrefList.length; i++) {
if (parent.backupPrefList[i].color == "##NEW") {
try {
categoryPrefBranch.clearUserPref(parent.backupPrefList[i].name);
} catch (ex) {
dump("Exception caught in 'panelOnCancel': " + ex + "\n");
}
} else {
categoryPrefBranch.setCharPref(
parent.backupPrefList[i].name,
parent.backupPrefList[i].color
);
}
}
},
};