Apache OpenOffice Wiki - User contributions [en]

Documentation/DevGuide/Extensions/Example

2010-05-12T10:30:58Z

Tkr: remove deploymenthooks

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Localized XML Elements
|NextPage=Documentation/DevGuide/Extensions/Display Name
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Example}}

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006"
xmlns:d="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">

<version value="1.0" />

<identifier value="com.mycompany.extensions.my_extension" />

<platform value="windows_x86,solaris_sparc" />

<dependencies>
<OpenOffice.org-minimal-version value="3.3" d:name="OpenOffice.org 3.3"/>
</dependencies>

<update-information>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/license/update/lic3.update.xml" />
</update-information>

<registration>
<simple-license accept-by="admin" suppress-on-update="true" >
<license-text xlink:href="registration/license_de-DE.txt" lang="de-DE" />
<license-text xlink:href="registration/license_en-GB.txt" lang="en-GB" />
<license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" />
<license-text xlink:href="registration/license_en-US.txt" lang="en-US" />
</simple-license>
</registration>

<publisher>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_de.html"
lang="de">My OpenOffice de</name>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_en.html"
lang="en">My OpenOffice en</name>
</publisher>

<release-notes>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_de.txt" lang="de" />
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_en.txt" lang="en" />
</release-notes>

<display-name>
<name lang="de">Meine tolle extensions</name>
<name lang="en">My great extension</name>
</display-name>

<icon>
<default xlink:href="images/icon.png" />
<high-contrast xlink:href="images/icon_hc.png" />
</icon>

<extension-description>
<src xlink:href="description/desc_de.txt" lang="de" />
<src xlink:href="description/desc_en.txt" lang="en" />
</extension-description>

</description>
</source>

This ''description.xml'' contains:

* The '''[[Documentation/DevGuide/Extensions/Extension Versions |version]]''' is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]].
* The '''[[Documentation/DevGuide/Extensions/Extension Identifiers|identifier]]''' is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]]
* The '''[[Documentation/DevGuide/Extensions/Target Platform|platforms]]''' on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]]
* There is a '''[[Documentation/DevGuide/Extensions/Dependencies|dependency]]''' for OpenOffice.org 3.3 and higher. That is, the minimum version with which the extension works is 3.3.[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]
* It supports the '''[[Documentation/DevGuide/Extensions/Online Update of Extensions|update]]''' feature and update information can be obtained at the specified address. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]
* A '''[[Documentation/DevGuide/Extensions/Simple License|license]]''' text is displayed displayed during installation. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to XML description]]]
* There are two localized versions of a '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher name]]''' and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]]
* There are two links to '''release notes''' in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to XML description]]]
* There is a localized '''[[Documentation/DevGuide/Extensions/Display Name|display name]]'''. That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to XML description]]]
* The extension contains '''icons''' which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]]
* A localized [[Documentation/DevGuide/Extensions/Extension Description|'''description''']] is displayed in the Extension Manager's dialog. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|[go to XML description]]]

Please note that the <publisher> and <release-notes> elements in a ''description.xml'' are currently not used by the Extension Manager. However, when uploading the extension to the extensions repository (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays this information (OOo 2.4).

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Extension DeploymentHooks

2010-05-12T10:29:55Z

Tkr: add warning

{{Documentation/DevGuide/ExtensionsTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Icon
|NextPage=Documentation/DevGuide/Extensions/Extension Identifiers
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Extension DeploymentHooks}}

{{Documentation/Caution| The interface com.sun.star.deployment.XDeploymentHooks is currently not supported in any release.}}

An extension may implement <idl>com.sun.star.deployment.XDeploymentHooks</idl> to get a notification during the install and uninstall process.

'''See also'''
*[[Documentation/DevGuide/Extensions/Description of XML Elements|XML description for description.xml]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]
[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Description of XML Elements

2010-05-12T10:23:22Z

Tkr: remove deploymenthooks

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/description.xml
|NextPage=Documentation/DevGuide/Extensions/Localized XML Elements
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Description of XML Elements}}
__NOTOC__
==== Element <code>/description</code> ====
* Parent element: document root
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|<identifier>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|<version>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|<platform>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|<registration>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|<update-information>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|<publisher>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|<release-notes>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|<display-name>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|<extension-description>]]</code>
*Since: OOo 2.0.4

<code><description></code> is the root element of the ''description.xml''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><description></code>
!Attribute
!Description
|-
|<code>xmlns</code>
|The default namespace of element description and all children must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>xmlns:dep</code>
|The namespace for dependency information must also be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>xmlns:xlink</code>
|The xlink namespace must be defined as
http://www.w3.org/1999/xlink
|-
|other namespace definitions
|Other namespaces can be added as necessary
|}

==== Element <code>/description/identifier</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children: none
*Since: OOo 2.2

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><identifier></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. The extension identifier.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Identifiers |Extension Identifiers]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/version</code> ====
*Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
*Children: none
*Since: OOo 2.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><version></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. A textual representation of the extension version.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Versions|Extension Versions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/platform</code> ====
*Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
*Children: none
*Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><platform></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. A token representing a particular platform. See [[Documentation/DevGuide/Extensions/Target Platform|Target Platform]] for details.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Target Platform|Target Platform]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license|<simple-license>]]</code>
* Since: OOo 2.0.4
The registration element currently only contains the <code><simple-license></code> element. If the <code><registration></code> element exists, then it must have a child element.

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration/simple-license</code> ====
Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|<registration>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license/license-text|<license-text>]]</code>
* Since: OOo 2.0.4
The element contains the <code><license-text></code> elements, determines if all user must agree to the license, or just the person who installs it, and determines a default <code><license-text></code> element. The mechanism for determining a "default" has changed in OOo 2.4. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details. This element is disregarded for bundled extensions.

