Merge pull request #12 from ONLYOFFICE/fix/api-description

Fix for api descriptions

api.js

@@ -75,27 +75,78 @@
 			isLoadFonts = true;
 			AscFonts.FontPickerByCharacter.getFontBySymbol(nUncheckedSymbol);
 		}
+
+		function private_ApplyPrToCheckBox(oCC)
+		{
+			if (!oCC)
+				return;
+
+			if (oFormPr)
+			{
+				oCC.SetFormPr(oFormPr);
+				oCC.UpdatePlaceHolderTextPrForForm();
+			}
+
+			if (oCommonPr)
+				oCC.SetContentControlPr(oCommonPr);
+		}
 		
 		function private_PerformAddCheckBox()
 		{
-			oLogicDocument.RemoveTextSelection();
-			if (!oLogicDocument.IsSelectionLocked(AscCommon.changestype_Paragraph_Content))
-			{
-				oLogicDocument.StartAction(AscDFH.historydescription_Document_AddContentControlCheckBox);
 
-				var oCC = oLogicDocument.AddContentControlCheckBox(oPr);
-				if (oCC && oFormPr)
+			if (oLogicDocument.IsTextSelectionUse())
+			{
+				let arrSelectedParagraphs = oLogicDocument.GetSelectedParagraphs();
+
+				// Select entire paragraphs so that after the action all added checkboxes are included in the selection
+				let nSelectDirection = oLogicDocument.GetSelectDirection();
+				for (let nIndex = 0, nCount = arrSelectedParagraphs.length; nIndex < nCount; ++nIndex)
 				{
-					oCC.SetFormPr(oFormPr);
-					oCC.UpdatePlaceHolderTextPrForForm();
+					arrSelectedParagraphs[nIndex].SelectAll(nSelectDirection);
 				}
 
-				if (oCC && oCommonPr)
-					oCC.SetContentControlPr(oCommonPr);
+				let oState = oLogicDocument.SaveDocumentState(false);
 
-				oLogicDocument.UpdateInterface();
-				oLogicDocument.Recalculate();
-				oLogicDocument.FinalizeAction();
+				if (arrSelectedParagraphs.length > 0
+					&& !oLogicDocument.IsSelectionLocked(AscCommon.changestype_None, {
+					Type      : AscCommon.changestype_2_ElementsArray_and_Type,
+					Elements  : arrSelectedParagraphs,
+					CheckType : AscCommon.changestype_Paragraph_Content
+				}))
+				{
+					oLogicDocument.StartAction(AscDFH.historydescription_Document_AddContentControlCheckBox);
+					oLogicDocument.RemoveSelection();
+
+					for (let nIndex = 0, nCount = arrSelectedParagraphs.length; nIndex < nCount; ++nIndex)
+					{
+						let oCC = arrSelectedParagraphs[nIndex].AddCheckBoxToStartPos(oPr);
+						private_ApplyPrToCheckBox(oCC);
+					}
+
+					oLogicDocument.LoadDocumentState(oState);
+					oLogicDocument.UpdateInterface();
+					oLogicDocument.Recalculate();
+					oLogicDocument.FinalizeAction();
+				}
+				else
+				{
+					oLogicDocument.LoadDocumentState(oState);
+				}
+			}
+			else
+			{
+				oLogicDocument.RemoveTextSelection();
+				if (!oLogicDocument.IsSelectionLocked(AscCommon.changestype_Paragraph_Content))
+				{
+					oLogicDocument.StartAction(AscDFH.historydescription_Document_AddContentControlCheckBox);
+
+					var oCC = oLogicDocument.AddContentControlCheckBox(oPr);
+					private_ApplyPrToCheckBox(oCC);
+
+					oLogicDocument.UpdateInterface();
+					oLogicDocument.Recalculate();
+					oLogicDocument.FinalizeAction();
+				}
 			}
 		}
 		
@@ -130,6 +181,57 @@
 				oCC.UpdatePlaceHolderTextPrForForm();
 				oCC.ConvertFormToFixed();
 				oCC.SetPictureFormPr(new AscCommon.CSdtPictureFormPr());
+				var aDrawings = oCC.GetAllDrawingObjects();
+				for(var nDrawing = 0; nDrawing < aDrawings.length; ++nDrawing) 
+				{
+					var oDrawing = aDrawings[nDrawing];
+					var oGraphic = oDrawing.GraphicObj;
+					if(oGraphic && oGraphic.getObjectType() === AscDFH.historyitem_type_ImageShape) 
+					{
+						var oSpPr = oGraphic.spPr;
+						if(oSpPr) 
+						{
+							if(oSpPr.Fill) 
+							{
+								oSpPr.setFill(null);
+							}
+							if(oSpPr.ln) 
+							{
+								oSpPr.setLn(null);
+							}
+							if(oSpPr.geometry) 
+							{
+								oSpPr.setGeometry(null);
+							}
+							var oXfrm = oSpPr.xfrm;
+							if(oXfrm)
+							{
+								if(!AscFormat.fApproxEqual(oXfrm.rot, 0.0))
+								{
+									oXfrm.setRot(0);
+								}
+								if(oXfrm.flipH)
+								{
+									oXfrm.setFlipH(false);
+								}
+								if(oXfrm.flipH)
+								{
+									oXfrm.setFlipH(false);
+								}
+								if(oXfrm.flipV)
+								{
+									oXfrm.setFlipV(false);
+								}
+							}
+						}
+					}
+				}
+
+				if (!oCC.IsPlaceHolder())
+				{
+					oLogicDocument.Recalculate(true);
+					oCC.UpdatePictureFormLayout();
+				}
 			}
 
 			if (oCC && oCommonPr)

