Google Git
Sign in
apache / openoffice / bab44dcac0296df22024f3f10e7997de78ed4094 / . / AOO410 / main / odk / examples / DevelopersGuide / examples.html
blob: 5decee1a6ad3d05a45bda8ead6b6f601061b390c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
#**************************************************************
#
# 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
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
#**************************************************************
-->
<html>
<head>
<title>OpenOffice.org %PRODUCT_RELEASE% SDK - Developer's Guide Examples</title>
<link rel="stylesheet" type="text/css"
href="../../docs/sdk_styles.css">
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="author" content="J&uuml;rgen Schmidt">
<meta name="created" content="2004-12-14">
</head>
<body class="sdkbody">
<a name="examples"></a>
<table class="table1" cellpadding="0">
<tbody>
<tr style="background-image:url(../../docs/images/sdk_head-2.png); backgorund-position: bottom; ">
<td class="background" colspan="3" align="left"><img src="../../docs/images/sdk_head-1.png" width="800" height="120" usemap="#Map" border="0"></td>
</tr>
<tr>
<td colspan="3"><img class="nothing10"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td colspan="3"><img class="nothing1"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1">Developer's Guide
Examples</td>
<td align="right"> <a href="../examples.html"
title="link to the examples overview"><img class="navigate"
src="../../docs/images/nav_left.png"></a> <a href="../../index.html"
title="link to the SDK start page"><img class="navigate"
src="../../docs/images/nav_home.png"></a></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="3">
<p>The <a
href="http://doc.services.openoffice.org/wiki/index.php/Documentation/DevGuide/OpenOffice.org_Developers_Guide"
title="link to the Developer's Guide in the Wiki">Developer's Guide</a>
comes with a wide range of examples from all application areas which
shows the use of the API in the context of the different functional
areas. Furthermore the examples can be used as a first starting point
to modify an existing example to their own needs.</p>
<p>Some fo the examples need a running office
instance listening on a port. If this is necessary you will get further
information in the makefiles.</p>
<p>All examples marked with a <img
src="../../docs/images/bluball.gif"> are executable and be started
using a run target in the makefile. The name of the binary (C++) can
differ compared to the source file, please see the run target in the
appropriate makefile. Some of the examples which create a component
have no run target. In these cases a document is provided which
instantiates and runs the component (see the makefile output). Also the
Basic examples provide documents which use and shows the implemented
functionality. The database and forms examples need a running database,
please see the description below. But note that is not described in
detail how to create a working data source (see the office help).</p>
</td>
</tr>
<tr>
<td><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table3">
<tbody>
<tr valign="top">
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#FirstSteps"
title="link to the First Steps examples">First Steps</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#ProfessionalUNO"
title="link to the Professional UNO examples">Professional UNO</a></td>
<td class="content10"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Components"
title="link to the Components examples">Writing UNO components</a></td>
</tr>
<tr valign="top">
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#OfficeDevelopment"
title="link to the Office Development examples">Office Development</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Text" title="link to the Text examples">Text
Documents</a></td>
<td class="content10"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Spreadsheet"
title="link to the Spreadsheet examples">Spreadsheet Documents</a></td>
</tr>
<tr valign="top">
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Drawing"
title="link to the Drawing And Presentation examples">Drawing and
Presentation Documents</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Charts"
title="link to the Charts examples">Charts</a></td>
<td class="content10"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#BasicandDialogs"
title="link to the Basic And Dialogs examples">OpenOffice.org %PRODUCT_RELEASE% Basic and
Dialogs</a></td>
</tr>
<tr valign="top">
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Database"
title="link to the Database examples">Database Access</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Forms"
title="link to the Forms examples">Forms</a></td>
<td class="content10"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#UniversalContentBroker%28UCB%29"
title="link to the Universal Content Broker examples">Universal
Content Broker (UCB)</a></td>
</tr>
<tr valign="top">
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Configuration"
title="link to the Configuration examples">Configuration Management</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#OfficeBean"
title="link to the OOoBean examples">Office Bean</a></td>
<td class="content10"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#Accessibility"
title="link to the Accessibility examples">Accessibility</a></td>
</tr>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#ScriptingFramework" title="link to the Scripting Framework examples">Scripting Framework</a></td>
<td class="content4"></td>
<td class="content3"><img
src="../../docs/images/arrow-1.gif"></td>
<td><a href="#GraphicalUserInterfaces" title="link to the Graphical UserInterfaces examples">Graphical User Interfaces</a></td>
<td class="content10"></td>
<td class="content3"></td>
<td></td>
<tr>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="FirstSteps">FirstSteps
examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Text Document Examples</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./FirstSteps/FirstUnoContact.java"
title="link to FirstSteps/FirstUnoContact.java">FirstUnoContact</a></td>
<td class="cell80">Shows how to initialize UNO and
get a remote office service manager from a running OpenOffice.org %PRODUCT_RELEASE% in a
different process space.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./FirstSteps/FirstLoadComponent.java"
title="link to FirstSteps/FirstLoadComponent.java">FirstLoadComponent</a></td>
<td class="cell80">Demonstrates how to load a
component into OpenOffice.org %PRODUCT_RELEASE% by a Java application.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./FirstSteps/HelloTextTableShape.java"
title="link to FirstSteps/HelloTextTableShape.java">HelloTextTableShape</a></td>
<td class="cell80">Performs some generic text and
shape operations on a text document, a spreadsheet document and a
drawing document.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="ProfessionalUNO">Professional UNO examples1</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Lifetime Examples</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/Lifetime/MyUnoObject.java"
title="link to ProfUNO/Lifetime/MyUnoObject.java">MyUnoObject</a></td>
<td class="cell80">Shows that it depends on the
implementation of the Java VM whether finalize() will be called or not.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/Lifetime/object_lifetime.cxx"
title="link to ProfUNO/Lifetime/object_lifetime.java">object_lifetime.cxx
(ProfUnoLifetime)</a></td>
<td class="cell80">Shows the UNO reference counting
mechanism in C++.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Interprocess Connection Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/InterprocessConn/ConnectionAwareClient.java"
title="link to ProfUNO/InterprocessConn/ConnectionAwareClient/.java">ConnectionAwareClient</a></td>
<td class="cell80">Implements a client which is aware
of losing connection to OpenOffice.org %PRODUCT_RELEASE%.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/InterprocessConn/UrlResolver.java"
title="link to ProfUNO/InterProcessConn/UrlResolver.java">UrlResolver</a></td>
<td class="cell80">Builds a connection to
OpenOffice.org %PRODUCT_RELEASE% using the URL given on the command line. This example
shows the usage of <a
href="../../docs/common/ref/com/sun/star/bridge/XUnoUrlResolver.html"
title="link to the reference documentation of com.sun.star.bridge.XUnoResolver"><code>XUnoUrlResolver</code></a>.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">C++ Binding Examples</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/CppBinding/office_connect.cxx"
title="link to ProfUNO/CppBinding/office_connect.java">office_connect.cxx</a></td>
<td class="cell80">Builds a connection to
OpenOffice.org %PRODUCT_RELEASE% using C++.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/CppBinding/string_samples.cxx"
title="link to ProfUNO/Cppbinding/string_samples.java">string_samples.cxx</a></td>
<td class="cell80">Demonstrates usage of RTL string
classes <a href="../../docs/cpp/ref/names/rtl/c-OString.html"
title="link to the reference documentation of rtl::OString"><code>OString</code></a>,
<a href="../../docs/cpp/ref/names/rtl/c-OUString.html"
title="link to the reference documentation of rtl::OUString"><code>OUString</code></a>
and <a href="../../docs/cpp/ref/names/rtl/c-OUStringBuffer.html"
title="link to the reference documentation of rtl::OUStringBuffer"><code>OUStringBuffer</code></a>.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">SimpleBootstrap Java Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/SimpleBootstrap_java/SimpleBootstrap_java.java"
title="link to ProfUNO/SimpleBootstrap_java/SimpleBootstrap_java.java">SimpleBootstrap_java.java</a></td>
<td class="cell80">Shows the transparent use of
office UNO components from Java. The remote office component context is
obtained by using the <code>com.sun.star.comp.helper.Bootstrap.bootstrap()</code>
method, which bootstraps the component context from a UNO installation.</td>
</tr>
<tr>
<td class="cell20"><a
href="./ProfUNO/SimpleBootstrap_java/manifest.mf"
title="link to ProfUNO/SimpleBootstrap_java/manifest.mf"> manifest.mf</a></td>
<td class="cell80">Contains the additional manifest
file entries.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">SimpleBootstrap C++ Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./ProfUNO/SimpleBootstrap_cpp/SimpleBootstrap_cpp.cxx"
title="link to ProfUNO/SimpleBootstrap_cpp/SimpleBootstrap_cpp.cxx">SimpleBootstrap_cpp.cxx</a></td>
<td class="cell80">Shows the transparent use of
office UNO components from C++. The remote office component context is
obtained by using the <code>::cppu::bootstrap()</code> function, which
bootstraps the component context from a UNO installation.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Deployment Features</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"> <a
href="./Components/SimpleLicense/description.xml"
title="link to Components/SimpleLicense/description.xml">description.xml</a></td>
<td class="cell80">Demonstrates how license files can be embedded, so that they are shown to the user during installation.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Components">Writing
UNO components examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Jobs Addon Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/JobsAddon/AsyncJob.java"
title="link to Components/Addons/JobsAddon/AsyncJob.java">AsyncJob</a></td>
<td class="cell80">An java example showing how a job
can analyze the given arguments and how the environment can be
detected, in which the job is executed.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/JobsAddon/Jobs.xcu"
title="link to Components/Addons/JobsAddon/Jobs.xcu">Jobs.xcu</a></td>
<td class="cell80">Contains the example job
configuration.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/JobsAddon/Addons.xcu"
title="link to Components/Addons/JobsAddon/Addons.xcu">Addons.xcu</a></td>
<td class="cell80">Contains the configuration entries
for the Jobs addon where different entries are configured.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">ProtocolHandler Addon Java</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_java/ProtocolHandlerAddon.java"
title="link to Components/Addons/ProtocolHandlerAddon_java/ProtocolHandlerAddon.java">ProtocolHandlerAddon</a></td>
<td class="cell80">Implements a ProtocolHandler addon
component in Java.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu">ProtocolHandler.xcu</a></td>
<td class="cell80">Contains the ProtocolHandler
configuration.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu">Addons.xcu</a></td>
<td class="cell80">Contains the configuration entries
for the ProtocolHandler addon where different entries are configured.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">ProtocolHandler Addon C++</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/addon.cxx"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/addon.cxx">addon.cxx</a></td>
<td class="cell80">Implements a ProtocolHandler addon
component in C++.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/addon.hxx"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/addon.hxx">addon.hxx</a></td>
<td class="cell80">Contains the class definition of
the c++ ProtocolHandler example.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/component.cxx"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/component.cxx">component.cxx</a></td>
<td class="cell80">Implements the administrative
component functions (component_writeInfo, component_getFactory).</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu">ProtocolHandler.xcu</a></td>
<td class="cell80">Contains the ProtocolHandler
configuration.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu"
title="link to Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu">Addons.xcu</a></td>
<td class="cell80">Contains the configuration entries
for the ProtocolHandler addon where different entries are configured.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Java Component Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif"> <a
href="./Components/JavaComponent/TestJavaComponent.java"
title="link to Components/JavaComponent/TestJavaComponent.java">TestJavaComponent</a></td>
<td class="cell80">Demonstrates how to extend the
service provider with a new factory and instantiates the example
components.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/JavaComponent/TestComponentA.java"
title="link to Components/JavaComponent/TestComponentA.java">TestComponentA</a></td>
<td class="cell80">Shows a simple demo component
which implements <a
href="../../docs/common/ref/com/sun/star/lang/XTypeProvider.html"
title="link to the reference documentation of com.sun.star.lang.XTypeProvider"><code>XTypeProvider</code></a>,
<a
href="../../docs/common/ref/com/sun/star/lang/XServiceInfo.html"
title="link to the reference documentation of com.sun.star.lang.XServicedInfo">
<code>XServiceInfo</code></a> and an own interface <code>XSomethingA</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/JavaComponent/TestComponentB.java"
title="link to Components/JavaComponent/TestComponentB.java">TestComponentB</a></td>
<td class="cell80">Shows a simple demo component
which implements <a
href="../../docs/common/ref/com/sun/star/lang/XTypeProvider.html"
title="link to the reference documentation of com.sun.star.lang.XTypeProvider">
<code>XTypeProvider</code></a>, <a
href="../../docs/common/ref/com/sun/star/lang/XServiceInfo.html"
title="link to the reference documentation of com.sun.star.lang.XServiceInfo"><code>XServiceInfo</code></a>
and an own interface <code>XSomethingB</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/JavaComponent/TestServiceProvider.java"
title="link to Components/JavaComponent/TestServiceProvider.java">TestServiceProvider</a></td>
<td class="cell80">Implements a factory (service
provider) which can create the two test components.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">C++ Component Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif"> <a
href="./Components/CppComponent/TestCppComponent.cxx"
title="link to Components/CppComponent/TestCppComponent.cxx">TestCppComponent.cxx</a></td>
<td class="cell80">Shows how to create new instances
of the demo services and calls some methods of the demo interface.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/CppComponent/service1_impl.cxx"
title="link to Components/CppComponent/service1_impl.cxx">service1_impl.cxx</a></td>
<td class="cell80">Implements a simple UNO service
with an own interface in C++.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/CppComponent/service2_impl.cxx"
title="link to Components/CppComponent/service2_impl.cxx">service2_impl.cxx</a></td>
<td class="cell80">Implements another simple UNO
service in C++.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Thumbs Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Thumbs/org/openoffice/comp/test/ImageShrink.java"
title="link to Components/Thumbs/org/openoffice/comp/test/ImageShrink.java">ImageShrink</a></td>
<td class="cell80">Contains a framework for a
component which scales images in a directory and stores them to another
directory. This code does not really do anything, it just contains the
framework.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/Thumbs/org/openoffice/comp/test/Thumbs.java"
title="link to Components/Thumbs/org/openoffice/comp/test/Thumbs.java">Thumbs</a></td>
<td class="cell80">This example registers a factory
for the image shrink component and instantiates it.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Dialog Component Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif"> <a
href="./Components/DialogComponent/DialogComponent.java"
title="link to Components/DialogComponent/DialogComponent.java">DialogComponent.java</a></td>
<td class="cell80">Implements a component accessing a dialog created
with the OpenOffice.org %PRODUCT_RELEASE% Basic IDE. The component provides methods that
can be bound to dialog respectively control events .</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/DialogComponent/XTestDialogHandler.idl"
title="link to Components/DialogComponent/XTestDialogHandler.idl">XTestDialogHandler.idl</a></td>
<td class="cell80">Interface implementing a createDialog method showing the
dialog and some methods to be used as event handler for the dialog.
</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/DialogComponent/TestDialogHandler.idl"
title="link to Components/DialogComponent/TestDialogHandler.idl">TestDialogHandler.idl</a></td>
<td class="cell80">
Service definition for the component implementing
its own interface <code>XTestDialogHandler</code>.
</td>
</tr>
<tr>
<td class="cell20"><a
href="./Components/DialogComponent/DialogComponent.odt"
title="link to Components/DialogComponent/DialogComponent.odt">DialogComponent.odt</a></td>
<td class="cell80">Document containing Basic code to
instantiate the Dialog Components and a Dialog containing
controls with events bound to methods supported by the
Dialog Component.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="OfficeDevelopment">Office Development examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Ascii Filter Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/AsciiFilter/AsciiReplaceFilter.java"
title="link to OfficeDev/FilterDevelopment/AsciiFilter/AsciiReplaceFilter.java">AsciiReplaceFilter</a></td>
<td class="cell80">Implements an example for an
import/export filter service.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/AsciiFilter/FilterOptions.java"
title="link to OfficeDev/FilterDevelopment/AsciiFilter/FilterOptions.java">FilterOptions</a></td>
<td class="cell80">Offers some helper methods to
analyze and prepare the arguments of the filter method.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/AsciiFilter/TypeDetection.xcu"
title="link to OfficeDev/FilterDevelopment/AsciiFilter/TypeDetection.xcu">TypeDetection.xcu</a></td>
<td class="cell80">Contains the necessary
configuration items for the AsciiReplaceFilter.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">FlatXmlFilter C++ Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXml.cxx"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXml.cxx">FlatXml.cxx</a></td>
<td class="cell80">Implements an import/export filter
storing the data in one xml stream instead of the normal three streams
in for example an .odt file. The example is implemented in C++.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXmlFilter_cpp.xcu"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXmlFilter_cpp.xcu">FlatXmlFilter_cpp.xcu</a></td>
<td class="cell80">Contains the necessary
configuration items for the C++ flat xml filter.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">FlatXmlFilter Java Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXml.java"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXml.java">FlatXml</a></td>
<td class="cell80">Implements an import/export filter
storing the data in one xml stream instead of the normal three streams
in for example an .odt file. The example is implemented in Java.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXmlFilter_java.xcu"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXmlFilter_java.xcu">FlatXmlFilter_java.xcu</a></td>
<td class="cell80">Contains the necessary
configuration items for the Java flat xml filter.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">FlatXml FilterDetection Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.cxx"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.cxx">filterdetect.cxx</a></td>
<td class="cell80">Implements an example filter
detection for the flat xml filter. The example is implemented in C++.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.hxx"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.hxx">filterdetect.hxx</a></td>
<td class="cell80">Contains the class definition of
the filter detection example.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/fdcomp.cxx"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/fdcomp.cxx">fdcomp.cxx</a></td>
<td class="cell80">Implements the administrative
component functions (component_writeInfo, component_getFactory).</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/FlatXmlTypeDetection.xcu"
title="link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/FlatXmlTypeDetection.xcu">FlatXmlTypeDetection.xcu</a></td>
<td class="cell80">Contains the necessary
configuration items for the C++ flat xml type detection.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Desktop Environment Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/CustomizeView.java"
title="link to OfficeDev/DesktopEnvironment/CustomizeView.java">CustomizeView</a></td>
<td class="cell80">Offers a view which allows hiding
and showing of the menubar, toolbar and objectbar of the related
document component.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/DesktopEnvironment/Desk.java"
title="link to OfficeDev/DesktopEnvironment/Desk.java">Desk</a></td>
<td class="cell80">This is the main part of a demo
application based on the framework APIs. It mainly shows the mechanisms
to load, store and convert documents, as well as dispatch and dispatch
interception. It integrates windows from OpenOffice.org %PRODUCT_RELEASE% via system
window handle. This is the same mechanism as used by the OOoBean, but
the OOoBean itself is not used here, just the JNI window handle access.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/DocumentView.java"
title="link to OfficeDev/DesktopEnvironment/DocumentView.java">DocumentView</a></td>
<td class="cell80">Deals with the application window
and it's actions.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/FunctionHelper.java"
title="link to OfficeDev/DesktopEnvironment/FunctionHelper.java">FunctionHelper</a></td>
<td class="cell80">This helper comprises all
OpenOffice.org %PRODUCT_RELEASE% API calls. Thus it is possible to learn about these
aspects separately from the rest of the application example.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/IOnewayLink.java"
title="link to OfficeDev/DesktopEnvironment/IOnewayLink.java">IOnewayLink</a></td>
<td class="cell80">This is an interface to receive
asynchronous events from UNO oneway calls.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/IShutdownListener.java"
title="link to OfficeDev/DesktopEnvironment/IShutdownListener.java">IShutdownListener</a></td>
<td class="cell80">This is a listener interface to
clean up on shutdown of OpenOffice.org %PRODUCT_RELEASE%.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/Interceptor.java"
title="link to OfficeDev/DesktopEnvironment/Interceptor.java">Interceptor</a></td>
<td class="cell80">This implements a dispatch
interceptor for a specific URL.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java"
title="link to OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java">JavaWindowPeerFake</a></td>
<td class="cell80">Fakes an <a
href="../../docs/common/ref/com/sun/star/awt/XWindowPeer.html"
title=" link to the reference documentation of com.sun.star.awt.XWindowPeer"><code>XWindowPeer</code></a>
for the Java native window handle to create a child window for the
office frame.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/NativeView.java"
title="link to OfficeDev/DesktopEnvironment/NativeView.java">NativeView</a></td>
<td class="cell80">Implements native JNI methods to
get the window handle of the Java window.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/OfficeConnect.java"
title=" link to OfficeDev/DesktopEnvironment/OfficeConnect.java">OfficeConnect</a></td>
<td class="cell80">Builds the remote bridge to
OpenOffice.org %PRODUCT_RELEASE% and exports its UNO service manager for the Java side of
the application.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/OnewayExecutor.java"
title="link to OfficeDev/DesktopEnvironment/OnewayExecutor.java">OnewayExecutor</a></td>
<td class="cell80">Implements <code>IOnewayLink</code>
to decouple asynchronous oneway calls in the Java process.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/StatusListener.java"
title="link to OfficeDev/DesktopEnvironment/StatusListener.java">StatusListener</a></td>
<td class="cell80">Implements a listener for a <a
href="../../docs/common/ref/com/sun/star/frame/FeatureStateEvent.html"
title="link to the reference documentation of com.sun.star.frame.FeatureStateEvent">
<code>FeatureStateEvent</code></a>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/StatusView.java"
title="link to OfficeDev/DesktopEnvironment/StatusView.java">StatusView</a></td>
<td class="cell80">Shows the current status for which
the application is registered as an event listener.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DesktopEnvironment/ViewContainer.java"
title="link to OfficeDev/DesktopEnvironment/ViewContainer.java">ViewContainer</a></td>
<td class="cell80">Performs a clean up on the Java
side on OpenOffice.org %PRODUCT_RELEASE% shutdown.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Office Development Examples</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/OfficeConnect.java"
title="link to OfficeDev/OfficeConnect.java">OfficeConnect</a></td>
<td class="cell80">Builds the remote bridge to
OpenOffice.org %PRODUCT_RELEASE% and exports its UNO service manager to the Java side.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/ContextMenuInterceptor.java"
title="link to OfficeDev/ContextMenuInterceptor.java">ContextMenuInterceptor</a></td>
<td class="cell80">This example shows a context menu
interceptor that creates a new menu entry that has a sub menu. This sub
menu is in inserted into the context menu on the topmost position. It
provides some helper functions to the user that are reachable through
the menu Help.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/MenuElement.java"
title="link to OfficeDev/MenuElement.java">MenuElement</a></td>
<td class="cell80">A helper class for the context
menu interceptor example. It determines the menu element type.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/Number_Formats.java"
title="link to OfficeDev/Number_Formats.java">Number_Formats</a></td>
<td class="cell80">Demonstrates the use of number
formats in a spreadsheet document.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Termination Test Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/TerminationTest/TerminationTest.java"
title="link to OfficeDev/TerminationTest/TerminationTest.java">TerminationTest</a></td>
<td class="cell80">This example uses the
TerminateListener and shows the use of them in a running program.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/TerminationTest/TerminateListener.java"
title="link to OfficeDev/TerminationTest/TerminateListener.java">TerminateListener</a></td>
<td class="cell80">An example implementation of <a
href="../../docs/common/ref/com/sun/star/frame/XTerminateListener.html"
title="link to the reference documentation of com.sun.star.frame.XTerminationListener">
<code>XTerminateListener</code></a>. It is called
when OpenOffice.org %PRODUCT_RELEASE% terminates.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Clipboard Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/Clipboard/Clipboard.java"
title="link to OfficeDev/Clipboard/Clipboard.java">Clipboard</a></td>
<td class="cell80">Demonstrates the usage of the
clipboard service by registering a clipboard listener, getting a list
of formats from the current clipboard content and copying some data to
the clipboard.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Clipboard/ClipboardListener.java"
title="link to OfficeDev/Clipboard/ClipboardListener.java">ClipboardListener</a></td>
<td class="cell80">Implements a clipboard listener
for the Clipboard example. In such a class, actions can be implemented
which happen whenever the clipboard content changes.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Clipboard/ClipboardOwner.java"
title="link to OfficeDev/Clipboard/ClipboardOwner.java">ClipboardOwner</a></td>
<td class="cell80">Implements a clipboard owner for
the Clipboard example. This class is notified when it loses ownership
of the clipboard.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Clipboard/TextTransferable.java"
title="link to OfficeDev/Clipboard/TextTransferable.java">TextTransferable</a></td>
<td class="cell80">Implements a data object for the
Clipboard example. Such classes supply clients with data in a variety
of formats.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Linguistic Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeDev/Linguistic/LinguisticExamples.java"
title="link to OfficeDev/Linguistic/LinguisticExamples.java">LinguisticExamples</a></td>
<td class="cell80">A short example that uses most of
the functionality from the OpenOffice.org %PRODUCT_RELEASE% linguistic API.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/OneInstanceFactory.java"
title="link to OfficeDev/Linguistic/OneInstanceFactory.java">OneInstanceFactory</a></td>
<td class="cell80">This class is used to provide a
service factory for the linguistic services. It enforces that the
actual implementations are only instantiated once.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/PropChgHelper.java"
title="link to OfficeDev/Linguistic/PropChgHelper.java">PropChgHelper</a></td>
<td class="cell80">The base class for several
property change helpers which are used to keep track of the changes of
the service relevant linguistic properties. It is also used by the
thesaurus directly.</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/PropChgHelper_Hyph.java"
title="link to OfficeDev/Linguistic/PropChgHelper_Hyph.java">PropChgHelper_Hyph</a></td>
<td class="cell80">The property change helper that is
tracking the hyphenation relevant properties.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/PropChgHelper_Spell.java"
title="link to OfficeDev/Linguistic/PropChgHelper_Spell.java">PropChgHelper_Spell</a></td>
<td class="cell80">The property change helper that is
tracking the spell checking relevant properties.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/SampleHyphenator.java"
title="link to OfficeDev/Linguistic/SampleHyphenator.java">SampleHyphenator</a></td>
<td class="cell80">A simple implementation for a <a
href="../../docs/common/ref/com/sun/star/linguistic2/Hyphenator.html"
title="link to the reference documentation of com.sun.star.linguistic2.Hypenator"><code>Hyphenator</code></a>
service.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/SampleSpellChecker.java"
title="link to OfficeDev/Linguistic/SampleSpellChecker.java">SampleSpellChecker</a></td>
<td class="cell80">A simple implementation for a <a
href="../../docs/common/ref/com/sun/star/linguistic2/SpellChecker.html"
title="link to the reference documentation of com.sun.star.linguistic2.SpellChecker"><code>SpellChecker</code></a>
service.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/SampleThesaurus.java"
title="link to OfficeDev/Linguistic/SampleThesaurus.java">SampleThesaurus</a></td>
<td class="cell80">A simple implementation for a <a
href="../../docs/common/ref/com/sun/star/linguistic2/Thesaurus.html"
title="link to the reference documentation of com.sun.star.linguistic2.Thesaurus"><code>Thesaurus</code></a>
service.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/XHyphenatedWord_impl.java"
title="link to OfficeDev/Linguistic/XHyphenatedWord_impl.java">XHyphenatedWord_impl</a></td>
<td class="cell80">An object implementing the <a
href="../../docs/common/ref/com/sun/star/linguistic2/XHyphenatedWord.html"
title="link to the reference documentation of com.sun.star.linguistic2/XHyphenatedWord"><code>XHyphenatedWord</code></a>
interface. An instance of this type may be returned by the hyphenator.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/XMeaning_impl.java"
title="link to OfficeDev/Linguistic/XMeaning_impl.java">XMeaning_impl</a></td>
<td class="cell80">An object implementing the <a
href="../../docs/common/ref/com/sun/star/linguistic2/XMeaning.html"
title="link to the reference documentation of com.sun.star.linguistic2.XMeaning"><code>XMeaning</code></a>
interface. An instance of this type may be returned by the thesaurus.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/XPossibleHyphens_impl.java"
title="link to OfficeDev/Linguistic/XPossibleHyphens_impl.java">XPossibleHyphens_impl</a></td>
<td class="cell80">An object implementing the <a
href="../../docs/common/ref/com/sun/star/linguistic2/XPossibleHyphens.html"
title="link to the reference documentation of com.sun.star.linguistic2.XPossibleHyphens">
<code>XPossibleHyphens</code></a> interface. An
instance of this type may be returned by the hyphenator.</td>
</tr>
<tr>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/Linguistic/XSpellAlternatives_impl.java"
title="link to OfficeDev/Linguistic/XSpellAlternatives_impl.java">XSpellAlternatives_impl</a></td>
<td class="cell80">An object implementing the <a
href="../../docs/common/ref/com/sun/star/linguistic2/XSpellAlternatives.html"
title="link to the reference documentation of com.sun.star.linguistic2.XSpellAlternatives">
<code>XSpellAlternatives</code></a> interface. An
instance of this type may be returned by the spell checker.</td>
</tr>
<tr>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Path Settings Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/PathSettings/PathSettingsTest.java"
title="link to OfficeDev/PathSettings/PathSettingsTest.java">PathsettingsTest</a></td>
<td class="cell80">This code example creates the
service <a
href="../../docs/common/ref/com/sun/star/util/PathSettings.html"
title="link to the reference documentation of com.sun.star.util.PathSettingst">
<code>com.sun.star.util.PathSettings</code></a> and
retrieves all path properties from it. It shows how a developer can
change the path properties using the <a
href="../../docs/common/ref/com/sun/star/beans/XPropertySet.html"
title="link to the reference documentation of com.sun.star.beans.XPropertySet"><code>XPropertySet</code></a>
interface.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Path Substitution Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/PathSubstitution/PathSubstitutionTest.java"
title="link to OfficeDev/PathSubstitution/PathSubstitutionTest.java">PathSubstitutionTest</a></td>
<td class="cell80">This code example creates the path
substitution service <a
href="../../docs/common/ref/com/sun/star/util/PathSubstitution.html"
title="link to the reference documentation of com.sun.star.util.PathSubstitution">
<code>com.sun.star.util.PathSubstitution</code></a>
and retrieves the pre-defined Office path variables. It shows the
variable values on the screen. The reSubstiuteVariables function is
used to show how the service exchanges parts of a path with a path
variable supporting platform independent path usage.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Disable Commands Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./OfficeDev/DisableCommands/DisableCommandsTest.java"
title="link to OfficeDev/DisableCommands/DisableCommandsTest.java">DisableCommandsTest</a></td>
<td class="cell80">Implements an example showing how
a developer can use the configuration API to disable/enable commands at
runtime.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Text">Text
Documents examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Text/TextDocuments.java"
title="link to Text/TextDocuments.java">TextDocuments</a></td>
<td class="cell80">
<p>Demonstrates a wide variety of API functions in
text documents and text document views.</p>
<ul>
<li>use of templates</li>
<li>using the view cursor, including visible text
selections</li>
<li>changing the paragraph style</li>
<li>using various editing facilities like text
insertion</li>
<li>using various cursor interfaces</li>
<li>creating text contents, like tables, sections
and frames, well as text fields and columns</li>
<li>using stylesheets</li>
<li>applying numbering styles</li>
<li>using references, indexes, footnotes and
autotext</li>
<li>loading, storing and printing a text document</li>
</ul>
<p>Adjust the strings at the beginning of the class
definition to match your installation!</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Spreadsheet">Spreadsheet
Documents examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Spreadsheet/ExampleAddIn.java"
title="link to Spreadsheet/ExampleAddIn.java">ExampleAddIn</a></td>
<td class="cell80">Implements a simple add-in
component for spreadsheet documents. This component needs to be
deployed before it can be used.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Spreadsheet/ExampleDataPilotSource.java"
title="link to Spreadsheet/ExampleDataPilotSource.java">ExampleDataPilotSource</a></td>
<td class="cell80">Shows usage of a wide variety of
spreadsheet interfaces like <a
href="../../docs/common/ref/com/sun/star/sheet/XCellRangeData.html"
title="link to the reference documentation of com.sun.star.sheet.XCellRangeData">
<code>XCellRangeData</code></a>, <a
href="../../docs/common/ref/com/sun/star/sheet/XCellSeries.html"
title="link to the reference documentation of com.sun.star.sheet.XCellSeries"><code>XCellSeries</code></a>,
<a
href="../../docs/common/ref/com/sun/star/sheet/XArrayFormulaRange.html"
title="link to the reference documentation of com.sun.star.sheet.XArrayFormularRange"><code>XArrayFormulaRange</code></a>
and <a
href="../../docs/common/ref/com/sun/star/sheet/XMultipleOperation.html"
title="link to the reference documentation of com.sun.star.sheet.XMultipleOperation"><code>XMultipleOperations</code></a>
as well as named ranges, label ranges and data pilot.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Spreadsheet/GeneralTableSample.java"
title="link to Spreadsheet/GeneralTableSample.java">GeneralTableSample</a></td>
<td class="cell80">Executes some examples working on
generic tables.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Spreadsheet/SpreadsheetDocHelper.java"
title="link to Spreadsheet/SpreadsheetDocHelper.java">SpreadsheetDocHelper</a></td>
<td class="cell80">Defines a helper class for the
other examples to access spreadsheet documents, sheets and cells.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Spreadsheet/SpreadsheetSample.java"
title="link to Spreadsheet/SpreadsheetSample.java">SpreadsheetSample</a></td>
<td class="cell80">Executes some examples working on
a spreadsheet document.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Spreadsheet/ViewSample.java"
title="link to Spreadsheet/ViewSample.java">ViewSample</a></td>
<td class="cell80">Shows how to manipulate view
settings like splitting sheeting sheets and selecting cells.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Drawing">Drawing
and Presentation Documents examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/ChangeOrderDemo.java"
title="link to Drawing/ChangeOrderDemo.java">ChangeOrderDemo</a></td>
<td class="cell80">Shows how to change the painting
order of shapes.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/ControlAndSelectDemo.java"
title="link to Drawing/ControlAndSelectDemo.java">ControlAndSelectDemo</a></td>
<td class="cell80">Demonstrates the creation of a
control shape and selects it in the current view.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/CustomShowDemo.java"
title="link to Drawing/CustomShowDemo.java">CustomShowDemo</a></td>
<td class="cell80">Creates two custom shows and
selects one of these.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/DrawViewDemo.java"
title="link to Drawing/DrawViewDemo.java">DrawViewDemo</a></td>
<td class="cell80">Prints the view data properties
and the controller properties of a drawing view and shows an example of
setting such a property.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/DrawingDemo.java"
title="link to Drawing/DrawingDemo.java">DrawingDemo</a></td>
<td class="cell80">Creates several shapes on several
slides. Nice pattern included!</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/FillAndLineStyleDemo.java"
title="link to Drawing/FillAndLineStyleDemo.java">FillAndLineStyleDemo</a></td>
<td class="cell80">Demonstrates usage of area fill
and line style properties.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/GluePointDemo.java"
title="link to Drawing/GluePointDemo.java">GluePointDemo</a></td>
<td class="cell80">Creates two shapes with glue
points and connects them with two connectors.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/GraphicExportDemo.java"
title="link to Drawing/GraphicExportDemo.java">GraphicExportDemo</a></td>
<td class="cell80">Loads a drawing document and
exports it to a GIF file. Run this program with source URL, target URL
and page index on the command line, where the URLs are fully qualified
URLs.</td>
</tr>
<tr>
<td class="cell20"><a href="./Drawing/Helper.java"
title="link to Drawing/Helper.java">Helper</a></td>
<td class="cell80">Contains a helper class for the
other examples to connect to OpenOffice.org %PRODUCT_RELEASE% and open or create a drawing
document.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/LayerDemo.java" title="link to Drawing/LayerDemo.java">LayerDemo</a></td>
<td class="cell80">Creates shapes in different layers
to show how to protect shapes from modifications.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/ObjectTransformationDemo.java"
title="link to Drawing/ObjectTransformationDemo.java">ObjectTransformationDemo</a></td>
<td class="cell80">Shows geometric transformations on
a shape using a homogenous matrix.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/Organigram.java"
title="link to Drawing/Organigram.java">Organigram</a></td>
<td class="cell80">Demonstrates the creation of an
organigram consisting of shapes and connectors.</td>
</tr>
<tr>
<td class="cell20"><a href="./Drawing/PageHelper.java"
title="link to Drawing/PageHelper.java">PageHelper</a></td>
<td class="cell80">Contains a helper class for
accessing several kinds of draw pages in a presentation or drawing
document.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/PresentationDemo.java"
title="link to Drawing/PresentationDemo.java">PresentationDemo</a></td>
<td class="cell80">Creates a presentation and runs it
with some user interaction.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Drawing/ShapeHelper.java"
title="link to Drawing/ShapeHelper.java">ShapeHelper</a></td>
<td class="cell80">Contains a helper class for
accessing and creating shapes for the other examples.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Drawing/StyleDemo.java" title="link to Drawing/StyleDemo.java">StyleDemo</a></td>
<td class="cell80">Creates a shape and applies a
predefined shape stylesheet.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a href="./Drawing/TextDemo.java"
title="link to Drawing/TextDemo.java">TextDemo</a></td>
<td class="cell80">Demonstrates usage of text and
text styles in shapes.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Charts">Charts
examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a href="./Charts/CalcHelper.java"
title="link to Charts/CalcHelper.java">CalcHelper</a></td>
<td class="cell80">Contains some helper methods for
charts in spreadsheet documents, like accessing sheets by name,
inserting a chart into a sheet, filling cell ranges with random numbers
etc.</td>
</tr>
<tr>
<td class="cell20"><a href="./Charts/ChartHelper.java"
title="link to Charts/ChartHelper.java">ChartHelper</a></td>
<td class="cell80">Contains some helper methods for
charts, like creating a chart as an embedded object.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Charts/ChartInCalc.java"
title="link to Charts/ChartInCalc.java">ChartInCalc</a></td>
<td class="cell80">Demonstrates how to create an
embedded chart object with a random scatter chart within a spreadsheet.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Charts/ChartInDraw.java"
title="link to Charts/ChartInDraw.java">ChartInDraw</a></td>
<td class="cell80">Inserts a 3D-bar chart into a
drawing document.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Charts/ChartInWriter.java"
title="link to Charts/ChartInWriter.java">ChartInWriter</a></td>
<td class="cell80">Inserts an embedded chart object
with a random bar chart in a text document. This example does not
really work, because the API for embedding objects into text documents
is not implemented. To be more precise.</td>
</tr>
<tr>
<td class="cell20"><a href="./Charts/Helper.java"
title="link to Charts/Helper.java">Helper</a></td>
<td class="cell80">Shows how to connect to
OpenOffice.org %PRODUCT_RELEASE% and create text, drawing or spreadsheet document. This
class is used as a helper class for the other examples.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Charts/JavaSampleChartAddIn.java"
title="link to Charts/JavaSampleChartAddIn.java">JavaSampleChartAddIn</a></td>
<td class="cell80">Gives an example of how to
implement chart add-ins to create new or specialized diagram types. The
resulting component has to be deployed before it can be used.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Charts/ListenAtCalcRangeInDraw.java"
title="link to Charts/ListenAtCalcRangeInDraw.java">ListenAtCalcRangeInDraw</a></td>
<td class="cell80">This helper class is used to build
connection between an embedded chart object in a drawing document and a
data range in a spreadsheet document.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Charts/SelectionChangeListener.java"
title="link to Charts/SelectionChangeListener.java">SelectionChangeListener</a></td>
<td class="cell80">Shows how to register a handler
which is called when the selection within an embedded chart object
changes.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="BasicandDialogs">OpenOffice.org %PRODUCT_RELEASE% Basic and Dialogs examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./BasicAndDialogs/FirstStepsBasic.odt"
title="link to BasicAndDialogs/FirstStepsBasic.odt">FirstStepsBasic.odt</a></td>
<td class="cell80">This StarBasc example shows how to
create an own dialog which inserts a graphics object into a text
document.</td>
</tr>
<tr>
<td class="cell20"><a
href="./BasicAndDialogs/CreatingDialogs/SampleDialog.java"
title="link to BasicAndDialogs/CreatingDialogs/SampleDialog.java">SampleDialog</a></td>
<td class="cell80">This example builds a Java
component which creates a simple dialog.</td>
</tr>
<tr>
<td class="cell20"><a
href="./BasicAndDialogs/CreatingDialogs/CreatingDialogs.odt"
title="link to BasicAndDialogs/CreatingDialogs/CreatingDialogs.odt">CreatingDialogs.odt</a></td>
<td class="cell80">This document contains a simple
Basic macro which loads the SampleDialog component. The macro will be
executed by pressing a Push button.</td>
</tr>
<tr>
<td class="cell20"><a
href="./BasicAndDialogs/ToolkitControls/ToolkitControls"
title="link to BasicAndDialogs/ToolkitControls">ToolkitControls</a></td>
<td class="cell80">In this directory you find a Basic
library which implements several examples using toolkit controls. You
can easy pack this Basic library as a UNO package and can install it
using the package manager (see the makefile output).<br>
After the installation you will find a new library "ToolkitControls" in
the Basic IDE containing 4 modules and the necessary dialogs.<br>
<p>Select one of the following modules and press the
Run button: </p>
<ul>
<li>FileDialog = simple dialog which ask for a
filename (nothing else) </li>
<li>MultiPage = a more complex dialog with several
tab pages </li>
<li>ProgressBar = a dialog which shows a progress
bar </li>
<li>ScrollBar = a dialog which shows a scroll bar </li>
</ul>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Database">Database
Access examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
<tr>
<td colspan="3"> The Database examples use a SQL
database named "MYDB0" with write access. Make sure that you have a
data source operating on such a database in your office before you run
the example. </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Database Examples</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Database/CodeSamples.java"
title="link to Database/CodeSamples.java">CodeSamples</a></td>
<td class="cell80">Creates the connection to
OpenOffice.org %PRODUCT_RELEASE% and executes the code SalesMan samples for database API.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Database/OpenQuery.java"
title="link to Database/OpenQuery.java">OpenQuery</a></td>
<td class="cell80">Demonstrates the use of <a
href="../../docs/common/ref/com/sun/star/sdbc/XResultSetUpdate.html"
title="link to the reference documentation of com.sun.star.sdbc.XResultSetUpdate"><code>XResultSetUpdate</code></a>
and <a href="../../docs/common/ref/com/sun/star/sdbc/XRowUpdate.html"
title="link to the reference documentation of com.sun.star.sdbc.XRowUpdate">
<code>XRowUpdate</code></a>.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a href="./Database/RowSet.java"
title="link to Database/RowSet.java">RowSet</a></td>
<td class="cell80">Demonstrates the usage of a row
set.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/RowSetEventListener.java"
title="link to Database/RowSetEventListener.java">RowSetEventListener</a></td>
<td class="cell80">Demonstrates how to define
listener for the row set example.</td>
</tr>
<tr>
<td class="cell20"><a href="./Database/Sales.java"
title="link to Database/Sales.java">Sales</a></td>
<td class="cell80">Creates a simple database table.</td>
</tr>
<tr>
<td class="cell20"><a href="./Database/SalesMan.java"
title="link to Database/SalesMan.java">SalesMan</a></td>
<td class="cell80">Creates a simple database table.</td>
</tr>
<tr>
<td class="cell20"><a href="./Database/sdbcx.java"
title="link to Database/sdbcx.java">sdbcx</a></td>
<td class="cell80">Demonstrates the usage of the
SDBCX layer services.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Driver Skeleton Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/OSubComponent.hxx"
title="link to Database/DriverSkeleton/OSubComponent.hxx">OSubComponent.hxx</a></td>
<td class="cell80">Helper class to delegate special
dispose handling.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/OTypeInfo.hxx"
title="link to Database/DriverSkeleton/OTypeInfo.hxx">OTypeInfo.hxx</a></td>
<td class="cell80">Contains the database types from
the DatabaseMetaData getTypes call.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SConnection.hxx"
title="link to Database/DriverSkeleton/SConnection.hxx">SConnection.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the service <code>com.sun.star.sdbc.Connection</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SConnection.cxx"
title="link to Database/DriverSkeleton/SConnection.cxx">SConnection.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SConnection.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SDatabaseMetaData.hxx"
title="link to Database/DriverSkeleton/SDatabaseMetaData.hxx">SDatabaseMetaData.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the interface <code>com.sun.star.sdbc.XDatabaseMetaData</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SDatabaseMetaData.cxx"
title="link to Database/DriverSkeleton/SDatabaseMetaData.cxx">SDatabaseMetaData.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SDatabaseMetaData.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SDriver.hxx"
title="link to Database/DriverSkeleton/SDriver.hxx">SDriver.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the service <code>com.sun.star.sdbc.Driver</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SDriver.cxx"
title="link to Database/DriverSkeleton/SDriver.cxx">SDriver.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SDriver.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SPreparedStatement.hxx"
title="link to Database/DriverSkeleton/SPreparedStatement.hxx">SPreparedStatement.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the service <code>com.sun.star.sdbc.PreparedStatement</code>.
</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SPreparedStatement.cxx"
title="link to Database/DriverSkeleton/SPreparedStatement.cxx">SPreparedStatement.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SPreparedStatement.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SResultSet.hxx"
title="link to Database/DriverSkeleton/SResultSet.hxx">SResultSet.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the service <code>com.sun.star.sdbc.ResultSet</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SResultSet.cxx"
title="link to Database/DriverSkeleton/SResultSet.cxx">SResultSet.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SResultSet.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SResultSetMetaData.hxx"
title="link to Database/DriverSkeleton/SResultSetMetaData.hxx">SResultSetMetaData.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the interface <code>com.sun.star.sdbc.XResultSetMetaData</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SResultSetMetaData.cxx"
title="link to Database/DriverSkeleton/SResultSetMetaData.cxx">SResultSetMetaData.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SResultSetMetaData.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SServices.cxx"
title="link to Database/DriverSkeleton/SServices.cxx">SServices.cxx</a></td>
<td class="cell80">This file contains a class
implementing the service needed to register the driver.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SStatement.hxx"
title="link to Database/DriverSkeleton/SStatement.hxx">SStatement.hxx</a></td>
<td class="cell80">This file contains the declaration
of a class implementing the service <code>com.sun.star.sdbc.Statement</code>.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/SStatement.cxx"
title="link to Database/DriverSkeleton/SStatement.cxx">SStatement.cxx</a></td>
<td class="cell80">This file contains the
implementation of the class declared in SStatement.hxx.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/propertyids.hxx"
title="link to Database/DriverSkeleton/propertyids.hxx">propertyids.hxx</a></td>
<td class="cell80">Defines some common used strings
and declare a helper class for properties.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Database/DriverSkeleton/propertyids.cxx"
title="link to Database/DriverSkeleton/propertyids.cxx">propertyids.cxx</a></td>
<td class="cell80">Implements the property helper
class.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Forms">Forms
examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/BooleanValidator.java"
title="link to Forms/BooleanValidator.java">BooleanValidator</a></td>
<td class="cell80">The class <code>BooleanOperator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain radio button or check box
states.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/ButtonOperator.java"
title="link to Forms/ButtonOperator.java">ButtonOperator</a></td>
<td class="cell80">The form created by the sample
program contains various buttons which are tied to certain
functionality. The class ButtonOperator, well, operates these buttons.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/ComponentTreeTraversal.java"
title="link to Forms/ComponentTreeTraversal.java">ComponentTreeTraversal</a></td>
<td class="cell80">Helper classes for traveling
through a tree of <a
href="../../docs/common/ref/com/sun/star/form/FormComponent.html"
title="link to the reference documentation of com.sun.star.form.FormComponent">
<code>FormComponent's</code></a>.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/ControlLock.java"
title="link to Forms/ControlLock.java">ControlLock</a></td>
<td class="cell80">Helper class for implementing the
locking of control depending on the state of the underlying <a
href="../../docs/common/ref/com/sun/star/sdb/RowSet.html"
title="link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet</code></a>.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Forms/ControlValidation.java"
title="link to Forms/ControlValidation.java">ControlValidation</a></td>
<td class="cell80">This is the main class for the
control validation example. It creates a sample document, fills it with
controls, and attaches several validators to those controls</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/ControlValidator.java"
title="link to Forms/ControlValidator.java">ControlValidator</a></td>
<td class="cell80">Base class implementing the common
denominator for components <a
href="../../docs/common/ref/com/sun/star/form/validation/ValidatableControlModel.html"
title="link to the reference documentation of com.sun.star.form.validation.ValidatableControlModel">validating
form controls.</a></td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Forms/DataAwareness.java"
title="link to Forms/DataAwareness.java">DataAwareness</a></td>
<td class="cell80">This class implements the basic
example for a form working on a database. Two tables will be created
and a form (writer document) with a bussiness example will fill its
fields from these tables.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/DateValidator.java"
title="link to Forms/DateValidator.java">DateValidator</a></td>
<td class="cell80">The class <code>DateValidator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can check the content of a form date field. </td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/DocumentBasedExample.java"
title="link to Forms/DocumentBasedExample.java">DocumentBasedExample</a></td>
<td class="cell80">This class collects common
functionality of examples which require a document.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/DocumentHelper.java"
title="link to Forms/DocumentHelper.java">DocumentHelper</a></td>
<td class="cell80">Helper class for encapsulating
working with a document.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/DocumentType.java"
title="link to Forms/DocumentType.java">DocumentType</a></td>
<td class="cell80">A simple enumeration class for
classifying a document.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/DocumentViewHelper.java"
title="link to Forms/DocumentViewHelper.java">DocumentViewHelper</a></td>
<td class="cell80">Helper class for encapsulating
working with a view for a document.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/FLTools.java"
title="link to Forms/FLTools.java">FLTools</a></td>
<td class="cell80">Various small tools for the form
layer sample program.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/FormLayer.java"
title="link to Forms/FormLayer.java">FormLayer</a></td>
<td class="cell80">Helper class for accessing and
manipulating the form layer of a document.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/GridFieldValidator.java"
title="link to Forms/GridFieldValidator.java">GridFieldValidator</a></td>
<td class="cell80"><code>GridFieldValidator</code> is
responsible for validating the input in a specific grid control column.
This is not to be mixed up with the control-based validation as
described in the <a
href="../../docs/common/ref/com/sun/star/form/validation/module-ix.html"
title="link to the reference documentation of com.sun.star.form.validation">validation</a>
module. Instead, a <code>GridFieldValidator</code> assembles and uses
various other concepts.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/InteractionRequest.java"
title="link to Forms/InteractionRequest.java">InteractionRequest</a></td>
<td class="cell80">A simple implementation of a <a
href="../../docs/common/ref/com/sun/star/task/XInteractionRequest.html"
title="link to the reference documentation of com.sun.star.task.XInteractionRequest"><code>XInteractionRequest</code></a>.
Not tied to the form layer example, but a general helper.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/KeyGenerator.java"
title="link to Forms/KeyGenerator.java">KeyGenerator</a></td>
<td class="cell80">Helper class which is able to
generate (unique) keys for a (<a
href="../../docs/common/ref/com/sun/star/sdb/RowSet.html"
title="link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet</code>
</a>) column. An instance of this class can be tied
to a specific row set column. It then monitors the state of the
underlying row set, and upon inserting a new record into it (two
operation modi are possible here), it automatically inserts a newly
created (two modi, too) key into the column.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/ListSelectionValidator.java"
title="link to Forms/ListSelectionValidator.java">ListSelectionValidator</a></td>
<td class="cell80">The class <code>ListSelectionValidator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain selections in a list box
control.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/NumericValidator.java"
title="link to Forms/NumericValidator.java">NumericValidator</a></td>
<td class="cell80">The class <code>NumericValidator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can veto certain values in every control
which allows exchanging numerical values.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/SingleControlValidation.java"
title="link to Forms/SingleControlValidation.java">SingleControlValidation</a></td>
<td class="cell80">Though form documents feature
inbuilt mechanisms for visually indicating invalid control content (see
<a
href="../../docs/common/ref/com/sun/star/form/validation/module-ix.html"
title="link to the reference documentation of com.sun.star.form.validation"><code>com.sun.star.form.validation</code>
</a> for discussions about validity), the <a
href="./Forms/ControlValidation.java"
title="link to Forms/ControlValidation.java">ControlValidation</a>
example extends this. The validity state of every control in this
example, as well as possible explanations for invalidity, are displayed
in dedicated texts. The <code>SingleControlValidation</code> class
ties together a validatable control and those status texts.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/SpreadsheetDocument.java"
title="link to Forms/SpreadsheetDocument.java">SpreadsheetDocument</a></td>
<td class="cell80">A specialized <a
href="./Forms/DocumentHelper.java"
title="link to Forms/DocumentHelper.java"><code>DocumentHelper<code></code></code></a>
which represents a spreadsheet document, and offers some form related
functionality. For instance, this class allows the creation of <a
href="../../docs/common/ref/com/sun/star/table/CellValueBinding.html"
title="link to the reference documentation of com.sun.star.table.CellValueBinding">
<code>CellValueBinding</code></a> instances, which
can be used to couple the content of a form control with the content of
a spreadsheet cell.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Forms/SpreadsheetValueBinding.java"
title="link to Forms/SpreadsheetValueBinding.java">SpreadsheetValueBinding</a></td>
<td class="cell80">This example demonstrates how to
bind form controls to spreadsheet cells.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/SpreadsheetView.java"
title="link to Forms/SpreadsheetView.java">SpreadsheetView</a></td>
<td class="cell80">A specialized <a
href="./Forms/DocumentViewHelper.java"
title="link to Forms/DocumentViewHelper.java"><code>DocumentViewHelper</code></a>
which represents a view to a spreadsheet document.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/TableCellTextBinding.java"
title="link to Forms/TableCellTextBinding.java">TableCellTextBinding</a></td>
<td class="cell80">This class allows binding the
control of a form control with a table cell in a text document. For
this, it uses the mechanisms of the <a
href="../../docs/common/ref/com/sun/star/form/binding/module-ix.html"
title="link to the reference documentation of com.sun.star.form.binding">
<code>com.sun.star.form.binding</code></a> module.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/TextValidator.java"
title="link to Forms/TextValidator.java">TextValidator</a></td>
<td class="cell80">The class <code>TextValidator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can monitor a form text field.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Forms/TimeValidator.java"
title="link to Forms/TimeValidator.java">TimeValidator</a></td>
<td class="cell80">The class <code>TimeValidator</code>
implements an <a
href="../../docs/common/ref/com/sun/star/form/validation/XValidator.html"
title="link to the reference documentation of com.sun.star.form.validation.XValidator">validator</a>
for a form control, which can monitor the content of a form time field.
</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/UNO.java"
title="link to Forms/UNO.java">UNO</a></td>
<td class="cell80">A small UNO-syntax related helper
class.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Forms/ValueBinding.java"
title="link to Forms/ValueBinding.java">ValueBinding</a></td>
<td class="cell80">An example how to bind the content
of a form control to a table cell in a text document.</td>
</tr>
<tr>
<td class="cell20"><a href="./Forms/WaitForInput.java"
title="link to Forms/WaitForInput.java">WaitForInput</a></td>
<td class="cell80">A pretty small helper for the
interactive examples, which notifies another instance when the user
pressed key on the console.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="UniversalContentBroker(UCB)">Universal Content Broker (UCB)
examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/ChildrenRetriever.java"
title="link to UCB/ChildrenRetriever.java">ChildrenRetriever</a></td>
<td class="cell80">Shows child entries of a given
folder. Try -help or -? on the command line to view optional parameters.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/DataStreamComposer.java"
title="link to UCB/DataStreamComposer.java">DataStreamComposer</a></td>
<td class="cell80">Demonstrates usage of the data
stream by copying the data from one UCB node to another.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/DataStreamRetriever.java"
title="link to UCB/DataStreamRetriever.java">DataStreamRetriever</a></td>
<td class="cell80">Shows how to obtain the data
stream from a document resource.</td>
</tr>
<tr>
<td class="cell20"><a href="./UCB/Helper.java"
title="link to UCB/Helper.java">Helper</a></td>
<td class="cell80">Some helper methods to access the
UCB which are used by the other examples.</td>
</tr>
<tr>
<td class="cell20"><a
href="./UCB/MyActiveDataSink.java"
title="link to UCB/MyActiveDataSink.java">MyActiveDataSink</a></td>
<td class="cell80">A helper class for the <code>DataStreamRetriever</code>
example which implements a data sink.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/PropertiesComposer.java"
title="link to UCB/PropertiesComposer.java">PropertiesComposer</a></td>
<td class="cell80">Shows how to set property values
of an UCB resource.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/PropertiesRetriever.java"
title="link to UCB/PropertiesRetriever.java">PropertiesRetriever</a></td>
<td class="cell80">Shows how to access property
values of an UCB resource.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/ResourceCreator.java"
title="link to UCB/ResourceCreator.java">ResourceCreator</a></td>
<td class="cell80">Creates a new file in an existing
file system folder.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/ResourceManager.java"
title="link to UCB/ResourceManager.java">ResourceManager</a></td>
<td class="cell80">Demonstrates how to copy and move
UCB resources.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./UCB/ResourceRemover.java"
title="link to UCB/ResourceRemover.java">ResourceRemover</a></td>
<td class="cell80">Demonstrates how to remove UCB
resources.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Configuration">Configuration
Management examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Config/ConfigExamples.java"
title="link to Config/ConfigExamples.java">ConfigExamples</a></td>
<td class="cell80">This example connects to a
OpenOffice.org %PRODUCT_RELEASE%, gets the configuration manager and accesses the
configuration in various ways.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="OfficeBean">Office
Bean example</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./OfficeBean/OOoBeanViewer.java"
title="link to OfficeBean/OOoBeanViewer.java">OOoBeanViewer</a></td>
<td class="cell80">Shows how to use the <code>OOoBean</code>
embedded in a Java AWT component. It shows how to load and store
documents as well as how to control toolbar visibility.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a name="Accessibility">Accessibility
examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20">Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/ConnectionTask.java"
title="link to Accessibility/ConnectionTask.java">ConnectionTask</a></td>
<td class="cell80">A timer task that tries to
(re-)connect to a running Office application. When it can not detect an
Office application that accepts connections then it waits for some time
and tries again.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/EventHandler.java"
title="link to Accessibility/EventHandler.java">EventHandler</a></td>
<td class="cell80">Handle all events that are used by
this tool. It is called by the EventListenerProxy class with somewhat
preprocessed events.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/EventListenerProxy.java"
title="link to Accessibility/EventListenerProxy.java">EventListenerProxy</a></td>
<td class="cell80">This proxy runs in its own thread
to avoid deadlocks with the Office it listens to. It waits for top
window events to be informed of new or removed top level windows and
for some accessibility events that are relevant to display the
currently focused object.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/GraphicalDisplay.java"
title="link to Accessibility/GraphicalDisplay.java">GraphicalDisplay</a></td>
<td class="cell80">This widget displays a graphical
representation of the currently focused object. The focused object is
painted as a green rectangle and its ancestors as gray rectangles to
give an impression of the relative location of the objects.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/IAccessibleObjectDisplay.java"
title="link to Accessibility/IAccessibleObjectDisplay.java">IAccessibleObjectDisplay</a></td>
<td class="cell80">This interface is implemented by
all classes that display the currently focused object, namely
GraphicalDisplay and TextualDisplay. It allows the owner of the display
classes to tell them to display a specific object: usually the focused
object.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/MessageArea.java"
title="link to Accessibility/MessageArea.java">MessageArea</a></td>
<td class="cell80">A text area that shows messages
about what the tools is currently doing.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/NameProvider.java"
title="link to Accessibility/NameProvider.java">NameProvider</a></td>
<td class="cell80">In contrast to the Java
Accessibility API which uses Strings for event types, roles, states,
and relation types, the UNO Accessibility API uses numbers for this
task. In order to present them to the user in a more readable form this
class returns the string name for each event, role, state, or relation.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/RegistrationThread.java"
title="link to Accessibility/RegistrationThread.java">RegistrationThread</a></td>
<td class="cell80">When a new window appears or an
existing one is removed the tool registers or unregisters at all the
window's children as accessibility event listener. This is handled by
RegistrationThread objects in their own threads so that the user
interface is not blocked.</td>
</tr>
<tr>
<td class="cell20"><img
src="../../docs/images/bluball.gif"> <a
href="./Accessibility/SSR.java" title="link to Accessibility/SSR.java">SSR</a></td>
<td class="cell80">The main class sets up the user
interface and starts the ConnectionTask object that eventually will
initiate a connection to a running Office application and in turn will
create RegistrationThread objects to register at all Office windows as
accessibility event listener and thus gets informed about the currently
focused object.</td>
</tr>
<tr>
<td class="cell20"><a
href="./Accessibility/TextualDisplay.java"
title="link to Accessibility/TextualDisplay.java">TextualDisplay</a></td>
<td class="cell80">Show some textual information
about the currently focused object like its name, description, and role.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="ScriptingFramework">Scripting Framework Examples</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><a
href="./ScriptingFramework/SayHello/SayHello/SayHello.java"
title="link to ScriptingFramework/SayHello/SayHello/SayHello.java">SayHello</a></td>
<td class="cell80">A Scripting Framework Java macro
that opens a new Writer document and inserts the word Hello in it.</td>
</tr>
<tr>
<td class="cell20"><a
href="./ScriptingFramework/ScriptSelector/ScriptSelector/ScriptSelector.java"
title="link to ScriptingFramework/ScriptSelector/ScriptSelector/ScriptSelector.java">ScriptSelector</a></td>
<td class="cell80">A Scripting Framework Java macro
that opens a Java Swing dialog with a tree view of the macro hierarchy
for the Office application.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td class="content1"><img class="nothing8"
src="../../docs/images/nada.gif"></td>
<td>
<table class="table2">
<tbody>
<tr>
<td>
<table class="table3">
<tbody>
<tr>
<td colspan="2" class="head1"><a
name="GraphicalUserInterfaces">Graphical User Interfaces</a></td>
<td align="right"> <a href="#examples"
title="link to the Developer's Guide examples overview"><img
class="navigate" src="../../docs/images/nav_up.png"></a> <a
href="../../index.html" title="link to the SDK start page"><img
class="navigate" src="../../docs/images/nav_home.png"></a> </td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="table4">
<tbody>
<tr class="thead">
<td class="cell20"> Example</td>
<td class="cell80">Description</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/DialogDocument.java" title="link to GUI/DialogDocument.java">DialogDocument</a></td>
<td class="cell80">A sample showing how to display an office document in a dialog window.</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/Messagebox.java" title="link to GUI/MessageBox.java">MessageBox</a></td>
<td class="cell80">A sample showing how to display a simple message box.</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/UnoDialogSample.java" title="link to GUI/UnoDialogSample.java">UnoDialogSample</a></td>
<td class="cell80">A sample showing how to create various controls in a dialog (fixed text field, currency field, progress bar, fixed line, group box, edit field, time field, date field, pattern field, numeric field, progressbar, check box, radio button, list box, combo box, formatted field, file control, button control, roadmap control)</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/UnoDialogSample2.java" title="link to GUI/UnoDialogSample2.java">UnoDialogSample2</a></td>
<td class="cell80">A dialog sample showing how to use a roadmap control.</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/UnoMenu.java" title="link to GUI/UnoMenu.java">UnoMenu</a></td>
<td class="cell80">A sample showing a top window with some menus.</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/UnoMenu2.java" title="link to GUI/UnoMenu2.java">UnoMenu2</a></td>
<td class="cell80">A dialog sample showing how to use or work with a context menu.</td>
</tr>
<tr>
<td class="cell20"><img src="../../docs/images/bluball.gif">
<a href="./GUI/ImageControlSample.java" title="link to GUI/ImageControlSample.java">ImageControlSample2</a></td>
<td class="cell80">Dialog sample showing how to use an image control.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td colspan="3"><img class="nothing30"
src="../../docs/images/nada.gif"></td>
</tr>
<tr>
<td colspan="3"><img class="line"
src="../../docs/images/sdk_line-1.gif"></td>
</tr>
<tr>
<td colspan="3">
<div class="centertext">
<p><img class="apachelogo" src="../../docs/images/odk-footer-logo.gif" title="Apache Feather" alt="Apache Feather" />
Copyright &copy; 2011 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.<p>
</div>
</td>
</tr>
</table>
<map name="Map">
<area shape="rect" coords="10,68,400,105" href="http://www.openoffice.org">
</map>
</body>
</html>