If the <code><simple-license></code> element exists, then it must have at least one child element.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><simple-license></code>
!Attribute
!Description
|-
|<code>accept-by</code>
|<code>Required.Value</code> is either “user” or “admin”. “user” means that every user has to agree to the license. That is, the extension can only be installed as user extension but not as shared extension. If it has the value “admin” then it can be deployed as shared extension as well. In that case only the person who installs it has to agree to the license. Individual users will not be asked to accept the license. They can use the extension right away. In case the value is “user” and the extension is being installed as user extension then the user must always agree to the license. By using <code>suppress-if-required=“true“</code> it is, however, possible to install an extension for all users, that is, as shared extension, even if <code>accept-by=“user“</code>.
|-
|<code>default-license-id</code>
|Required. Since OOo 2.4 this attribute is '''obsolete'''. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency with a value of '2.4'.
The attribute determines what <license-text> is used if no <license-text> element has a lang attribute whose value matches the locals of {{PRODUCTNAME}}. There must always be exactly one <code><license-text></code> element with a license-id attribute whose value matches that of the default-license-id. The type is <code>xsd:IDREF</code>.
|-
|<code>suppress-on-update</code>
|Optional. When the attribute is not provided then the value “false” is assumed. The value true indicates that the license for this extension will not be displayed during installation when the same extension (same id but probably different version) is already installed. This applies for the automatic update as well as for manually installing an extension. The version of the already installed extension does not matter. Suppressing the license can be useful during the online update, because otherwise the update operation could be interrupted by many license dialogs.
|-
|<code>suppress-if-required</code>
|Optional. Since 3.3. When the attribute is not provided then the value “false” is assumed. The value “true“ indicates that the license will not be displayed during installation if this is desired, which can be expressed by the unopkg switch <code>--suppress-license</code> and is implicitely assumed for bundled extensions.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration/simple-license/license-text</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license|<simple-license>]]</code>
* Child elements: none
* Since: OOo 2.0.4

The element contains information about where to find the file containing the license text, which language it uses, and if this element is the “default” <code><license-text></code>. The mechanism for determining a "default" has changed in OOo 2.4. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><license-text></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a relative URL to the license file within the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|-
|<code>license-id</code>
|Optional. Since OOo 2.4 this attribute is '''obsolete'''. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency with a value of '2.4'.
One license-text element must have this attribute and the value must match the value of the default-license-id attribute of the <code><simple-license></code> element. The type is <code>xsd:ID</code>.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|<OpenOffice.org-minimal-version>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-maximal-version|<OpenOffice.org-maximal-version>]]</code>
** others
* Since: OOo 2.0.4

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies/OpenOffice.org-minimal-version</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
* Children: none
* Since: OOo 2.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><OpenOffice.org-minimal-version></code>
!Attribute
!Description
|-
|<code>xmlns:dep</code>
|The namespace for dependency information (inherited from <code><description></code>) must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>dep:name</code>
|Required. Descriptive string that will be displayed. Example : “OpenOffice.org value” (where value is the value of the attribute value).
|-
|<code>dep:OpenOffice.org-minimal-version</code>
|Optional. This attribute should never be used with this element.
|-
|<code>value</code>
|Required. String. The required underlying OpenOffice.org version (“2.1”, “2.2”, etc.), starting with OpenOffice.org 2.1. You should not specify a particular micro version, e.g. “2.2.1”, use “2.2” instead.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies/OpenOffice.org-maximal-version</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
* Children: none
* Since: OOo 3.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><OpenOffice.org-maximal-version></code>
!Attribute
!Description
|-
|<code>xmlns:dep</code>
|The namespace for dependency information (inherited from <code><description></code>) must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>dep:name</code>
|Required. Descriptive string that will be displayed. Example : “OpenOffice.org value or older” (where value is the value of the attribute value).
|-
|<code>dep:OpenOffice.org-minimal-version</code>
|Optional. This attribute should always be defined as “2.3” for this element.
|-
|<code>value</code>
|Required. The required maximal underlying OpenOffice.org version (“3.0”, “3.1”, etc.). You must not specify a particular micro version, e.g. “3.1.1”, use “3.1” instead.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]

==== Element <code>/description/update-information</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information/src|<src>]]</code>
* Since: OOo 2.2

<code><update-information></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information/src|<src>]]</code> child element. The second, third, etc. element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to get update information by using a URL and only use a different URL if an error occurred. That is, if for example the first URL references an atom feed that does not contain any references at all, but is a valid feed, then the Extension Manager assumes that there are no update information available. Then URLs from other <code><src></code> elements are not examined. Therefore the update information referenced by every URL must be identical.

'''See also'''
*[[Documentation/DevGuide/Extensions/Online Update of Extensions|Online Update of Extensions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/update-information/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|<update-information>]]</code>
* Children: none
* Since: OOo 2.2

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL which provides the update information directly or an atom feed which in turn references the update information. The URL can point directly to a file or it may invoke code, such as a servlet, cgi, etc, that returns the atom feed or the update information.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Online Update of Extensions|Online Update of Extensions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/publisher</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher/name|<name>]]</code>
* Since: OOo 2.4

<code><publisher></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher/name|<name>]]</code> child element. The children of this element provide a [[Documentation/DevGuide/Extensions/Localized XML Elements|localized publisher name]] together with a URL.

'''See also'''
*[[Documentation/DevGuide/Extensions/Publisher Information|Publisher Information]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/publisher/name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|<publisher>]]</code>
* Children: Text
* Since: OOo 2.4

The text value of this element is the ''publisher name''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><name></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL to the web site of the publisher of the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Publisher Information|Publisher Information]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/release-notes</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes/src|<src>]]</code>
* Since: OOo 2.4

<code><release-notes></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes/src|<src>]]</code> child element. The children provide URLs to [[Documentation/DevGuide/Extensions/Localized XML Elements|localized release-notes]].

Currently this element and its children are not used by the Extension Manager.

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/release-notes/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|<release-notes>]]</code>
* Children: none
* Since: OOo 2.4

The element contains a URL to the ''release notes''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL to the release notes of the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/display-name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name/name|<name>]]</code>
* Since: OOo 2.4

