provides information about the root element of a hierarchy and
about the hierarchy as a whole.
Provides information about the element and the whole hierarchy.
Allows controlling the lifetime of the hierarchy.
Allows observing changes in the hierarchy as a whole.
When access to a hierarchy is first obtained from a factory or provider,
this is the initial object that is created by the factory.
It represents the root of the accessible part of the hierarchy.
NOTE: In this description 'hierarchy' may actually
designate a part or fragment of a larger hierarchy. It is that part that is
rooted in the element represented by an implementation of this service
and that is accessible starting from this element.
Generally it is not possible to navigate the parent or siblings, if any,
of this element, so ::com::sun::star::container::XChild is
not supported.
See also
UpdateRootElement
Implementations that support modifying data in the hierarchy
implement service UpdateRootElement.
See also
SetElement
A complementary service, for children of a dynamic homogeneous container.
See also
GroupElement
A complementary service, for children of a static heterogeneous collection.
allows controlling or observing the lifetime of the whole hierarchy.
The owner of the hierarchy may dispose of this object
using ::com::sun::star::lang::XComponent::dispose().
As this object owns its child elements and, recursively, the whole hierarchy,
any descendant elements obtained, directly or indirectly, from this object
will also be disposed. Disposing of the object does not affect a persistent
representation of the hierarchy.
When an implementation is obtained from a factory or provider, ownership
of it is usually transferred to the client. See the documentation
of the particular provider or factory service for details.
The provider of this object may still dispose of this object, when the
lifetime of the provider ends or if these objects represent
the root of only a fragment of an enclosing hierarchy and
this fragment is removed from the complete hierarchy by an outside source.
Clients may register an ::com::sun::star::lang::XEventListener
to be notified when the object is disposed for either cause.
allows registering listeners that observe the whole hierarchy.
A client can register an
::com::sun::star::util::XChangesListener,
which will receive notifications for any changes within the
hierarchy (fragment) this object represents.
An implementation will collect as many changes as possible into a single
::com::sun::star::util::ChangesEvent. For Example:
If an outside source uses
::com::sun::star::util::XChangesBatch::commitChanges()
on an overlapping hierarchy access, all relevant changes will be notified
with a single event.
@ see UpdateRootElement
@ see com::sun::star::util::XChangesBatch
provides access to the locale that applies to locale-dependent data
in this hierarchy. [optional]
This interface may be missing if the implementation does not support
locale-dependent data in the hierarchy or if the (partial) hierarchy rooted
in this object does not contain any locale-dependent elements.
Changing the locale is generally not supported. If it is supported,
there is no guarantee that values already loaded into the hierarchy, or an
application cache, are refreshed to reflect the new locale. Use of
::com::sun::star::lang::XLocalizable::setLocale()
is therefore not recommended.
