(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

:: com :: sun :: star :: form ::

service FormComponents
Description
specifies the capabilities of a collection of FormComponents.

The collection must provide the possibility of adding and removing components by name and by index. The name of a component is not necessarily unique, so the collection must be able to handle duplicate entry names.

See also
FormComponent
Developers Guide
Forms - FormComponents Service
Exported Interfaces - Summary
::com::sun::star::container::XContainer

allows to register listeners to be notified of changes in the container.

::com::sun::star::container::XNameContainer

allows to add/remove elements by name.

::com::sun::star::container::XIndexContainer

gives access to the elements by index.

::com::sun::star::container::XEnumerationAccess

creates an enumeration of the elements.

::com::sun::star::script::XEventAttacherManager

This interface has to be implemented to supply the scripting environment for the contained components. (details)
Exported Interfaces - Details
::com::sun::star::container::XContainer
Description
allows to register listeners to be notified of changes in the container.
::com::sun::star::container::XNameContainer
Description
allows to add/remove elements by name.
::com::sun::star::container::XIndexContainer
Description
gives access to the elements by index.
::com::sun::star::container::XEnumerationAccess
Description
creates an enumeration of the elements.
::com::sun::star::script::XEventAttacherManager
Description
This interface has to be implemented to supply the scripting environment for the contained components.

The interface allows managing of scripts associated with dependent components, accessed by index. However, as a client of the FormComponents service, there's no need to bother with the container aspect of the ::com::sun::star::script::XEventAttacherManager directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the ::com::sun::star::script::XEventAttacherManager interface.

For instance, at any time you can obtain the events associated with the nth element in the form components by calling ::com::sun::star::script::XEventAttacherManager::getScriptEvents with paramter n. In particular, this invariant is always met, even after you inserted/removed elements into/from the container.

 Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.