<code><display-name></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name/name|<name>]]</code> child element. The children of this element provide a [[Documentation/DevGuide/Extensions/Localized XML Elements|localized display name]]. The name will be used in the GUI instead of the file name.

'''See also'''
*[[Documentation/DevGuide/Extensions/Display Name|Display Name]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/display-name/name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|<display-name>]]</code>
* Children: Text
* Since: OOo 2.4

The text value of this element is the ''display name'' of the extension. The string length must be greater then null and must not only contain white space characters.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><name></code> ||
!Attribute
!Description
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Display Name|Display Name]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon/default|<default>]]</code>
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon/high-contrast|<high-contrast>]]</code>
* Since: OOo 3.0

'''See also'''
*[[Documentation/DevGuide/Extensions/Icon|Icon]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon/default</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
* Children: none
* Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><default></code> ||
!Attribute
!Description
|-
|<code>xlink:href</code>
|The value is a relative URL to the icon file within the extension.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon/high-contrast</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
* Children: none
* Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><high-contrast></code> ||
!Attribute
!Description
|-
|<code>xlink:href</code>
|The value is a relative URL to the icon file within the extension.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/extension-description</code> ====
Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description/src|<src>]]</code>
* Since: OOo 3.1
<extension-description> must have at least on [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description/src|<src>]] child element. Every child references a localized description. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details.

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Description|Extension Description]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/extension-description/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|<extension-description>]]</code>
* Child elements: none
* Since: OOo 3.1

The element contains information about where to find the file containing the description text and which language it uses.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a relative URL to the description file within the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Description|Extension Description]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Extension DeploymentHooks

2010-02-08T07:57:13Z

Tkr: Created page with '{{Documentation/DevGuide/ExtensionsTOC |ShowPrevNext=block |PrevPage=Documentation/DevGuide/Extensions/Icon |NextPage=Documentation/DevGuide/Extensions/Extension Identifiers }} {…'

{{Documentation/DevGuide/ExtensionsTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Icon
|NextPage=Documentation/DevGuide/Extensions/Extension Identifiers
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Extension DeploymentHooks}}

An extension may implement <idl>com.sun.star.deployment.XDeploymentHooks</idl> to get a notification during the install and uninstall process.

'''See also'''
*[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/deploymentHooks|XML description for description.xml]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

Documentation/DevGuide/Extensions/Example

2010-02-08T07:42:10Z

Tkr:

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Localized XML Elements
|NextPage=Documentation/DevGuide/Extensions/Display Name
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Example}}

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006"
xmlns:d="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">

<version value="1.0" />

<identifier value="com.mycompany.extensions.my_extension" />

<deploymentHooks service="com.mycompany.extensions.my_extension" />

<platform value="windows_x86,solaris_sparc" />

<dependencies>
<OpenOffice.org-minimal-version value="3.3" d:name="OpenOffice.org 3.3"/>
</dependencies>

<update-information>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/license/update/lic3.update.xml" />
</update-information>

<registration>
<simple-license accept-by="admin" suppress-on-update="true" >
<license-text xlink:href="registration/license_de-DE.txt" lang="de-DE" />
<license-text xlink:href="registration/license_en-GB.txt" lang="en-GB" />
<license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" />
<license-text xlink:href="registration/license_en-US.txt" lang="en-US" />
</simple-license>
</registration>

<publisher>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_de.html"
lang="de">My OpenOffice de</name>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_en.html"
lang="en">My OpenOffice en</name>
</publisher>

<release-notes>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_de.txt" lang="de" />
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_en.txt" lang="en" />
</release-notes>

<display-name>
<name lang="de">Meine tolle extensions</name>
<name lang="en">My great extension</name>
</display-name>

<icon>
<default xlink:href="images/icon.png" />
<high-contrast xlink:href="images/icon_hc.png" />
</icon>

<extension-description>
<src xlink:href="description/desc_de.txt" lang="de" />
<src xlink:href="description/desc_en.txt" lang="en" />
</extension-description>

</description>
</source>

This ''description.xml'' contains these information:

* The '''[[Documentation/DevGuide/Extensions/Extension Versions |version]]''' is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]].
* The '''[[Documentation/DevGuide/Extensions/Extension Identifiers|identifier]]''' is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]]
* The '''[[Documentation/DevGuide/Extensions/Target Platform|platforms]]''' on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]]
* There is a '''[[Documentation/DevGuide/Extensions/Dependencies|dependency]]''' for OpenOffice.org 3.3 and higher. That is, the minimum version with which the extension works is 3.3.[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]
* It supports the '''[[Documentation/DevGuide/Extensions/Online Update of Extensions|update]]''' feature and update information can be obtained at the specified address. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]
* A '''[[Documentation/DevGuide/Extensions/Simple License|license]]''' text is displayed displayed during installation. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to XML description]]]
* There are two localized versions of a '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher name]]''' and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]]
* There are two links to '''release notes''' in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to XML description]]]
* There is a localized '''[[Documentation/DevGuide/Extensions/Display Name|display name]]'''. That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to XML description]]]
* The extension contains '''icons''' which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]]
* A localized [[Documentation/DevGuide/Extensions/Extension Description|'''description''']] is displayed in the Extension Manager's dialog. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|[go to XML description]]]
* [[Documentation/DevGuide/Extensions/Extension DeploymentHooks|'''Deployment hooks''']] are entry points for extension programmers. These hooks are called after the extension was installed and right before the extension will uninstall. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/deploymentHooks|[go to XML description]]]

Please note that the <publisher> and <release-notes> elements in a ''description.xml'' are currently not used by the Extension Manager. However, when uploading the extension to the extensions repository (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Example

2010-02-08T07:40:13Z

Tkr:

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Localized XML Elements
|NextPage=Documentation/DevGuide/Extensions/Display Name
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Example}}

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006"
xmlns:d="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">

<version value="1.0" />

<identifier value="com.mycompany.extensions.my_extension" />

<deploymentHooks service="com.mycompany.extensions.my_extension" />

