service HierarchyElement in module com::sun::star::configuration:: |
service HierarchyElement;
provides information about an element within a (by name) hierarchy.
The local name and the full hierarchical name can be retrieved. Attributes detailing the role of the element can be queried. The state of the element (regarding defaults) can be accessed.
Implementations of this service usually also implement service HierarchyAccess , which concerns the complementary role of providing access to subelements of the hierarchy.
Exported Interfaces |
provides the complete hierarchical name of this element within the hierarchy tree.
provides the (local) name of this element within its parent.
Renaming an element is generally not supported.
provides a property descriptor for this element.[optional]
This interface may be missing, if the hierarchy supports no traits that are described by PropertyAttribute values.
If the parent of this object implements XPropertySetInfo , then this returns the same Property as the XPropertySetInfo of the parent.
provides access to the default state of this element. [optional]
This interface may be missing, if the hierarchy supports access to a default state and values only for simple values or not at all.
If the parent of this object implements XPropertyState , then members of this interface have the same effect as corresponding members of the parent.
If an implementation is part of a read-only view of the hierarchy, attempts to change property states will fail.
provides access to the parent of this element [optional].
This interface may be missing if this object is not obtained as a child or descendant of another tree node, for example, directly from a factory or provider.
XChild::getParent returns NULL, if this object is currently not contained in another node.
Setting a different parent is, generally, not supported.
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.