interface XComponent in module com::sun::star::lang::

(Global Index)

Syntax

interface XComponent : 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.

Method 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.

Known Services Which Export this Interface

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

com::sun::star::reflection::TypeDescriptionProvider

com::sun::star::bridge::IiopBridge

com::sun::star::bridge::Bridge

com::sun::star::bridge::UrpBridge

com::sun::star::bridge::BridgeFactory

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

com::sun::star::reflection::TypeDescriptionProvider

com::sun::star::bridge::IiopBridge

com::sun::star::bridge::Bridge

com::sun::star::bridge::UrpBridge

com::sun::star::bridge::BridgeFactory

com::sun::star::datatransfer::dnd::OleDragSource

com::sun::star::datatransfer::dnd::OleDropTarget

com::sun::star::datatransfer::dnd::X11DragSource

com::sun::star::datatransfer::dnd::X11DropTarget

com::sun::star::datatransfer::clipboard::ClipboardManager

com::sun::star::datatransfer::clipboard::GenericClipboard

com::sun::star::datatransfer::clipboard::SystemClipboard

com::sun::star::datatransfer::filter::DataTransferFilterManager

com::sun::star::document::DocumentInfo

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

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

com::sun::star::sdbc::Connection

com::sun::star::sdbc::PreparedStatement

com::sun::star::sdbc::ResultSet

com::sun::star::sdbc::Statement

com::sun::star::drawing::Shape

com::sun::star::awt::UnoControlContainer

com::sun::star::awt::UnoControl

com::sun::star::awt::UnoControlModel

com::sun::star::ucb::HierarchyRootFolderContent

com::sun::star::ucb::WebDAVFolderContent

com::sun::star::ucb::UniversalContentBroker

com::sun::star::ucb::HierarchyDataReadAccess

com::sun::star::ucb::HierarchyDataSource

com::sun::star::ucb::HierarchyFolderContent

com::sun::star::ucb::FileContent

com::sun::star::ucb::ContentResultSet

com::sun::star::ucb::PackageFolderContent

com::sun::star::ucb::PackageStreamContent

com::sun::star::ucb::WebDAVDocumentContent

com::sun::star::ucb::HierarchyLinkContent

com::sun::star::ucb::ChaosContent

com::sun::star::ucb::Content

com::sun::star::sheet::SpreadsheetDocument

com::sun::star::configuration::AccessRootElement

com::sun::star::configuration::SetElement

com::sun::star::configuration::ConfigurationProvider

com::sun::star::ui::dialogs::FilePicker

com::sun::star::linguistic2::DictionaryList

com::sun::star::linguistic2::SpellChecker

com::sun::star::linguistic2::LinguProperties

com::sun::star::linguistic2::LinguServiceManager

com::sun::star::linguistic2::Hyphenator

com::sun::star::linguistic2::Thesaurus

Method Details



dispose

Syntax

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

Syntax

void addEventListener (
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

Syntax

void removeEventListener (
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