<platform value="windows_x86,solaris_sparc" />

<dependencies>
<OpenOffice.org-minimal-version value="3.3" d:name="OpenOffice.org 3.3"/>
</dependencies>

<update-information>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/license/update/lic3.update.xml" />
</update-information>

<registration>
<simple-license accept-by="admin" suppress-on-update="true" >
<license-text xlink:href="registration/license_de-DE.txt" lang="de-DE" />
<license-text xlink:href="registration/license_en-GB.txt" lang="en-GB" />
<license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" />
<license-text xlink:href="registration/license_en-US.txt" lang="en-US" />
</simple-license>
</registration>

<publisher>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_de.html"
lang="de">My OpenOffice de</name>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_en.html"
lang="en">My OpenOffice en</name>
</publisher>

<release-notes>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_de.txt" lang="de" />
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_en.txt" lang="en" />
</release-notes>

<display-name>
<name lang="de">Meine tolle extensions</name>
<name lang="en">My great extension</name>
</display-name>

<icon>
<default xlink:href="images/icon.png" />
<high-contrast xlink:href="images/icon_hc.png" />
</icon>

<extension-description>
<src xlink:href="description/desc_de.txt" lang="de" />
<src xlink:href="description/desc_en.txt" lang="en" />
</extension-description>

</description>
</source>

This ''description.xml'' contains these information:

* The '''[[Documentation/DevGuide/Extensions/Extension Versions |version]]''' is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]].
* The '''[[Documentation/DevGuide/Extensions/Extension Identifiers|identifier]]''' is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]]
* The '''[[Documentation/DevGuide/Extensions/Target Platform|platforms]]''' on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]]
* There is a '''[[Documentation/DevGuide/Extensions/Dependencies|dependency]]''' for OpenOffice.org 3.3 and higher. That is, the minimum version with which the extension works is 3.3.[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]
* It supports the '''[[Documentation/DevGuide/Extensions/Online Update of Extensions|update]]''' feature and update information can be obtained at the specified address. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]
* A '''[[Documentation/DevGuide/Extensions/Simple License|license]]''' text is displayed displayed during installation. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to XML description]]]
* There are two localized versions of a '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher name]]''' and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]]
* There are two links to '''release notes''' in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to XML description]]]
* There is a localized '''[[Documentation/DevGuide/Extensions/Display Name|display name]]'''. That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to XML description]]]
* The extension contains '''icons''' which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]]
* A localized [[Documentation/DevGuide/Extensions/Extension Description|'''description''']] is displayed in the Extension Manager's dialog. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|[go to XML description]]]
* '''Deployment hooks''' are entry points for extension programmers. These hooks are called after the extension was installed and right before the extension will uninstall. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/deploymentHooks|[go to XML description]]]

Please note that the <publisher> and <release-notes> elements in a ''description.xml'' are currently not used by the Extension Manager. However, when uploading the extension to the extensions repository (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Description of XML Elements

2010-02-08T07:38:53Z

Tkr:

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/description.xml
|NextPage=Documentation/DevGuide/Extensions/Localized XML Elements
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Description of XML Elements}}
__NOTOC__
==== Element <code>/description</code> ====
* Parent element: document root
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|<identifier>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|<version>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|<platform>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|<registration>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|<update-information>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|<publisher>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|<release-notes>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|<display-name>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|<extension-description>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/deploymentHooks|<deploymentHooks>]]</code>
*Since: OOo 2.0.4

<code><description></code> is the root element of the ''description.xml''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><description></code>
!Attribute
!Description
|-
|<code>xmlns</code>
|The default namespace of element description and all children must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>xmlns:dep</code>
|The namespace for dependency information must also be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>xmlns:xlink</code>
|The xlink namespace must be defined as
http://www.w3.org/1999/xlink
|-
|other namespace definitions
|Other namespaces can be added as necessary
|}

==== Element <code>/description/identifier</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children: none
*Since: OOo 2.2

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><identifier></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. The extension identifier.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Identifiers |Extension Identifiers]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/version</code> ====
*Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
*Children: none
*Since: OOo 2.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><version></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. A textual representation of the extension version.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Versions|Extension Versions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/platform</code> ====
*Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
*Children: none
*Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><platform></code>
!Attribute
!Description
|-
|<code>value</code>
|Required. A token representing a particular platform. See [[Documentation/DevGuide/Extensions/Target Platform|Target Platform]] for details.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Target Platform|Target Platform]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license|<simple-license>]]</code>
* Since: OOo 2.0.4
The registration element currently only contains the <code><simple-license></code> element. If the <code><registration></code> element exists, then it must have a child element.

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration/simple-license</code> ====
Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|<registration>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license/license-text|<license-text>]]</code>
* Since: OOo 2.0.4
The element contains the <code><license-text></code> elements, determines if all user must agree to the license, or just the person who installs it, and determines a default <code><license-text></code> element. The mechanism for determining a "default" has changed in OOo 2.4. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details.

If the <code><simple-license></code> element exists, then it must have at least one child element.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><simple-license></code>
!Attribute
!Description
|-
|<code>accept-by</code>
|<code>Required.Value</code> is either “user” or “admin”. “user” means that every user has to agree to the license. That is, the extension can only be installed as user extension but not as shared extension. If it has the value “admin” then it can be deployed as shared extension as well. In that case only the person who installs it has to agree to the license. Individual users will not be asked to accept the license. They can use the extension right away. In case the value is “user” and the extension is being installed as user extension then the user must always agree to the license.
|-
|<code>default-license-id</code>
|Required. Since OOo 2.4 this attribute is '''obsolete'''. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency with a value of '2.4'.
The attribute determines what <license-text> is used if no <license-text> element has a lang attribute whose value matches the locals of {{PRODUCTNAME}}. There must always be exactly one <code><license-text></code> element with a license-id attribute whose value matches that of the default-license-id. The type is <code>xsd:IDREF</code>.
|-
|<code>suppress-on-update</code>
|Optional. When the attribute is not provided then the value “false” is assumed. The value true indicates that the license for this extension will not be displayed during installation when the same extension (same id but probably different version) is already installed. This applies for the automatic update as well as for manually installing an extension. The version of the already installed extension does not matter. Suppressing the license can be useful during the online update, because otherwise the update operation could be interrupted by many license dialogs.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/registration/simple-license/license-text</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration/simple-license|<simple-license>]]</code>
* Child elements: none
* Since: OOo 2.0.4

