:: com :: sun :: star :: inspection ::

unpublished interface XObjectInspectorModel
Description
describes the model of an ObjectInspector
See also
ObjectInspector

Methods' Summary
describeCategories describes the property categories used by the property handlers.  
getPropertyOrderIndex retrieves an index in a global property ordering, for a given property name  
Methods' Details
describeCategories
sequence< PropertyCategoryDescriptor >
describeCategories();

Description
describes the property categories used by the property handlers.

Properties can be sorted into different categories, described by the LineDescriptor::Category attribute, which is filled in XPropertyHandler::describePropertyLine method of your property handler.
Those names provided by the handlers are programmatic names. All other information about categories is part of the PropertyCategoryDescriptor , and describeCategories assembles information about all categories which all property handlers provided by the model use.

Returns
a sequence of category descriptors. Their relative ordering also describes the relative ordering of the categories in the ObjectInspector 's user interface.
The sequence must not contain two entries with the same programmatic name.

The model implementation might return an empty sequence here, in this case, the ObjectInspector automatically builds its category information from the categories provided by the property handlers.
See also
PropertyCategoryDescriptor, LineDescriptor::Category
getPropertyOrderIndex
long
getPropertyOrderIndex( [in] string  PropertyName );

Description
retrieves an index in a global property ordering, for a given property name

In the user interface of an ObjectInspector, single properties are represented by single lines, and those lines are displayed successively. To determine an order of the property lines, the inspector model can associate an "order index" with each property. The ObjectInspector will then sort the property lines in a way that they have the same relative ordering as the "order indexes" of their properties.

Note that the concrete value the model returns for a given property does not matter. All what matters is that if you want a certain property Foo to be displayed after another property Bar , then the order index of Foo should be greater than the order index of Bar .

If for two different properties the same order index is returned, the ObjectInspector will assume the order in which those properties were provided by the respective property handler ( XPropertyHandler::getSupportedProperties ).
If two such properties originate from different handlers, they will be ordered according to the order of the handlers, as provided in the HandlerFactories attribute.

Parameter PropertyName
the property whose global order index should be retrieved
Returns
the global order index of PropertyName .
Attributes' Summary
HandlerFactories describes a set of factories for creating XPropertyHandler s  
Attributes' Details
HandlerFactories
[ readonly ] sequence< any > HandlerFactories;
Description
describes a set of factories for creating XPropertyHandler s

Every element of the sequence must contain information to create a XPropertyHandler instance. Two ways are currently supported:

  • A sevice name:
    If a sequence element contains a string, this string is interpreted as service name, and an ::com::sun::star::lang::XMultiComponentFactory is asked to create an instance of this service.
  • A factory:
    If a sequence element contains an instance implementing the ::com::sun::star::lang::XSingleComponentFactory interface, this factory is used to create a property handler.

This attribute is usually only evaluated by the ObjectInspector instance which the model is currently bound to.

The order of factories is important: If two property handlers declare themself responsible for the same property, the one whose factory is listed last wins. Also, if a handler B wants to supersede a property of another handler A , A 's factory must precede the factory of B .

See also
XPropertyHandler::getSupportedProperties, XPropertyHandler::getSupersededProperties
Top of Page