Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: lang ::

interface XComponent

Base Interface
com::sun::star::uno::XInterface

Description
allows to exclicitly free resources and break cyclic references.

Actually the real lifetime of an UNO object is controlled by references kept on interfaces of this object. But there are two distinct meanings in keeping a reference to an interface: 1st to own the object and 2nd to know the object.

You are only allowed to keep references of interfaces to UNO objects if you are by definition the owner of that object or your reference is very temporary or you have registered an EventListener at that object and release the reference when "disposing" is called.



Known Services which Export this Interface

com::sun::star::lang::ServiceManager provides a collection of implementations for services.
com::sun::star::reflection::TypeDescriptionProvider A provider service supports the XHierarchicalNameAccess interface to read type descriptions and constants from a specific source, e.g., a typelib registry file.
com::sun::star::bridge::IiopBridge Concrete service of the meta service Bridge for iiop.
com::sun::star::bridge::Bridge This meta service allows the bridgefactory service to instantiate an interprocess bridge using a certain transfer protocol.
com::sun::star::bridge::UrpBridge Concrete service of the meta service Bridge for the urp protocol.
com::sun::star::bridge::BridgeFactory allows to create new or access existing interprocess bridges.
com::sun::star::lang::ServiceManager provides a collection of implementations for services.
com::sun::star::reflection::TypeDescriptionProvider A provider service supports the XHierarchicalNameAccess interface to read type descriptions and constants from a specific source, e.g., a typelib registry file.
com::sun::star::bridge::IiopBridge Concrete service of the meta service Bridge for iiop.
com::sun::star::bridge::Bridge This meta service allows the bridgefactory service to instantiate an interprocess bridge using a certain transfer protocol.
com::sun::star::bridge::UrpBridge Concrete service of the meta service Bridge for the urp protocol.
com::sun::star::bridge::BridgeFactory allows to create new or access existing interprocess bridges.
com::sun::star::datatransfer::dnd::OleDragSource This service connects the Java-like UNO drag and drop protocol to the protocol used on window platforms. It realized the drag source.
com::sun::star::datatransfer::dnd::OleDropTarget This service connects the Java-like UNO Drag & Drop protocol to the protocol used on window platforms. It realizes the drop target.
com::sun::star::datatransfer::dnd::X11DragSource This service connects the Java-like UNO Drag and Drop protocol to the X Drag and Drop protocol used on X-Servers to transfer data between applications via Drag and Drop operations.
com::sun::star::datatransfer::dnd::X11DropTarget This service connects the Java-like UNO Drag and Drop protocol to the X Drag and Drop protocol used on X-Servers to transfer data between application via Drag and Drop operations.
com::sun::star::datatransfer::clipboard::ClipboardManager The clipboard manager is a one-instance service that holds a list of all known clipboard instances.
com::sun::star::datatransfer::clipboard::GenericClipboard A generic clipboard service is a simple container for transferable objects.
com::sun::star::datatransfer::clipboard::SystemClipboard The system clipboard service builds a bridge to the OS specific clipboard interfaces.