The element contains information about where to find the file containing the license text, which language it uses, and if this element is the “default” <code><license-text></code>. The mechanism for determining a "default" has changed in OOo 2.4. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><license-text></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a relative URL to the license file within the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|-
|<code>license-id</code>
|Optional. Since OOo 2.4 this attribute is '''obsolete'''. If the extension should work properly (regarding showing the proper license during installation) on versions prior 2.4 one must use this attribute. If one does not use this attribute then one should use the [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|OpenOffice.org-minimal-version]] dependency with a value of '2.4'.
One license-text element must have this attribute and the value must match the value of the default-license-id attribute of the <code><simple-license></code> element. The type is <code>xsd:ID</code>.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Simple License|Simple License]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-minimal-version|<OpenOffice.org-minimal-version>]]</code>
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies/OpenOffice.org-maximal-version|<OpenOffice.org-maximal-version>]]</code>
** others
* Since: OOo 2.0.4

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies/OpenOffice.org-minimal-version</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
* Children: none
* Since: OOo 2.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><OpenOffice.org-minimal-version></code>
!Attribute
!Description
|-
|<code>xmlns:dep</code>
|The namespace for dependency information (inherited from <code><description></code>) must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>dep:name</code>
|Required. Descriptive string that will be displayed. Example : “OpenOffice.org value” (where value is the value of the attribute value).
|-
|<code>dep:OpenOffice.org-minimal-version</code>
|Optional. This attribute should never be used with this element.
|-
|<code>value</code>
|Required. String. The required underlying OpenOffice.org version (“2.1”, “2.2”, etc.), starting with OpenOffice.org 2.1. You cannot specify a particular corrective version, e.g. “2.2.1”, use “2.2” instead.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/dependencies/OpenOffice.org-maximal-version</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|<dependencies>]]</code>
* Children: none
* Since: OOo 3.1

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><OpenOffice.org-maximal-version></code>
!Attribute
!Description
|-
|<code>xmlns:dep</code>
|The namespace for dependency information (inherited from <code><description></code>) must be defined as
http://openoffice.org/extensions/description/2006
|-
|<code>dep:name</code>
|Required. Descriptive string that will be displayed. Example : “OpenOffice.org value or older” (where value is the value of the attribute value).
|-
|<code>dep:OpenOffice.org-minimal-version</code>
|Optional. This attribute should always be defined as “2.3” for this element.
|-
|<code>value</code>
|Required. The required maximal underlying OpenOffice.org version (“3.0”, “3.1”, etc.). You cannot specify a particular corrective version, e.g. “3.1.1”, use “3.1” instead.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Dependencies|Dependencies]]

==== Element <code>/description/update-information</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information/src|<src>]]</code>
* Since: OOo 2.2

<code><update-information></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information/src|<src>]]</code> child element. The second, third, etc. element are regarded as fallback, that is, the elements provide URLs to mirrors. The Extension Manager will try to get update information by using a URL and only use a different URL if an error occurred. That is, if for example the first URL references an atom feed that does not contain any references at all, but is a valid feed, then the Extension Manager assumes that there are no update information available. Then URLs from other <code><src></code> elements are not examined. Therefore the update information referenced by every URL must be identical.

'''See also'''
*[[Documentation/DevGuide/Extensions/Online Update of Extensions|Online Update of Extensions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/update-information/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|<update-information>]]</code>
* Children: none
* Since: OOo 2.2

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL which provides the update information directly or an atom feed which in turn references the update information. The URL can point directly to a file or it may invoke code, such as a servlet, cgi, etc, that returns the atom feed or the update information.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Online Update of Extensions|Online Update of Extensions]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/publisher</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher/name|<name>]]</code>
* Since: OOo 2.4

<code><publisher></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher/name|<name>]]</code> child element. The children of this element provide a [[Documentation/DevGuide/Extensions/Localized XML Elements|localized publisher name]] together with a URL.

'''See also'''
*[[Documentation/DevGuide/Extensions/Publisher Information|Publisher Information]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/publisher/name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|<publisher>]]</code>
* Children: Text
* Since: OOo 2.4

The text value of this element is the ''publisher name''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><name></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL to the web site of the publisher of the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Publisher Information|Publisher Information]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/release-notes</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes/src|<src>]]</code>
* Since: OOo 2.4

<code><release-notes></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes/src|<src>]]</code> child element. The children provide URLs to [[Documentation/DevGuide/Extensions/Localized XML Elements|localized release-notes]].

Currently this element and its children are not used by the Extension Manager.

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/release-notes/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|<release-notes>]]</code>
* Children: none
* Since: OOo 2.4

The element contains a URL to the ''release notes''.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a URL to the release notes of the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/display-name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name/name|<name>]]</code>
* Since: OOo 2.4

<code><display-name></code> must have at least one <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name/name|<name>]]</code> child element. The children of this element provide a [[Documentation/DevGuide/Extensions/Localized XML Elements|localized display name]]. The name will be used in the GUI instead of the file name.

'''See also'''
*[[Documentation/DevGuide/Extensions/Display Name|Display Name]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/display-name/name</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|<display-name>]]</code>
* Children: Text
* Since: OOo 2.4

The text value of this element is the ''display name'' of the extension. The string length must be greater then null and must not only contain white space characters.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><name></code> ||
!Attribute
!Description
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Display Name|Display Name]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon/default|<default>]]</code>
**<code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon/high-contrast|<high-contrast>]]</code>
* Since: OOo 3.0

