From 15b1f8039d0baba258c7460419fc96bf43d55081 Mon Sep 17 00:00:00 2001 From: cbmarcum Date: Fri, 19 Jun 2020 19:55:26 -0400 Subject: [PATCH] Refs #3 - doc update --- docs/index.adoc | 29 ++++++++++++++++------------- docs/index.html | 32 +++++++++++++++----------------- 2 files changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/index.adoc b/docs/index.adoc index 77044ee..4aa5860 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -5,27 +5,24 @@ == Introduction -UNO stands for Universal Network Objects and is the base component technology for Apache OpenOffice. +*UNO* stands for *Universal Network Objects* and is the base component technology for **Apache OpenOffice**. -GUNO stands for Groovy UNO and is an Apache Groovy language extension of the Java UNO API's. The artifact of this extension is a Java jar file that when used in a Groovy script or class adds convenience methods to the regular Java UNO API's. +*GUNO* stands for *Groovy UNO* and is an *Apache Groovy* language extension of the **Java UNO API's**. The artifact of this extension is a Java jar file that when used in a Groovy script or class adds convenience methods to the regular Java UNO API's. -The goal of the Groovy UNO Extension is to allow UNO programming that is less verbose than using the Java UNO API's alone. +*The goal of the Groovy UNO Extension is to allow UNO programming that is less verbose than using the Java UNO API's alone.* -These methods are implemented using Groovy Extension Modules. An extension module allows you to add new methods to existing classes, including classes which are precompiled, like classes from the JDK or in this case Java UNO classes. These new methods, unlike those defined through a metaclass or using a category, are available globally. +These methods are implemented using **Groovy Extension Modules**. An extension module allows you to **add new methods to existing classes**, including classes which are precompiled, like classes from the JDK or in this case Java UNO classes. These new methods, unlike those defined through a metaclass or using a category, are available globally. Aside from a few general methods, initial efforts have been on enhancing the spreadsheet API's and future work will be on enhancing the other applications. == Usage -:author: Carl Marcum -:email: carl.marcum@codebuilders.net -:toc: left -=== Preface The best way to explain the differences between the Java UNO API's and using Groovy with and without the extension is with some example code. Many of the examples are spreadsheet examples are from SCalc.java that is included with the AOO SDK. === Get an XComponentLoader -Java way (assumes XComponentContext xComponentContext reference) +*Java Example* (assumes XComponentContext xComponentContext reference) + [source,java] ---- XMultiComponentFactory mxRemoteServiceManager = null @@ -36,23 +33,29 @@ XMultiComponentFactory mxRemoteServiceManager = null "com.sun.star.frame.Desktop", self)) ---- -Groovy Extension way +*Groovy Extension Example* + [source,java] ---- XComponentLoader aLoader = mxRemoteContext.componentLoader ---- === UnoRuntime.queryInterface + The UnoRuntime.queryInterface(ReturnObject.class, FromObject) method can be replaced with the new FromObject.guno(ReturnObject.class) method. -Java way (assumes we have a reference to XSpreadsheetDocument myDoc..) -[source,] + +*Java Example* (assumes we have a reference to XSpreadsheetDocument myDoc..) + +[source,java] ---- XSpreadsheets xSheets = myDoc.getSheets() ; XIndexAccess oIndexSheets = (XIndexAccess) UnoRuntime.queryInterface(XIndexAccess.class, xSheets); xSheet = (XSpreadsheet) UnoRuntime.queryInterface(XSpreadsheet.class, oIndexSheets.getByIndex(0)); ---- -Groovy Extension way [source,java] +*Groovy Extension Example* + +[source,java] ---- XSpreadsheets xSheets = myDoc.sheets XIndexAccess oIndexSheets = xSheets.guno(XIndexAccess.class) diff --git a/docs/index.html b/docs/index.html index 32bd868..d5dd614 100644 --- a/docs/index.html +++ b/docs/index.html @@ -450,7 +450,6 @@

