diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
commit | 940b4d1848e8c70ab7642901a68594e8016caffc (patch) | |
tree | eb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /odk/examples/DevelopersGuide/ScriptingFramework/SayHello | |
parent | Initial commit. (diff) | |
download | libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.tar.xz libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.zip |
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'odk/examples/DevelopersGuide/ScriptingFramework/SayHello')
6 files changed, 327 insertions, 0 deletions
diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/META-INF/manifest.xml b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/META-INF/manifest.xml new file mode 100644 index 000000000..e7bf06b4e --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/META-INF/manifest.xml @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE manifest:manifest PUBLIC "-//OpenOffice.org//DTD Manifest 1.0//EN" "Manifest.dtd"> +<manifest:manifest xmlns:manifest="http://openoffice.org/2001/manifest"> + <manifest:file-entry manifest:media-type="application/vnd.sun.star.framework-script" manifest:full-path="SayHello"/> +</manifest:manifest> diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/Makefile b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/Makefile new file mode 100644 index 000000000..0df943224 --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/Makefile @@ -0,0 +1,128 @@ +#************************************************************************* +# +# The Contents of this file are made available subject to the terms of +# the BSD license. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of Sun Microsystems, Inc. nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR +# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE +# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +#************************************************************************** + +# Builds the OOoBean of the Developers Guide + +PRJ=../../../.. +SETTINGS=$(PRJ)/settings + +include $(SETTINGS)/settings.mk +include $(SETTINGS)/std.mk + +# Define non-platform/compiler specific settings +SAMPLE_NAME=SayHello +SAMPLE_CLASS_OUT = $(OUT_CLASS)/ScriptingFramework/$(SAMPLE_NAME) +SAMPLE_GEN_OUT = $(OUT_MISC)/ScriptingFramework + +SCRIPT_NAME=SayHello +SCRIPT_CLASS_OUT=$(SAMPLE_CLASS_OUT)/$(SCRIPT_NAME) +SCRIPT_GEN_OUT=$(SAMPLE_GEN_OUT)/$(SCRIPT_NAME) +SCRIPT_JAR_NAME=$(SCRIPT_NAME).jar +SCRIPT_JAR=$(SAMPLE_CLASS_OUT)/$(SCRIPT_JAR_NAME) +SCRIPT_PACKAGE = $(OUT_BIN)/$(SCRIPT_NAME).$(UNOOXT_EXT) +SCRIPT_PACKAGE_URL = $(subst \\,\,"$(COMP_PACKAGE_DIR)$(PS)$(SCRIPT_NAME).$(UNOOXT_EXT)") +SCRIPT_REGISTERFLAG=$(SCRIPT_GEN_OUT)$(PS)devguide_scriptingframework_$(SCRIPT_NAME)_register_scriptpkg.flag + +JAVAFILES = \ + SayHello/SayHello.java + +CLASSFILES = $(patsubst %.java,$(SCRIPT_CLASS_OUT)/%.class,$(subst $(SAMPLE_NAME)/,,$(JAVAFILES))) + +SDK_CLASSPATH = $(subst $(EMPTYSTRING) $(PATH_SEPARATOR),$(PATH_SEPARATOR),$(CLASSPATH)\ + $(PATH_SEPARATOR)$(SAMPLE_CLASS_OUT)) + +# Targets +.PHONY: ALL +ALL : \ + SayHelloExample + +include $(SETTINGS)/stdtarget.mk + +$(CLASSFILES) : $(JAVAFILES) + -$(MKDIR) $(subst /,$(PS),$(@D)) + $(SDK_JAVAC) $(JAVAC_FLAGS) -classpath "$(SDK_CLASSPATH)" -d $(SCRIPT_CLASS_OUT) $(JAVAFILES) + +$(SCRIPT_JAR) : $(CLASSFILES) + -$(DEL) $(subst \\,\,$(subst /,$(PS),$@)) + -$(MKDIR) $(subst /,$(PS),$(@D)) + $(SDK_JAR) cvf $@ $(CLASSNAMES) -C $(SCRIPT_CLASS_OUT) . + +# rule for component package file +$(SCRIPT_PACKAGE) : $(SCRIPT_JAR) META-INF/manifest.xml $(SCRIPT_NAME)/parcel-descriptor.xml + -$(DEL) $(subst \\,\,$(subst /,$(PS),$@)) + -$(MKDIR) $(subst /,$(PS),$(@D)) + $(SDK_ZIP) $@ META-INF/manifest.xml $(SCRIPT_NAME)/parcel-descriptor.xml + cd $(subst /,$(PS),$(SAMPLE_CLASS_OUT)/..) && $(SDK_ZIP) -u ../../bin/$(@F) $(SAMPLE_NAME)/$(SCRIPT_JAR_NAME) + +$(SCRIPT_REGISTERFLAG) : $(SCRIPT_PACKAGE) +ifeq "$(SDK_AUTO_DEPLOYMENT)" "YES" + -$(DEL) $(subst \\,\,$(subst /,$(PS),$@)) + -$(MKDIR) $(subst /,$(PS),$(@D)) + $(DEPLOYTOOL) $(SCRIPT_PACKAGE_URL) + @echo flagged > $(subst /,$(PS),$@) +else + @echo -------------------------------------------------------------------------------- + @echo If you want to install your component automatically, please set the environment + @echo variable SDK_AUTO_DEPLOYMENT = YES. But note that auto deployment is only + @echo possible if no office instance is running. + @echo -------------------------------------------------------------------------------- +endif + + +SayHelloExample : $(SCRIPT_REGISTERFLAG) + @echo -------------------------------------------------------------------------------- + @echo The "$(QM)$(SCRIPT_NAME)$(QM)" scripting package was installed in your office installation + @echo if SDK_AUTO_DEPLOYMENT = YES. If you want to run the script, start the Office + @echo and use the Tools/Macros/Run Macro menu item. + @echo You can also load the document "$(QM)$(SCRIPT_NAME).odt$(QM)" and press the button to run the + @echo script. + @echo - + @echo $(MAKE) $(SCRIPT_NAME).odt.load + @echo -------------------------------------------------------------------------------- + +$(SCRIPT_NAME).odt.load : $(SCRIPT_REGISTERFLAG) + "$(OFFICE_PROGRAM_PATH)$(PS)soffice" $(basename $@) + +%.run: $(CLASSFILES) + $(SDK_JAVA) -classpath "$(SDK_CLASSPATH)" $(subst /,.,$(PACKAGE)).$(basename $@) + +%.dbg: $(JAR1_JAR) + jdb -classpath "$(SDK_CLASSPATH)" $(subst /,.,$(PACKAGE)).$(basename $@) + +.PHONY: clean +clean : + -$(DELRECURSIVE) $(subst /,$(PS),$(SAMPLE_CLASS_OUT)) + -$(DELRECURSIVE) $(subst /,$(PS),$(SCRIPT_GEN_OUT)) + -$(DEL) $(subst \\,\,$(subst /,$(PS),$(SCRIPT_PACKAGE_URL))) + diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello.odt b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello.odt Binary files differnew file mode 100644 index 000000000..e18331915 --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello.odt diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/SayHello.java b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/SayHello.java new file mode 100644 index 000000000..22fd05188 --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/SayHello.java @@ -0,0 +1,65 @@ +/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * 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 . + */ + +import com.sun.star.script.provider.XScriptContext; + +import com.sun.star.uno.UnoRuntime; +import com.sun.star.frame.XComponentLoader; +import com.sun.star.lang.XComponent; +import com.sun.star.text.XTextDocument; +import com.sun.star.text.XTextRange; +import com.sun.star.text.XText; +import com.sun.star.beans.PropertyValue; +import com.sun.star.awt.ActionEvent; + +public class SayHello +{ + public static void start(XScriptContext ctxt, ActionEvent e) + throws Exception + { + SayHello.start(ctxt); + } + + public static void start(XScriptContext ctxt) + throws Exception + { + // getting the text document object + XTextDocument xTextDocument = createDocument(ctxt); + + XText xText = xTextDocument.getText(); + XTextRange xTextRange = xText.getEnd(); + xTextRange.setString("Hello"); + } + + private static XTextDocument createDocument(XScriptContext ctxt) + throws Exception + { + XComponentLoader loader = UnoRuntime.queryInterface( + XComponentLoader.class, ctxt.getDesktop()); + + XComponent comp = loader.loadComponentFromURL( + "private:factory/swriter", "_blank", 4, new PropertyValue[0]); + + XTextDocument doc = UnoRuntime.queryInterface( XTextDocument.class, comp); + + return doc; + } +} + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/parcel-descriptor.xml b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/parcel-descriptor.xml new file mode 100644 index 000000000..f1c395a3f --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/SayHello/parcel-descriptor.xml @@ -0,0 +1,33 @@ +<?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="Java" xmlns:parcel="scripting.dtd"> + <script language="Java"> + <locale lang="en"> + <displayname value="SayHello"/> + <description> + Prints Hello in a Writer document + </description> + </locale> + <functionname value="SayHello.start"/> + <logicalname value="SayHello.start"/> + <languagedepprops> + <prop name="classpath" value="SayHello.jar"/> + </languagedepprops> + </script> +</parcel> diff --git a/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/build.xml b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/build.xml new file mode 100644 index 000000000..b79ac64ae --- /dev/null +++ b/odk/examples/DevelopersGuide/ScriptingFramework/SayHello/build.xml @@ -0,0 +1,96 @@ +<?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 . +--> +<project default="build"> + + <!-- =================== Global Properties ============================= --> + <property environment="env"/> + <property name="macroname" value="SayHello"/> + <property name="unopkgfile" value="${basedir}/${macroname}.uno.pkg"/> + + <!-- ==================== initialise properties ========================= --> + <target name="checksdk"> + <condition property="UsingSDK"> + <available file="${env.OFFICE_PROGRAM_PATH}"/> + </condition> + </target> + + <target name="initsdk" if="UsingSDK"> + <property name="opp" value="${env.OFFICE_PROGRAM_PATH}"/> + </target> + + <target name="initnosdk" unless="UsingSDK"> + <fail unless="opp" message="Path to Office install not set"/> + </target> + + <!-- ==================== classpath setting ============================ --> + <target name="init" depends="checksdk,initsdk,initnosdk"> + <path id="scriptclasspath"> + <pathelement location="${opp}/classes/libreoffice.jar"/> + <pathelement location="${opp}/classes/ScriptFramework.jar"/> + </path> + </target> + + <!-- ====================== Clean Generated Files ===================== --> + <target name="clean"> + <delete> + <fileset dir="."> + <include name="**/*.class"/> + <include name="**/*.jar"/> + <include name="**/*.uno.pkg"/> + </fileset> + </delete> + </target> + + <!-- ===================== Compile the script ========================= --> + <target name="compile" depends="init"> + <javac srcdir="${macroname}" destdir="${macroname}" + includes="**/*.java" classpathref="scriptclasspath" + debug="on" optimize="on" deprecation="on"/> + </target> + + <!-- ====================== Build UNO Package ========================= --> + <target name="build" depends="compile"> + <delete file="${unopkgfile}"/> + + <jar jarfile="${macroname}/${macroname}.jar" + basedir="${macroname}" includes="*.class,*.gif"> + </jar> + + <zip zipfile="${unopkgfile}"> + <fileset dir="${basedir}"> + <include name="**/*.jar"/> + <include name="**/parcel-descriptor.xml"/> + <include name="**/manifest.xml"/> + </fileset> + </zip> + </target> + + <!-- ====================== Deploy Generated Files ==================== --> + <target name="deploy" depends="build"> + <exec executable="${opp}/unopkg"> + <arg line="add"/> + <arg line="--force"/> + <arg path="${unopkgfile}"/> + </exec> + </target> + + <!-- ========================= All In One Build ======================= --> + <target name="all" depends="clean,build,deploy"/> + +</project> |