Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 3042

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Service PropertyBrowserController</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="PropertyBrowserController-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub">Included Services</td>
<td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">form</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">deprecated </td>
<td width="50%" class="title">service PropertyBrowserController</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Deprecation Info</b></dt>
<dd><p>Note that nowadays, this service is only a legacy wrapper using the
 ::com::sun::star::<a href="../inspection/module-ix.html">inspection</a>::<a href="../inspection/ObjectInspector.html">ObjectInspector</a> and the
 ::com::sun::star::form::<a href="inspection/module-ix.html">inspection</a>::<a href="inspection/DefaultFormComponentInspectorModel.html">DefaultFormComponentInspectorModel</a> services, and knitting them together.</p>

</dd>
<dt><b>Description</b></dt>
<dd>describes a controller which can be used to browse and modify properties of form controls.

 </dd>
<dd><p>The controller can be plugged into an ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a>, and will
 provide a visual component for inspecting control properties. This means it allows to interactively control
 several aspects of a <a href="FormControlModel.html">FormControlModel</a> or <a href="DataAwareControlModel.html">DataAwareControlModel</a>, such as it's
 data binding, it's layout, and it's event binding</p>

 <p>For using a PropertyBrowserController, you need to
 <ul><li>instatiate it at a service factory of your choice</li>
 <li>attach it to an empty frame of your choice</li>
 <li>set the IntrospectedObject property to the control model which you wish to analyze</li>
 </ul>
 </p>

 </dd>
<dt><b>Example</b></dt>
<dd>Java
 <pre>
 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 );
 </pre>

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>ensures the basic functionality for a controller.

 </dd>
<dd><p>With supporting this interface, the component is able to operate in (and provide content
 for) an ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a>.</p>
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>allows to access the properties of the object
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XFastPropertySet.html">XFastPropertySet</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>allows to access the properties via indicies
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XMultiPropertySet.html">XMultiPropertySet</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>allows to access more than one property of the object at the same time
 </dd>
</dl>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a><br>
<a href="#IntrospectedObject">IntrospectedObject</a></td>
<td class="imsum_right">contains the object to inspect.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#CurrentPage">CurrentPage</a></td>
<td class="imsum_right">controls the actually visible page.

 &nbsp;</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="IntrospectedObject" class="membertitle">IntrospectedObject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> <b>IntrospectedObject</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the object to inspect.

 </dd>
<dd><p>Changing this property from outside causes the controller to update it's view
 with the data of the new object</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CurrentPage" class="membertitle">CurrentPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>CurrentPage</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>controls the actually visible page.

 </dd>
<dd><p>The aspects of a <a href="DataAwareControlModel.html">DataAwareControlModel</a> which can be browsed and modified
 using this controller can be separated into 3 groups: common aspects, data-awareness
 related aspects, and bound events.</br>
 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).<br/>
 With this property, it can be controller which page is currently acticve.</p>

 <p>Valid values are (this list may be extended in the future):
 <ul><li>Generic</li>
 <li>Data</li>
 <li>Events</li>
 <ul></p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>