summaryrefslogtreecommitdiffstats
path: root/scripting/examples/javascript
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--scripting/examples/javascript/ExportSheetsToHTML/exportsheetstohtml.js88
-rw-r--r--scripting/examples/javascript/ExportSheetsToHTML/parcel-descriptor.xml32
-rw-r--r--scripting/examples/javascript/HelloWorld/helloworld.js33
-rw-r--r--scripting/examples/javascript/HelloWorld/parcel-descriptor.xml32
-rw-r--r--scripting/examples/javascript/Highlight/ButtonPressHandler.js122
-rw-r--r--scripting/examples/javascript/Highlight/ShowDialog.js131
-rw-r--r--scripting/examples/javascript/Highlight/parcel-descriptor.xml41
7 files changed, 479 insertions, 0 deletions
diff --git a/scripting/examples/javascript/ExportSheetsToHTML/exportsheetstohtml.js b/scripting/examples/javascript/ExportSheetsToHTML/exportsheetstohtml.js
new file mode 100644
index 000000000..37f9e5afb
--- /dev/null
+++ b/scripting/examples/javascript/ExportSheetsToHTML/exportsheetstohtml.js
@@ -0,0 +1,88 @@
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+ */
+// When this script is run on an existing, saved, spreadsheet,
+// eg. /home/testuser/myspreadsheet.sxc, the script will export
+// each sheet to a separate html file,
+// eg. /home/testuser/myspreadsheet_sheet1.html,
+// /home/testuser/myspreadsheet_sheet2.html etc
+importClass(Packages.com.sun.star.uno.UnoRuntime);
+importClass(Packages.com.sun.star.sheet.XSpreadsheetDocument);
+importClass(Packages.com.sun.star.container.XIndexAccess);
+importClass(Packages.com.sun.star.beans.XPropertySet);
+importClass(Packages.com.sun.star.beans.PropertyValue);
+importClass(Packages.com.sun.star.util.XModifiable);
+importClass(Packages.com.sun.star.frame.XStorable);
+importClass(Packages.com.sun.star.frame.XModel);
+importClass(Packages.com.sun.star.uno.AnyConverter);
+importClass(Packages.com.sun.star.uno.Type);
+
+importClass(java.lang.System);
+
+//get the document object from the scripting context
+oDoc = XSCRIPTCONTEXT.getDocument();
+//get the XSpreadsheetDocument interface from the document
+xSDoc = UnoRuntime.queryInterface(XSpreadsheetDocument, oDoc);
+//get the XModel interface from the document
+xModel = UnoRuntime.queryInterface(XModel,oDoc);
+//get the XIndexAccess interface used to access each sheet
+xSheetsIndexAccess = UnoRuntime.queryInterface(XIndexAccess, xSDoc.getSheets());
+//get the XStorable interface used to save the document
+xStorable = UnoRuntime.queryInterface(XStorable,xSDoc);
+//get the XModifiable interface used to indicate if the document has been
+//changed
+xModifiable = UnoRuntime.queryInterface(XModifiable,xSDoc);
+
+//set up an array of PropertyValue objects used to save each sheet in the
+//document
+storeProps = new Array;//PropertyValue[1];
+storeProps[0] = new PropertyValue();
+storeProps[0].Name = "FilterName";
+storeProps[0].Value = "HTML (StarCalc)";
+storeUrl = xModel.getURL();
+storeUrl = storeUrl.substring(0,storeUrl.lastIndexOf('.'));
+
+//set only one sheet visible, and store to HTML doc
+for(var i=0;i<xSheetsIndexAccess.getCount();i++)
+{
+ setAllButOneHidden(xSheetsIndexAccess,i);
+ xModifiable.setModified(false);
+ xStorable.storeToURL(storeUrl+"_sheet"+(i+1)+".html", storeProps);
+}
+
+// now set all visible again
+for(var i=0;i<xSheetsIndexAccess.getCount();i++)
+{
+ xPropSet = AnyConverter.toObject( new Type(XPropertySet), xSheetsIndexAccess.getByIndex(i));
+ xPropSet.setPropertyValue("IsVisible", true);
+}
+
+function setAllButOneHidden(xSheetsIndexAccess,vis) {
+ //System.err.println("count="+xSheetsIndexAccess.getCount());
+ //get an XPropertySet interface for the vis-th sheet
+ xPropSet = AnyConverter.toObject( new Type(XPropertySet), xSheetsIndexAccess.getByIndex(vis));
+ //set the vis-th sheet to be visible
+ xPropSet.setPropertyValue("IsVisible", true);
+ // set all other sheets to be invisible
+ for(var i=0;i<xSheetsIndexAccess.getCount();i++)
+ {
+ xPropSet = AnyConverter.toObject( new Type(XPropertySet), xSheetsIndexAccess.getByIndex(i));
+ if(i!=vis) {
+ xPropSet.setPropertyValue("IsVisible", false);
+ }
+ }
+}
diff --git a/scripting/examples/javascript/ExportSheetsToHTML/parcel-descriptor.xml b/scripting/examples/javascript/ExportSheetsToHTML/parcel-descriptor.xml
new file mode 100644
index 000000000..be8880ab0
--- /dev/null
+++ b/scripting/examples/javascript/ExportSheetsToHTML/parcel-descriptor.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+-->
+<parcel language="JavaScript" xmlns:parcel="scripting.dtd">
+
+ <script language="JavaScript">
+ <locale lang="en">
+ <displayname value="ExportSheetsToHTML"/>
+ <description>
+ Saves each sheet in the current Calc document as a separate HTML file in the same directory as the original Calc document.
+ </description>
+ </locale>
+ <functionname value="exportsheetstohtml.js"/>
+ <logicalname value="ExportSheetsToHTML.JavaScript"/>
+ </script>
+
+</parcel>
diff --git a/scripting/examples/javascript/HelloWorld/helloworld.js b/scripting/examples/javascript/HelloWorld/helloworld.js
new file mode 100644
index 000000000..f04fdfd8a
--- /dev/null
+++ b/scripting/examples/javascript/HelloWorld/helloworld.js
@@ -0,0 +1,33 @@
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+ */
+// Hello World in JavaScript
+importClass(Packages.com.sun.star.uno.UnoRuntime);
+importClass(Packages.com.sun.star.text.XTextDocument);
+importClass(Packages.com.sun.star.text.XText);
+importClass(Packages.com.sun.star.text.XTextRange);
+
+//get the document from the scripting context
+oDoc = XSCRIPTCONTEXT.getDocument();
+//get the XTextDocument interface
+xTextDoc = UnoRuntime.queryInterface(XTextDocument,oDoc);
+//get the XText interface
+xText = xTextDoc.getText();
+//get an (empty) XTextRange interface at the end of the text
+xTextRange = xText.getEnd();
+//set the text in the XTextRange
+xTextRange.setString( "Hello World (in JavaScript)" );
diff --git a/scripting/examples/javascript/HelloWorld/parcel-descriptor.xml b/scripting/examples/javascript/HelloWorld/parcel-descriptor.xml
new file mode 100644
index 000000000..65ea9fd75
--- /dev/null
+++ b/scripting/examples/javascript/HelloWorld/parcel-descriptor.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+-->
+<parcel language="JavaScript" xmlns:parcel="scripting.dtd">
+
+ <script language="JavaScript">
+ <locale lang="en">
+ <displayname value="Hello World"/>
+ <description>
+ Adds the string "Hello World" into the current text doc.
+ </description>
+ </locale>
+ <functionname value="helloworld.js"/>
+ <logicalname value="HelloWorld.JavaScript"/>
+ </script>
+
+</parcel>
diff --git a/scripting/examples/javascript/Highlight/ButtonPressHandler.js b/scripting/examples/javascript/Highlight/ButtonPressHandler.js
new file mode 100644
index 000000000..e0fbde240
--- /dev/null
+++ b/scripting/examples/javascript/Highlight/ButtonPressHandler.js
@@ -0,0 +1,122 @@
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+ */
+//this script acts as a handler for the buttons in the Highlight dialog
+importClass(Packages.com.sun.star.uno.UnoRuntime);
+importClass(Packages.com.sun.star.uno.Type);
+importClass(Packages.com.sun.star.uno.AnyConverter);
+
+importClass(Packages.com.sun.star.awt.XButton);
+importClass(Packages.com.sun.star.awt.XControl);
+importClass(Packages.com.sun.star.awt.ActionEvent);
+importClass(Packages.com.sun.star.awt.XControlModel);
+importClass(Packages.com.sun.star.awt.XControlContainer);
+importClass(Packages.com.sun.star.awt.XDialog);
+importClass(Packages.com.sun.star.awt.XTextComponent);
+
+importClass(Packages.com.sun.star.util.XReplaceable);
+importClass(Packages.com.sun.star.util.XReplaceDescriptor);
+importClass(Packages.com.sun.star.util.XPropertyReplace);
+
+importClass(Packages.com.sun.star.beans.XPropertySet);
+importClass(Packages.com.sun.star.beans.PropertyValue);
+
+// Scripting Framework DialogFactory class
+importClass(Packages.com.sun.star.script.framework.browse.DialogFactory);
+
+// Get the ActionEvent object from the ARGUMENTS list
+event = ARGUMENTS[0];
+
+// Each argument is of type Any so we must use the AnyConverter class to
+// convert it into the interface or primitive type we expect
+button = AnyConverter.toObject(new Type(XButton), event.Source);
+
+// We can now query for the model of the button and get its properties
+control = UnoRuntime.queryInterface(XControl, button);
+cmodel = control.getModel();
+pset = UnoRuntime.queryInterface(XPropertySet, cmodel);
+
+if (pset.getPropertyValue("Label").equals("Exit"))
+{
+ // We can get the XDialog in which this control appears by calling
+ // getContext() on the XControl interface
+ xDialog = UnoRuntime.queryInterface(
+ XDialog, control.getContext());
+
+ // Close the dialog
+ xDialog.endExecute();
+}
+else
+{
+ // We can get the list of controls for this dialog by calling
+ // getContext() on the XControl interface of the button
+ controls = UnoRuntime.queryInterface(
+ XControlContainer, control.getContext());
+
+ // Now get the text field control from the list
+ textField =
+ UnoRuntime.queryInterface(
+ XTextComponent, controls.getControl("HighlightTextField"));
+
+ searchKey = textField.getText();
+
+ // highlight the text in red
+ red = java.awt.Color.red.getRGB();
+
+ replaceable =
+ UnoRuntime.queryInterface(XReplaceable, XSCRIPTCONTEXT.getDocument());
+
+ descriptor = replaceable.createReplaceDescriptor();
+
+ // Gets a XPropertyReplace object for altering the properties
+ // of the replaced text
+ xPropertyReplace = UnoRuntime.queryInterface(XPropertyReplace, descriptor);
+
+ // Sets the replaced text property fontweight value to Bold
+ wv = new PropertyValue("CharWeight", -1,
+ new java.lang.Float(Packages.com.sun.star.awt.FontWeight.BOLD),
+ Packages.com.sun.star.beans.PropertyState.DIRECT_VALUE);
+
+ // Sets the replaced text property color value to RGB parameter
+ cv = new PropertyValue("CharColor", -1,
+ new java.lang.Integer(red),
+ Packages.com.sun.star.beans.PropertyState.DIRECT_VALUE);
+
+ // Apply the properties
+ props = new Array;
+ props[0] = cv;
+ props[1] = wv;
+
+ try {
+ xPropertyReplace.setReplaceAttributes(props);
+
+ // Only matches whole words and case sensitive
+ descriptor.setPropertyValue(
+ "SearchCaseSensitive", new java.lang.Boolean(true));
+ descriptor.setPropertyValue("SearchWords", new java.lang.Boolean(true));
+
+ // Replaces all instances of searchKey with new Text properties
+ // and gets the number of instances of the searchKey
+ descriptor.setSearchString(searchKey);
+ descriptor.setReplaceString(searchKey);
+ replaceable.replaceAll(descriptor);
+ }
+ catch (e) {
+ java.lang.System.err.println("Error setting up search properties"
+ + e.getMessage());
+ }
+}
diff --git a/scripting/examples/javascript/Highlight/ShowDialog.js b/scripting/examples/javascript/Highlight/ShowDialog.js
new file mode 100644
index 000000000..d659d9622
--- /dev/null
+++ b/scripting/examples/javascript/Highlight/ShowDialog.js
@@ -0,0 +1,131 @@
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+ */
+importClass(Packages.com.sun.star.uno.UnoRuntime);
+importClass(Packages.com.sun.star.lang.XMultiComponentFactory);
+importClass(Packages.com.sun.star.awt.XDialogProvider);
+importClass(Packages.com.sun.star.awt.XDialog);
+importClass(Packages.com.sun.star.uno.Exception);
+importClass(Packages.com.sun.star.script.provider.XScriptContext);
+
+importClass(java.lang.Thread);
+importClass(java.lang.System);
+
+function tryLoadingLibrary( xmcf, context, name )
+{
+ try
+ {
+ obj = xmcf.createInstanceWithContext(
+ "com.sun.star.script.Application" + name + "LibraryContainer",
+ context.getComponentContext());
+
+ xLibraryContainer = UnoRuntime.queryInterface(XLibraryContainer, obj);
+
+ System.err.println("Got XLibraryContainer");
+
+ serviceObj = context.getComponentContext().getValueByName(
+ "/singletons/com.sun.star.util.theMacroExpander");
+
+ xme = AnyConverter.toObject(new Type(XMacroExpander), serviceObj);
+
+ bootstrapName = "bootstraprc";
+ if (System.getProperty("os.name").startsWith("Windows"))
+ {
+ bootstrapName = "bootstrap.ini";
+ }
+
+ libURL = xme.expandMacros(
+ "$BRAND_BASE_DIR/$BRAND_SHARE_SUBDIR/basic/ScriptBindingLibrary/" +
+ name.toLowerCase() + ".xlb/");
+
+ System.err.println("libURL is: " + libURL);
+
+ xLibraryContainer.createLibraryLink(
+ "ScriptBindingLibrary", libURL, false);
+
+ System.err.println("liblink created");
+
+ }
+ catch (e)
+ {
+ System.err.println("Got an exception loading lib: " + e.getMessage());
+ return false;
+ }
+ return true;
+}
+
+function getDialogProvider()
+{
+ // UNO awt components of the Highlight dialog
+ //get the XMultiServiceFactory
+ xmcf = XSCRIPTCONTEXT.getComponentContext().getServiceManager();
+
+ args = new Array;
+ //get the XDocument from the context
+ args[0] = XSCRIPTCONTEXT.getDocument();
+
+ //try to create the DialogProvider
+ try {
+ obj = xmcf.createInstanceWithArgumentsAndContext(
+ "com.sun.star.awt.DialogProvider", args,
+ XSCRIPTCONTEXT.getComponentContext());
+ }
+ catch (e) {
+ System.err.println("Error getting DialogProvider object");
+ return null;
+ }
+
+ return UnoRuntime.queryInterface(XDialogProvider, obj);
+}
+
+//get the DialogProvider
+xDialogProvider = getDialogProvider();
+
+if (xDialogProvider != null)
+{
+ //try to create the Highlight dialog (found in the ScriptBinding library)
+ try
+ {
+ findDialog = xDialogProvider.createDialog("vnd.sun.star.script:" +
+ "ScriptBindingLibrary.Highlight?location=application");
+ if( findDialog == null )
+ {
+ if (tryLoadingLibrary(xmcf, XSCRIPTCONTEXT, "Dialog") == false ||
+ tryLoadingLibrary(xmcf, XSCRIPTCONTEXT, "Script") == false)
+ {
+ System.err.println("Error loading ScriptBindingLibrary");
+ }
+ else
+ {
+ // try to create the Highlight dialog (found in the
+ // ScriptBindingLibrary)
+ findDialog = xDialogProvider.createDialog("vnd.sun.star.script:" +
+ "ScriptBindingLibrary.Highlight?location=application");
+ }
+ }
+
+ //launch the dialog
+ if ( findDialog != null )
+ {
+ findDialog.execute();
+ }
+ }
+ catch (e) {
+ System.err.println("Got exception on first creating dialog: " +
+ e.getMessage());
+ }
+}
diff --git a/scripting/examples/javascript/Highlight/parcel-descriptor.xml b/scripting/examples/javascript/Highlight/parcel-descriptor.xml
new file mode 100644
index 000000000..e6d6bb7b1
--- /dev/null
+++ b/scripting/examples/javascript/Highlight/parcel-descriptor.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * 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
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF 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 .
+-->
+<parcel language="JavaScript" xmlns:parcel="scripting.dtd">
+ <script language="JavaScript">
+ <locale lang="en">
+ <displayname value="ShowDialog" />
+ <description>
+ Example of how to show a dialog from JavaScript
+ </description>
+ </locale>
+ <functionname value="ShowDialog.js" />
+ <logicalname value="ShowDialog.JavaScript" />
+ </script>
+ <script language="JavaScript">
+ <locale lang="en">
+ <displayname value="ButtonPressHandler" />
+ <description>
+ Example of handle button press events for the Dialog
+ </description>
+ </locale>
+ <functionname value="ButtonPressHandler.js" />
+ <logicalname value="ButtonPressHandler.JavaScript" />
+ </script>
+</parcel>
+