com::sun::star::datatransfer::filter::DataTransferFilterManager The filter manager is a one-instance service that holds a list of all known filter instances.
com::sun::star::document::DocumentInfo This service provides document-specific information like the author, creation date and user fields.
com::sun::star::form::FormController specifies the view representation of a form.
com::sun::star::form::FormComponent specifies a component which can be part of a form.
com::sun::star::sdbc::Connection represents a connection (session) with a specific database. Within the context of a Connection, SQL statements are executed and results are returned.
com::sun::star::sdbc::PreparedStatement represents a precompiled SQL statement.
com::sun::star::sdbc::ResultSet provides access to a table of data. A ResultSet object is usually generated by executing a Statement.
com::sun::star::sdbc::Statement is used for executing a static SQL statement and obtaining the results produced by it.
com::sun::star::drawing::Shape This abstract service specifies the general characteristics of all Shape s.
com::sun::star::awt::UnoControlContainer specifies an abstract control which can contain other controls. One additional interface ( XControlContainer ) is specified. An UnoControlContainer contains other UnoControl s.
com::sun::star::awt::UnoControl specifies an abstract control.
com::sun::star::awt::UnoControlModel specifies the standard model of an UnoControl in the Smalltalk model view controller design .
com::sun::star::ucb::HierarchyRootFolderContent A HCP Root Folder is the root container for all other HCP Folders and HCP Links.
com::sun::star::ucb::WebDAVFolderContent A DCP Folder is a container for other DCP Folders or Documents.
com::sun::star::ucb::UniversalContentBroker is a one-instance service that provides access to a set of Content s via ContentProvider s.
com::sun::star::ucb::HierarchyDataReadAccess provides read access to a fragment of the hierarchy data.
com::sun::star::ucb::HierarchyDataSource manages one or more complete sets of hierarchy data and serves as a factory for objects that provide access to a subset of the data.
com::sun::star::ucb::HierarchyFolderContent A HCP Folder is a container for other HCP Folders and HCP Links.
com::sun::star::ucb::FileContent A File Content represents either a directory or a file in the local file system.
com::sun::star::ucb::ContentResultSet provides access to the children of a folder content.
com::sun::star::ucb::PackageFolderContent A PCP Folder is a container for other PCP Folders and PCP Streams.
com::sun::star::ucb::PackageStreamContent A PCP Stream is a content which represents a file inside a package.
com::sun::star::ucb::WebDAVDocumentContent A DCP Document is a container for Document data/content.
com::sun::star::ucb::HierarchyLinkContent A HCP Link is a content which points to another location.
com::sun::star::ucb::ChaosContent [ DEPRECATED ]
A Chaos Content is a representation of a resource provided by the Chaos Content Provider.
com::sun::star::ucb::Content A Content is a service that provides access to data of a content provided by an implementation of the service ContentProvider .
com::sun::star::sheet::SpreadsheetDocument a model component which consists of some settings and one or more spreadsheets.
com::sun::star::configuration::AccessRootElement provides information about the root element of a hierarchy, by name, and about the hierarchy as a whole.
com::sun::star::configuration::SetElement provides information about a dynamic element that can be inserted into a homogeneous set of elements within a (by name) hierarchy.
com::sun::star::configuration::ConfigurationProvider manages one, or more, complete sets of configuration data and serves as a factory for objects that provide access to a subset of the configuration.
com::sun::star::ui::dialogs::FilePicker
com::sun::star::linguistic2::SpellChecker offers spellchecking functionality.
com::sun::star::linguistic2::Hyphenator offers hyphenation functionality.
com::sun::star::linguistic2::Thesaurus offers thesaurus functionality.
com::sun::star::linguistic2::DictionaryList is the list of personal dictionaries.
com::sun::star::linguistic2::LinguProperties the set of linguistic relevant properties.
com::sun::star::linguistic2::LinguServiceManager offers linguistic functionality. Is to be used to access spell checker, hyphenator and thesaurus.

Methods' Summary

dispose The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.
addEventListener adds an event listener to the object.
removeEventListener removes an event listener from the listener list.

Methods' Details

dispose
 
void
dispose();
Description
The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.

Only the owner of this object is allowed to call this method. The object should release all resources and references in the easiest possible manner ( for instance no serialization should take place anymore ).

The object must notify all registered listeners using the method XEventListener::disposing . All notfied objects should release there references to this object without calling XComponent::removeEventListener (the disposed object will release the listeners eitherway).

After this method has been called, the object should behave as passive as possible, thus it should ignore all calls in case it can comply with its specification (for instance addEventListener()). Often the object can't fulfill its specification anymore, in this case it must throw the DisposedException (which is derived from RuntimeException ) when it gets called.

For some objects no real owner can be identified, thus it can be disposed from multiple reference holders. In this case the object should be able to cope with multiple dispose()-calls (which are inevitable in a multithreaded environment).

addEventListener
 
void
addEventListener(
[ in ] com::sun::star::lang::XEventListener xListener );

Description
adds an event listener to the object.

The broadcaster fires the disposing method of this listener if the XComponent::dispose method is called.

See also
XComponent::removeEventListener
removeEventListener
 
void
removeEventListener(
[ in ] com::sun::star::lang::XEventListener aListener );

Description
removes an event listener from the listener list.

It is a "noop" if the specified listener is not registered.

See also
XComponent::addEventListener

Top of Page