'''See also'''
*[[Documentation/DevGuide/Extensions/Icon|Icon]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon/default</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
* Children: none
* Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><default></code> ||
!Attribute
!Description
|-
|<code>xlink:href</code>
|The value is a relative URL to the icon file within the extension.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/icon/high-contrast</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|<icon>]]</code>
* Children: none
* Since: OOo 3.0

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><high-contrast></code> ||
!Attribute
!Description
|-
|<code>xlink:href</code>
|The value is a relative URL to the icon file within the extension.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/extension-description</code> ====
Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children:
** <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description/src|<src>]]</code>
* Since: OOo 3.1
<extension-description> must have at least on [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description/src|<src>]] child element. Every child references a localized description. See [[Documentation/DevGuide/Extensions/Localized XML Elements]] for details.

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Description|Extension Description]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/extension-description/src</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|<extension-description>]]</code>
* Child elements: none
* Since: OOo 3.1

The element contains information about where to find the file containing the description text and which language it uses.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><src></code>
!Attribute
!Description
|-
|<code>xlink:href</code>
|Required. The value is a relative URL to the description file within the extension.
|-
|<code>lang</code>
|Required. A language identifier according to RFC 3066. See also [[Documentation/DevGuide/Extensions/Localized XML Elements]].
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension Description|Extension Description]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

==== Element <code>/description/deploymentHooks</code> ====
* Parent: <code>[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description|<description>]]</code>
* Children: none
*Since: OOo 3.3

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
|+ Attributes of <code><deploymentHooks></code>
!Attribute
!Description
|-
|<code>service</code>
|Required. The service identifier which implements the XDeploymentHooks interface.
|}

'''See also'''
*[[Documentation/DevGuide/Extensions/Extension DeploymentHooks|Extension DeploymentHooks]]
*[[Documentation/DevGuide/Extensions/Example|Example of description.xml]]

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

Documentation/DevGuide/Extensions/Example

2010-02-08T07:31:23Z

Tkr:

{{Documentation/DevGuide/ExtensionsTOC
|Extensions2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Extensions/Localized XML Elements
|NextPage=Documentation/DevGuide/Extensions/Display Name
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Extensions/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Example}}

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<description xmlns="http://openoffice.org/extensions/description/2006"
xmlns:d="http://openoffice.org/extensions/description/2006"
xmlns:xlink="http://www.w3.org/1999/xlink">

<version value="1.0" />

<identifier value="com.mycompany.extensions.my_extension" />

<deploymentHooks service="com.mycompany.extensions.my_extension" />

<platform value="windows_x86,solaris_sparc" />

<dependencies>
<OpenOffice.org-minimal-version value="3.3" d:name="OpenOffice.org 3.3"/>
</dependencies>

<update-information>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/license/update/lic3.update.xml" />
</update-information>

<registration>
<simple-license accept-by="admin" suppress-on-update="true" >
<license-text xlink:href="registration/license_de-DE.txt" lang="de-DE" />
<license-text xlink:href="registration/license_en-GB.txt" lang="en-GB" />
<license-text xlink:href="registration/license_en-NZ.txt" lang="en-NZ" />
<license-text xlink:href="registration/license_en-US.txt" lang="en-US" />
</simple-license>
</registration>

<publisher>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_de.html"
lang="de">My OpenOffice de</name>
<name xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/publisher_en.html"
lang="en">My OpenOffice en</name>
</publisher>

<release-notes>
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_de.txt" lang="de" />
<src xlink:href="http://extensions.openoffice.org/testarea/desktop/publisher/release-notes_en.txt" lang="en" />
</release-notes>

<display-name>
<name lang="de">Meine tolle extensions</name>
<name lang="en">My great extension</name>
</display-name>

<icon>
<default xlink:href="images/icon.png" />
<high-contrast xlink:href="images/icon_hc.png" />
</icon>

<extension-description>
<src xlink:href="description/desc_de.txt" lang="de" />
<src xlink:href="description/desc_en.txt" lang="en" />
</extension-description>

</description>
</source>

This ''description.xml'' contains these information:

