Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

deprecated service PropertyBrowserController
Usage Restrictions
deprecated
Deprecation Info

Note that nowadays, this service is only a legacy wrapper using the ::com::sun::star::inspection::ObjectInspector and the ::com::sun::star::form::inspection::DefaultFormComponentInspectorModel services, and knitting them together.

Description
describes a controller which can be used to browse and modify properties of form controls.

The controller can be plugged into an ::com::sun::star::frame::XFrame, and will provide a visual component for inspecting control properties. This means it allows to interactively control several aspects of a FormControlModel or DataAwareControlModel, such as it's data binding, it's layout, and it's event binding

For using a PropertyBrowserController, you need to

  • instatiate it at a service factory of your choice
  • attach it to an empty frame of your choice
  • set the IntrospectedObject property to the control model which you wish to analyze

Example
Java
 XFrame xFrame = getNewEmptyFrame();
 XMultiServiceFactory xORB = getORB();
 XPropertySet xControlModel = getMyControlModel();

 // instantiate the controller
 XController xController = (XController)UnoRuntime.queryInterface( XController.class,
 xORB.createInstance( "com.sun.star.form.PropertyBrowserController" ) );

 // marry the controller and the frame. This will cause the controller
 // to create a visual component within the frame to inspect our object
 xController.attachFrame( xFrame )

 // tell the controller which object to inspect
 XPropertySet xControllerProps = (XPropertySet)UnoRuntime.queryInterface(
 XPropertySet.class, xController );

 xControllerProps.setPropertyValue( "IntrospectedObject", xControlModel );
 
See also
::com::sun::star::frame::XController

Exported Interfaces - Summary
::com::sun::star::frame::XController

ensures the basic functionality for a controller. (details)

::com::sun::star::beans::XPropertySet

allows to access the properties of the object

::com::sun::star::beans::XFastPropertySet

allows to access the properties via indicies

::com::sun::star::beans::XMultiPropertySet

allows to access more than one property of the object at the same time

Properties' Summary
::com::sun::star::beans::XPropertySet
IntrospectedObject
contains the object to inspect.  
string
CurrentPage
controls the actually visible page.  
Exported Interfaces - Details
::com::sun::star::frame::XController
Description
ensures the basic functionality for a controller.

With supporting this interface, the component is able to operate in (and provide content for) an ::com::sun::star::frame::XFrame.

::com::sun::star::beans::XPropertySet
Description
allows to access the properties of the object
::com::sun::star::beans::XFastPropertySet
Description
allows to access the properties via indicies
::com::sun::star::beans::XMultiPropertySet
Description
allows to access more than one property of the object at the same time
Properties' Details
IntrospectedObject
::com::sun::star::beans::XPropertySet IntrospectedObject;
Description
contains the object to inspect.

Changing this property from outside causes the controller to update it's view with the data of the new object

CurrentPage
string CurrentPage;
Description
controls the actually visible page.

The aspects of a DataAwareControlModel which can be browsed and modified using this controller can be separated into 3 groups: common aspects, data-awareness related aspects, and bound events.
The appearance of the visual component created by the controller is that 3 tab pages, one for each group, are displayed (of course if the control does not support any aspects of a given group, the group is omitted).
With this property, it can be controller which page is currently acticve.

Valid values are (this list may be extended in the future):

  • Generic
  • Data
  • Events

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.