<html> <head> <title>Interface XSynchronousFrameLoader</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="XSynchronousFrameLoader-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XSynchronousFrameLoader</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>loads a resource into a <a href="Frame.html">Frame</a>. </dd> <dd><p> Unlike the <a href="XFrameLoader.html">XFrameLoader</a> interface, this loading will be synchronous. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XFrameLoader.html">XFrameLoader</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#load">load</a></td> <td class="imsum_right">starts the loading of the specified resource into the specified <a href="Frame.html">Frame</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#cancel">cancel</a></td> <td class="imsum_right">cancels the loading process. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="load" class="membertitle">load</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>load</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Descriptor,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XFrame.html">XFrame</a></td> <td valign="bottom"> Frame );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>starts the loading of the specified resource into the specified <a href="Frame.html">Frame</a>. </dd> <dt><b>Parameter Descriptor</b></dt> <dd>describes the ressource which should be loaded It use a ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a> for that. </dd> <dt><b>Parameter Frame</b></dt> <dd>the target frame which should contain the new loaded component </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if loading is successfully <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cancel" class="membertitle">cancel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>cancel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>cancels the loading process. </dd> <dd><p> No notifications (neither to the frame or the caller) must be notified. Because it's a synchronous process this cancel call can be forced by another thread the loader thread only. Method <a href="XSynchronousFrameLoader.html">XSynchronousFrameLoader</a>::<a href="XSynchronousFrameLoader.html#load">load()</a> must return <b>false</b> then and caller of this method <a href="XSynchronousFrameLoader.html">XSynchronousFrameLoader</a>::<a href="XSynchronousFrameLoader.html#cancel">cancel()</a> already knows the state ... </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>