Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: lang ::
interface XComponent
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XComponent
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. Developers Guide 4.4.5 Writing UNO Components - Core Interfaces to Implement - XComponent 4.4 Writing UNO Components - Core Interfaces to Implement 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework 6.1.5 Office Development - OpenOffice.org Application Environment - Handling Documents - Closing Documents 3.3.8 Professional UNO - UNO Concepts - Lifetime of UNO Objects

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 ::com::sun::star::uno::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] 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. It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed. If this XComponent is already disposed when XComponent::addEventListener is called, the call will not fail with a DisposedException , but the caller will be notified via the XEventListener::disposing callback. This callback can occur synchronously within the XComponent::addEventListener call. See also XComponent::removeEventListener
removeEventListener
void removeEventListener( | [in] XEventListener | aListener );
Description removes an event listener from the listener list. It is a "noop" if the specified listener is not registered. It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed. If this XComponent is already disposed when XComponent::removeEventListener is called, the call will not fail with a DisposedException , but will rather be ignored silently. See also XComponent::addEventListener

Top of Page

Copyright © 2003 Sun Microsystems, Inc.