* The '''[[Documentation/DevGuide/Extensions/Extension Versions |version]]''' is 1.0. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/version|[go to XML description]]].
* The '''[[Documentation/DevGuide/Extensions/Extension Identifiers|identifier]]''' is: ''com.mycompany.extensions.my_extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/identifier|[go to XML description]]]
* The '''[[Documentation/DevGuide/Extensions/Target Platform|platforms]]''' on which the extension can be installed only are Windows (x86 CPU) and Solaris (SPARC CPU). [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/platform|[go to XML description]]]
* There is a '''[[Documentation/DevGuide/Extensions/Dependencies|dependency]]''' for OpenOffice.org 3.3 and higher. That is, the minimum version with which the extension works is 3.3.[[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/dependencies|[go to XML description]]]
* It supports the '''[[Documentation/DevGuide/Extensions/Online Update of Extensions|update]]''' feature and update information can be obtained at the specified address. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/update-information|[go to XML description]]]
* A '''[[Documentation/DevGuide/Extensions/Simple License|license]]''' text is displayed displayed during installation. Different localizations of the license text are available. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/registration|[go to XML description]]]
* There are two localized versions of a '''[[Documentation/DevGuide/Extensions/Publisher Information|publisher name]]''' and URL. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/publisher|[go to XML description]]]
* There are two links to '''release notes''' in different languages. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/release-notes|[go to XML description]]]
* There is a localized '''[[Documentation/DevGuide/Extensions/Display Name|display name]]'''. That is, in an english version of OOo the Extension Manager will show the string: ''My great extension''. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/display-name|[go to XML description]]]
* The extension contains '''icons''' which are used by the Extensions Manager when displaying the extension. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/icon|[go to XML description]]]
* A localized [[Documentation/DevGuide/Extensions/Extension Description|'''description''']] is displayed in the Extension Manager's dialog. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|[go to XML description]]]
* '''Deployment hooks''' are entry points for extension programmers. These hooks are called after the extension was installed and right before the extension will uninstall. [[Documentation/DevGuide/Extensions/Description of XML Elements#Element /description/extension-description|[go to XML description]]]

Please note that the <publisher> and <release-notes> elements in a ''description.xml'' are currently not used by the Extension Manager. However, when uploading the extension to the extensions repository (http://extensions.services.openoffice.org) then these elements are used for generating update information. When the Extension Manager looks for updates then it displays these information (OOo 2.4).

{{PDL1}}

[[Category:Documentation/Developer's Guide/Extensions]]

API/UNO AWT/Grid Control

2009-10-07T09:13:05Z

Tkr: /* Planned Iteration */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

''Java''
<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>
''Basic''
<source lang="oobas">
oColumnModel = createUnoService( "com.sun.star.awt.grid.DefaultGridColumnModel")

oColumn1 = createUnoService( "com.sun.star.awt.grid.GridColumn")
oColumn1.Title = "City"

oColumn2 = createUnoService( "com.sun.star.awt.grid.GridColumn")
oColumn2.Title = "Country"
</source>

'''Add the columns to the column model of the grid control:'''

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>
''Basic''
<source lang="oobas">
oDataModel = createUnoService( "com.sun.star.awt.grid.DefaultGridDataModel")
'first parameter is for header title if row header exists, else put empty string
oDataModel.addRow ( "1", Array( "Hamburg", "Germany") )
oDataModel.addRow ( "2", Array("Brisbane", "Australia") )
</source>

'''Create the grid model and assign the column and data model:'''

''Java''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>
''Basic''
<source lang="oobas">
oModel = oDialogModel.createInstance( "com.sun.star.awt.grid.UnoControlGridModel" )
oModel.Name="Grid1"
oModel.GridDataModel = oDataModel
oModel.ColumnModel = oColumnModel
oModel.ShowColumnHeader = True
oModel.ShowRowHeader = True
oDialogModel.insertByName("Grid1", oModel )
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
The XMouseListener is currently not full implemented within the grid control. Only the methods ''mousePressed'' and ''mouseRelease'' are supported.
Use this listener to process mouse events e.g mouse clicks on a row.

Example:

<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XGridControl xGridControl = (XGridControl) UnoRuntime.queryInterface(XGridControl.class, objectGrid);
XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
if (arg0.ClickCount >= 2) {
int pos = xGridControl.getItemIndexAtPoint(arg0.X, arg0.Y);
// put custom source code here.
}
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | done || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-10-16 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* Eventhandling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-09-25T08:18:28Z

Tkr: /* Planned Iteration */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
The XMouseListener is currently not full implemented within the grid control. Only the methods ''mousePressed'' and ''mouseRelease'' are supported.
Use this listener to process mouse events e.g mouse clicks on a row.

Example:

<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XGridControl xGridControl = (XGridControl) UnoRuntime.queryInterface(XGridControl.class, objectGrid);
XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
if (arg0.ClickCount >= 2) {
int pos = xGridControl.getItemIndexAtPoint(arg0.X, arg0.Y);
// put custom source code here.
}
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:52:23Z

Tkr: /* XMouseListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
The XMouseListener is currently not full implemented within the grid control. Only the methods ''mousePressed'' and ''mouseRelease'' are supported.
Use this listener to process mouse events e.g mouse clicks on a row.

Example:

<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XGridControl xGridControl = (XGridControl) UnoRuntime.queryInterface(XGridControl.class, objectGrid);
XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
if (arg0.ClickCount >= 2) {
int pos = xGridControl.getItemIndexAtPoint(arg0.X, arg0.Y);
// put custom source code here.
}
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:30:42Z

Tkr: /* XMouseListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
The XMouseListener is currently not full implemented within the grid control. Only the methods ''mousePressed'' and ''mouseRelease'' are supported.
Use this listener to process mouse events e.g mouse clicks on a row.

Example:

<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XGridControl xGridControl = (XGridControl) UnoRuntime.queryInterface(XGridControl.class, objectGrid);
XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
if (arg0.ClickCount >= 2) {
int pos = xGridControl.getItemIndexAtPoint(arg0.X, arg0.Y);
// put custom source code here.
}
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:21:06Z

Tkr: /* XGridColumnLisener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:20:18Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:20:03Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.

Example:

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T07:19:29Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model.
Each event triggered by the listener uses an instance of GridDataEvent to give details.
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:59:38Z

Tkr: /* Abstract */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:57:58Z

Tkr: /* XMouseListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow.addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:57:12Z

Tkr: /* XMouseListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===
<source lang="java">
XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface(
XControlContainer.class, dialog);
Object objectGrid = xControlCont.getControl("Grid1");

XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid);

xWindow .addMouseListener(new XMouseListener() {

public void mousePressed(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseReleased(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseEntered(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void mouseExited(MouseEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:42:05Z

Tkr: /* Example */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("GridDataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:38:53Z

Tkr: /* XGridColumnLisener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===
<source lang="java">
Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:38:33Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});
</source>

=== XGridColumnLisener ===

Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});

=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:38:17Z

Tkr: /* XGridColumnLisener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
}())
</source>

=== XGridColumnLisener ===

Object columnModel = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", this.context);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel);

xGridColumnModel.addColumnListener(new XGridColumnListener() {

public void columnAdded(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnRemoved(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void columnChanged(GridColumnEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
});

=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:34:19Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
}())
</source>

=== XGridColumnLisener ===
=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:33:58Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
}())
</source>

=== XGridColumnLisener ===
=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:33:25Z

Tkr: /* XGridDataListener */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===

Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", this.context);
xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addDataListener(new XGridDataListener() {

public void rowAdded(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void rowRemoved(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void dataChanged(GridDataEvent arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}

public void disposing(EventObject arg0) {
throw new UnsupportedOperationException("Not supported yet.");
}
}())

=== XGridColumnLisener ===
=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:31:30Z

Tkr: /* Supported Listeners */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

=== XGridDataListener ===
=== XGridColumnLisener ===
=== XMouseListener ===

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:30:08Z

Tkr: /* Event Handling */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==

=== Supported Listeners ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-06T06:27:22Z

Tkr: /* Event Handling */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XMouseListener''' || ||
|-
| || mousePressed || ||
|-
| || mouseReleased || ||
|-
| || mouseEntered || ''Not yet implemented.'' ||
|-
| || mouseExited || ''Not yet implemented.'' ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-04T09:21:52Z

Tkr: /* Known Issues */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XItemListener''' || ||
|-
| || itemStateChanged || Invoked after double click on a row. ItemEvent.ItemId contains the index of the row.
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-04T09:20:32Z

Tkr: /* Planned Iteration */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XItemListener''' || ||
|-
| || itemStateChanged || Invoked after double click on a row. ItemEvent.ItemId contains the index of the row.
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || new ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || new ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-08-04T09:19:47Z

Tkr: /* Planned Iteration */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XItemListener''' || ||
|-
| || itemStateChanged || Invoked after double click on a row. ItemEvent.ItemId contains the index of the row.
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || new ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || new ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #FFFF00;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-07-29T12:35:21Z

Tkr: /* Knowing Issues */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XItemListener''' || ||
|-
| || itemStateChanged || Invoked after double click on a row. ItemEvent.ItemId contains the index of the row.
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Known Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || new ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || new ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-07-29T09:31:41Z

Tkr: /* Grid specification */

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<source lang="java">
// #1 column
Object column1Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);

XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column1Obj);

column1.setTitle("Column1");

// #2 column
Object column2Obj = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", m_xContext);
XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface(
XGridColumn.class, column2Obj);

column2.setTitle("Column2");
</source>

'''Add the columns to the column model of the grid control:'''

<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);

xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
</source>

'''Use the data model of the grid control to add rows:'''

<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);

xGridDataModel.addRow("1", new String[] {"1,1","1,2"} );
xGridDataModel.addRow("2", new String[] {"2,1","2,2"} );
</source>

'''Create the grid model and assign the column and data model:'''
<source lang="java">
Object gridModel = xMultiServiceFactory.createInstance(
"com.sun.star.awt.grid.UnoControlGridModel");
XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface(
XPropertySet.class, gridModel);

xPSetButton.setPropertyValue("PositionX", new Integer(50));
xPSetButton.setPropertyValue("PositionY", new Integer(30));
xPSetButton.setPropertyValue("Width", new Integer(400));
xPSetButton.setPropertyValue("Height", new Integer(400));
xPSetButton.setPropertyValue("Name", "GridControl");
xPSetButton.setPropertyValue("TabIndex", new Short((short) 0));
xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel);
xPSetButton.setPropertyValue("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Name || Method || Comments
|-
| '''XGridDataListener''' || ||
|-
| || rowAdded ||
|-
| || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''.
|-
| || dataChanged||
|-
| '''XGridColumnListener''' || ||
|-
| || columnAdded||
|-
| || columnRemoved||
|-
| || columnChanged||
|-
| '''XItemListener''' || ||
|-
| || itemStateChanged || Invoked after double click on a row. ItemEvent.ItemId contains the index of the row.
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== Knowing Issues ==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Description || Task ID || Status || Comments
|-
|align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || new ||
|-
|align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || new ||
|-
|align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || new ||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || new ||
|}

==Feature Set==
* Width for each column
* Height for each row
* Each cell has its own data type
* Column and row header
* Vertical and horizontal scrollbars
* Row selection ( Single, Multi, Range )
* Auto resizing
* A11y

==Planned Iteration==
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Iteration || Due date || Status || Comment || Description || Components
|-
| align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Basic IDE
* Docs/Wiki |
|
* IDE
** Import/Export
**UI
* Doc
**Wiki
**SDK-Examples
|}

==Grid specification==

=== Key And Mouse Usage ===
{| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;"
|- style="background-color: #DEDEDE;"
| Action || Selection Modus || Description
|-
|align=center | '''Selection possibilities with the mouse''' || ||
|-
|align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection.
|-
|align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it.
|-
|align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one.
|-
|align=center | '''Selection possibilities with the keyboard''' || ||
|-
|align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it.
|-
|align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one.
|-
|align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
|-
|align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one.
|-
|align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-07-29T09:13:48Z

Tkr: /* Example */

API/UNO AWT/Grid Control

2009-07-29T09:12:51Z

Tkr: /* Planned Iteration */

API/UNO AWT/Grid Control

2009-07-29T09:12:24Z

Tkr: /* Planned Iteration */

API/UNO AWT/Grid Control

2009-07-29T09:08:32Z

Tkr: /* Knowing Issues */

API/UNO AWT/Grid Control

2009-07-29T09:08:18Z

Tkr: /* Milestones */

API/UNO AWT/Grid Control

2009-07-29T08:58:30Z

Tkr: /* Knowing Issues */

API/UNO AWT/Grid Control

2009-07-29T08:57:43Z

Tkr: /* Knowing Issues */

API/UNO AWT/Grid Control

2009-07-29T08:16:50Z

Tkr: /* Knowing Issues */

API/UNO AWT/Grid Control

2009-07-29T07:58:21Z

Tkr: (checkpoint save)

API/UNO AWT/Grid Control

2009-07-29T07:41:44Z

Tkr: /* Knowing Issues */ (checkpoint save)

API/UNO AWT/Grid Control

2009-07-29T07:25:37Z

Tkr: /* Event Handling */

API/UNO AWT/Grid Control

2009-07-29T07:09:25Z

Tkr: /* Knowing Issues */

API/UNO AWT/Grid Control

2009-07-29T06:59:46Z

Tkr: /* Example */

API/UNO AWT/Grid Control

2009-07-29T06:59:30Z

Tkr: /* Example */

API/UNO AWT/Grid Control

2009-07-29T06:57:37Z

Tkr: /* Event Handling */

API/UNO AWT/Grid Control

2009-07-29T06:56:59Z

Tkr: /* Listener */