GUNO Extension Documentation

  • Introduction
  • Usage @@ -463,16 +462,16 @@

    GUNO Extension Documentation

    Introduction

    -

    UNO stands for Universal Network Objects and is the base component technology for Apache OpenOffice.

    +

    UNO stands for Universal Network Objects and is the base component technology for Apache OpenOffice.

    -

    GUNO stands for Groovy UNO and is an Apache Groovy language extension of the Java UNO API’s. The artifact of this extension is a Java jar file that when used in a Groovy script or class adds convenience methods to the regular Java UNO API’s.

    +

    GUNO stands for Groovy UNO and is an Apache Groovy language extension of the Java UNO API’s. The artifact of this extension is a Java jar file that when used in a Groovy script or class adds convenience methods to the regular Java UNO API’s.

    -

    The goal of the Groovy UNO Extension is to allow UNO programming that is less verbose than using the Java UNO API’s alone.

    +

    The goal of the Groovy UNO Extension is to allow UNO programming that is less verbose than using the Java UNO API’s alone.

    -

    These methods are implemented using Groovy Extension Modules. An extension module allows you to add new methods to existing classes, including classes which are precompiled, like classes from the JDK or in this case Java UNO classes. These new methods, unlike those defined through a metaclass or using a category, are available globally.

    +

    These methods are implemented using Groovy Extension Modules. An extension module allows you to add new methods to existing classes, including classes which are precompiled, like classes from the JDK or in this case Java UNO classes. These new methods, unlike those defined through a metaclass or using a category, are available globally.

    Aside from a few general methods, initial efforts have been on enhancing the spreadsheet API’s and future work will be on enhancing the other applications.

    @@ -482,16 +481,13 @@

    Introdu

    Usage

    -
    -

    Preface

    The best way to explain the differences between the Java UNO API’s and using Groovy with and without the extension is with some example code. Many of the examples are spreadsheet examples are from SCalc.java that is included with the AOO SDK.

    -

    Get an XComponentLoader

    -

    Java way (assumes XComponentContext xComponentContext reference)

    +

    Java Example (assumes XComponentContext xComponentContext reference)

    @@ -504,7 +500,7 @@

    -

    Groovy Extension way

    +

    Groovy Extension Example

    @@ -515,24 +511,26 @@

    UnoRuntime.queryInterface

    -

    The UnoRuntime.queryInterface(ReturnObject.class, FromObject) method can be replaced with the new FromObject.guno(ReturnObject.class) method. -Java way (assumes we have a reference to XSpreadsheetDocument myDoc..)

    +

    The UnoRuntime.queryInterface(ReturnObject.class, FromObject) method can be replaced with the new FromObject.guno(ReturnObject.class) method.

    +
    +
    +

    Java Example (assumes we have a reference to XSpreadsheetDocument myDoc..)

    -
    XSpreadsheets xSheets = myDoc.getSheets() ;
+
    XSpreadsheets xSheets = myDoc.getSheets() ;
 XIndexAccess oIndexSheets = (XIndexAccess) UnoRuntime.queryInterface(XIndexAccess.class, xSheets);
 xSheet = (XSpreadsheet) UnoRuntime.queryInterface(XSpreadsheet.class, oIndexSheets.getByIndex(0));
    -

    Groovy Extension way [source,java]

    +

    Groovy Extension Example

    -
    XSpreadsheets xSheets = myDoc.sheets
+
    XSpreadsheets xSheets = myDoc.sheets
 XIndexAccess oIndexSheets = xSheets.guno(XIndexAccess.class)
-xSheet = oIndexSheets.getByIndex(0).guno(XSpreadsheet.class)
    
+xSheet = oIndexSheets.getByIndex(0).guno(XSpreadsheet.class)

    @@ -541,7 +539,7 @@

    -Last updated 2020-06-19 19:37:37 -0400 +Last updated 2020-06-19 19:54:51 -0400