apiBuilder.js

@@ -0,0 +1,358 @@
+/*
+ * (c) Copyright Ascensio System SIA 2010-2019
+ *
+ * This program is a free software product. You can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License (AGPL)
+ * version 3 as published by the Free Software Foundation. In accordance with
+ * Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
+ * that Ascensio System SIA expressly excludes the warranty of non-infringement
+ * of any third-party rights.
+ *
+ * This program is distributed WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE. For
+ * details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
+ *
+ * You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
+ * street, Riga, Latvia, EU, LV-1050.
+ *
+ * The  interactive user interfaces in modified source and object code versions
+ * of the Program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU AGPL version 3.
+ *
+ * Pursuant to Section 7(b) of the License you must retain the original Product
+ * logo when distributing the program. Pursuant to Section 7(e) we decline to
+ * grant you any rights under trademark law for use of our trademarks.
+ *
+ * All the Product's GUI elements, including illustrations and icon sets, as
+ * well as technical writing content are licensed under the terms of the
+ * Creative Commons Attribution-ShareAlike 4.0 International. See the License
+ * terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
+ *
+ */
+
+
+"use strict";
+(function(window, builder)
+{
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	// Import
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	const AscBuilder         = window["AscBuilder"];
+	const GetStringParameter = AscBuilder.GetStringParameter;
+	const GetBoolParameter   = AscBuilder.GetBoolParameter;
+	const GetNumberParameter = AscBuilder.GetNumberParameter;
+	const GetArrayParameter  = AscBuilder.GetArrayParameter;
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * Base class
+	 * @global
+	 * @class
+	 * @name Api
+	 */
+	var Api = window["Asc"]["asc_docs_api"] || window["Asc"]["spreadsheet_api"];
+ 
+	/**
+	 * Form common properties
+	 * @typedef {Object} FormPrBase
+	 * @property {string} key
+	 * @property {string} tip
+	 * @property {boolean} required
+	 * @property {string} placeholder
+	 */
+
+	/**
+	 * Text form specific properties
+	 * @typedef {Object} TextFormPrBase
+	 * @property {boolean} comb
+	 * @property {number} maxCharacters
+	 * @property {number} cellWidth
+	 * @property {boolean} multiLine
+	 * @property {boolean} autoFit
+	 */
+
+	/**
+	 * Checkbox form properties
+	 * @typedef {FormPrBase | TextFormPrBase} TextFormPr
+	 */
+	 
+	/**
+	 * Checkbox specific properties
+	 * @typedef {Object} CheckBoxFormPrBase
+	 * @property {boolean} radio
+	 */
+
+	/**
+	 * Checkbox form properties
+	 * @typedef {FormPrBase | CheckBoxFormPrBase} CheckBoxFormPr
+	 */
+
+	/**
+	 * Combobox specific properties
+	 * @typedef {Object} ComboBoxFormPrBase
+	 * @property {boolean} editable
+	 * @property {boolean} autoFit
+	 * @property {Array.<string | Array.<string>>} items
+	 */
+
+	/**
+	 * Combobox form properties
+	 * @typedef {FormPrBase | ComboBoxFormPrBase} ComboBoxFormPr
+	 */
+
+	/**
+	 * Condition when to scale image.
+	 * @typedef {"always" | "never" | "tooBig" | "tooSmall"} ScaleFlag
+	 */
+
+	/**
+	 * Value from 0 to 100
+	 * @typedef {number} percentage
+	 */
+
+	/**
+	 * Picture form specific properties
+	 * @typedef {Object} PictureFormPrBase
+	 * @property {ScaleFlag} scaleFlag
+	 * @property {boolean} lockAspectRatio
+	 * @property {boolean} respectBorders
+	 * @property {percentage} shiftX
+	 * @property {percentage} shiftY
+	 */
+
+	/**
+	 * Picture form properties
+	 * @typedef {FormPrBase | PictureFormPrBase} PictureFormPr
+	 */
+
+	/**
+	 * Create a text form
+	 * @memberof Api
+	 * @param {TextFormPr} oFormPr - text form properties
+	 * @returns {ApiTextForm}
+	 */
+	Api.prototype.CreateTextForm = function(oFormPr)
+	{
+		if (!oFormPr)
+			oFormPr = {};
+
+		let oCC = CreateCommonForm(oFormPr);
+
+		let oPr = new AscCommon.CSdtTextFormPr();
+		oPr.SetComb(GetBoolParameter(oFormPr["comb"], false));
+		oPr.SetMaxCharacters(GetNumberParameter(oFormPr["maxCharacters"], -1));
+		oPr.SetMultiLine(GetBoolParameter(oFormPr["multiLine"], false));
+		oPr.SetAutoFit(GetBoolParameter(oFormPr["autoFit"], false));
+		oPr.SetWidth((GetNumberParameter(oFormPr["cellWidth"], 0) * 72 * 20 / 25.4) | 0);
+
+		oCC.ApplyTextFormPr(oPr);
+
+		return new AscBuilder.ApiTextForm(oCC);
+	};
+	/**
+	 * Create the checkbox/radiobutton form
+	 * @memberof Api
+	 * @param {CheckBoxFormPr} oFormPr - checkbox(radiobutton) form properties
+	 * @returns {ApiCheckBoxForm}
+	 */
+	Api.prototype.CreateCheckBoxForm = function(oFormPr)
+	{
+		if (!oFormPr)
+			oFormPr = {};
+
+		oFormPr["placeholder"] = undefined;
+
+		var oCC;
+		var oCheckboxPr  = new AscCommon.CSdtCheckBoxPr();
+		if (GetBoolParameter(oFormPr["radio"], false))
+		{
+			oCheckboxPr.CheckedSymbol   = 0x25C9;
+			oCheckboxPr.UncheckedSymbol = 0x25CB;
+			oCheckboxPr.GroupKey        = GetStringParameter(oFormPr["key"], "Group1");
+		}
+		else
+		{
+			oCheckboxPr.CheckedSymbol   = 0x2611;
+			oCheckboxPr.UncheckedSymbol = 0x2610;
+		}
+
+		oCheckboxPr.CheckedFont = "Segoe UI Symbol";
+		oCheckboxPr.UncheckedFont = "Segoe UI Symbol";
+
+		var nCheckedSymbol   = oCheckboxPr && oCheckboxPr.CheckedSymbol ? oCheckboxPr.CheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.CheckedSymbol;
+		var nUncheckedSymbol = oCheckboxPr && oCheckboxPr.UncheckedSymbol ? oCheckboxPr.UncheckedSymbol : Asc.c_oAscSdtCheckBoxDefaults.UncheckedSymbol;
+		var sCheckedFont     = oCheckboxPr && oCheckboxPr.CheckedFont ? oCheckboxPr.CheckedFont : Asc.c_oAscSdtCheckBoxDefaults.CheckedFont;
+		var sUncheckedFont   = oCheckboxPr && oCheckboxPr.UncheckedFont ? oCheckboxPr && oCheckboxPr.UncheckedFont : Asc.c_oAscSdtCheckBoxDefaults.UncheckedFont;
+
+		var isLoadFonts = false;
+		if (!AscCommon.IsAscFontSupport(sCheckedFont, nCheckedSymbol))
+		{
+			isLoadFonts = true;
+			AscFonts.FontPickerByCharacter.getFontBySymbol(nCheckedSymbol);
+		}
+
+		if (!AscCommon.IsAscFontSupport(sUncheckedFont, nUncheckedSymbol))
+		{
+			isLoadFonts = true;
+			AscFonts.FontPickerByCharacter.getFontBySymbol(nUncheckedSymbol);
+		}
+
+		function private_PerformAddCheckBox()
+		{
+			oCC = CreateCommonForm(oFormPr);
+			oCC.ApplyCheckBoxPr(oCheckboxPr);
+		}
+
+		if (isLoadFonts)
+		{
+			var oFonts = {};
+			oFonts[sCheckedFont]   = true;
+			oFonts[sUncheckedFont] = true;
+
+			AscCommon.Check_LoadingDataBeforePrepaste(this, oFonts, {}, private_PerformAddCheckBox);
+		}
+		else
+		{
+			private_PerformAddCheckBox();
+		}
+
+		return new AscBuilder.ApiCheckBoxForm(oCC);
+	};
+	/**
+	 * Create a combobox/dropdown form
+	 * @memberof Api
+	 * @param {ComboBoxFormPr} oFormPr - combobox form properties
+	 * @returns {ApiComboBoxForm}
+	 */
+	Api.prototype.CreateComboBoxForm = function(oFormPr)
+	{
+		if (!oFormPr)
+			oFormPr = {};
+
+		var oPr = new CSdtComboBoxPr();
+		oPr.AddItem(AscCommon.translateManager.getValue("Choose an item"), "");
+
+		var oCC = CreateCommonForm(oFormPr);
+
+		let sPlaceholder = GetStringParameter(oFormPr["placeholder"], undefined);
+
+		let arrList = GetArrayParameter(oFormPr["items"], []);
+		for (let nIndex = 0, nCount = arrList.length; nIndex < nCount; ++nIndex)
+		{
+			let oItem = arrList[nIndex];
+
+			if (GetStringParameter(oItem, null))
+			{
+				oPr.AddItem(oItem, oItem);
+			}
+			else if (GetArrayParameter(oItem, null))
+			{
+				let sDisplay = GetStringParameter(oItem[0], null);
+				let sValue   = GetStringParameter(oItem[1], null);
+				if (null !== sDisplay && null !== sValue)
+					oPr.AddItem(sDisplay, sValue);
+			}
+		}
+		oPr.SetAutoFit(GetBoolParameter(oFormPr["autoFit"], false));
+
+		if (!GetBoolParameter(oFormPr["editable"], false))
+		{
+			if (sPlaceholder)
+			{
+				oCC.ApplyDropDownListPr(oPr);
+			}
+			else
+			{
+				oCC.SetDropDownListPr(oPr);
+				oCC.SelectListItem();
+			}
+		}
+		else
+		{
+			if (sPlaceholder)
+			{
+				oCC.ApplyComboBoxPr(oPr);
+			}
+			else
+			{
+				oCC.SetComboBoxPr(oPr);
+				oCC.SelectListItem();
+			}
+		}
+
+		return new AscBuilder.ApiComboBoxForm(oCC);
+	};
+	/**
+	 * Create a picture form
+	 * @memberof Api
+	 * @param {PictureFormPr} oFormPr - picture form properties
+	 * @returns {ApiPictureForm}
+	 */
+	Api.prototype.CreatePictureForm = function(oFormPr)
+	{
+		if (!oFormPr)
+			oFormPr = {};
+
+		if (GetStringParameter("placeholder", null))
+			oFormPr["placeholder"] = AscCommon.translateManager.getValue("Click to load image");
+
+		var oCC = CreateCommonForm(oFormPr);
+		oCC.ApplyPicturePr(true);
+		oCC.ConvertFormToFixed();
+
+		let oPr = new AscCommon.CSdtPictureFormPr();
+
+		let sScale = GetStringParameter(oFormPr["scaleFlag"], undefined);
+		switch (sScale)
+		{
+			case "always": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Always); break;
+			case "never": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Never); break;
+			case "tooBig": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Bigger); break;
+			case "tooSmall": oPr.SetScaleFlag(Asc.c_oAscPictureFormScaleFlag.Smaller); break;
+		}
+
+		oPr.SetConstantProportions(GetBoolParameter(oFormPr["lockAspectRatio"], true));
+		oPr.SetRespectBorders(GetBoolParameter(oFormPr["respectBorders"], false));
+		oPr.SetShiftX(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftX"], 50))) / 100);
+		oPr.SetShiftY(Math.max(0, Math.min(100, GetNumberParameter(oFormPr["shiftY"], 50))) / 100);
+
+		oCC.SetPictureFormPr(oPr);
+
+		return new AscBuilder.ApiPictureForm(oCC);
+	};
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	// Private area
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	function CreateCommonForm(oFormPr)
+	{
+		if (!oFormPr)
+			oFormPr = {};
+		
+		var oTempFormPr = new AscCommon.CSdtFormPr();
+		oTempFormPr.SetHelpText(GetStringParameter(oFormPr["tip"], undefined));
+		oTempFormPr.SetRequired(GetBoolParameter(oFormPr["required"], false));
+		oTempFormPr.SetKey(GetStringParameter(oFormPr["key"], undefined));
+
+		var oCC = new AscCommonWord.CInlineLevelSdt();
+
+		let sPlaceHolder = GetStringParameter(oFormPr["placeholder"], undefined);
+		if (sPlaceHolder)
+			oCC.SetPlaceholderText(sPlaceHolder);
+		else
+			oCC.SetPlaceholder(c_oAscDefaultPlaceholderName.Text);
+
+		oCC.ReplaceContentWithPlaceHolder(false);
+		oCC.SetFormPr(oTempFormPr);
+		oCC.UpdatePlaceHolderTextPrForForm();
+
+		return oCC;
+	}
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	// Export
+	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+	Api.prototype["CreateTextForm"]     = Api.prototype.CreateTextForm;
+	Api.prototype["CreatePictureForm"]  = Api.prototype.CreatePictureForm;
+	Api.prototype["CreateCheckBoxForm"] = Api.prototype.CreateCheckBoxForm;	
+	Api.prototype["CreateComboBoxForm"] = Api.prototype.CreateComboBoxForm;	
+
+}(window, null));

configs/word.json

@@ -4,6 +4,7 @@
       "api.js"
     ],
     "common": [      
+	  "apiBuilder.js"
     ]
   }
 }