<html> <head> <title>Interface XResourceId</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="XResourceId-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">drawing</a> :: <a href="module-ix.html" class="namechain">framework</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XResourceId</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A resource id uses a set of URLs to unambiguously specify a resource of the drawing framework. </dd> <dd><p>Resources of the drawing framework are panes, views, tool bars, and command groups. One URL describes the type of the actual resource. A sequence of URLs (typically one, sometimes two) specifies its anchor, the resource it is bound to. The anchor typically is a pane (for views), or it is empty (for panes).</p> <p>The resource URL may be empty. In this case the anchor is empty, too. Such an empty resource id does not describe a resource but rather the absence of one. Instead of an empty <a href="XResourceId.html">XResourceId</a> object an empty reference can be used in many places.</p> </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="#getResourceURL">getResourceURL</a></td> <td class="imsum_right">Return the URL of the resource. </td> </tr> <tr> <td class="imsum_left"><a href="#hasAnchor">hasAnchor</a></td> <td class="imsum_right">Return whether there is a non-empty anchor URL. When this method returns <b>false</b> then getAnchorURLs() will return an empty list. </td> </tr> <tr> <td class="imsum_left"><a href="#getAnchor">getAnchor</a></td> <td class="imsum_right">Return a new XResourceId that represents the anchor resource. </td> </tr> <tr> <td class="imsum_left"><a href="#getAnchorURLs">getAnchorURLs</a></td> <td class="imsum_right">Return the, possibly empty, list of anchor URLs. </td> </tr> <tr> <td class="imsum_left"><a href="#getResourceTypePrefix">getResourceTypePrefix</a></td> <td class="imsum_right">Return the type prefix of the resource URL. This includes all up to and including the second slash. </td> </tr> <tr> <td class="imsum_left"><a href="#compareTo">compareTo</a></td> <td class="imsum_right">Compare the called <a href="XResourceId.html">XResourceId</a> object with the given one. </td> </tr> <tr> <td class="imsum_left"><a href="#isBoundTo">isBoundTo</a></td> <td class="imsum_right">Return whether the anchor of the called resource id object represents the same resource as the given object. </td> </tr> <tr> <td class="imsum_left"><a href="#isBoundToURL">isBoundToURL</a></td> <td class="imsum_right">Return whether the anchor of the called resource id object represents the same resource as the given anchor URL. This is a convenience variant of the <a href="#isBoundTo()">isBoundTo()</a> function that can also be seen as an optimization for the case that the anchor consists of exactly one URL. </td> </tr> <tr> <td class="imsum_left"><a href="#clone">clone</a></td> <td class="imsum_right">Return a copy of the called resource id. The caller becomes the owner of the new object. </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="getResourceURL" class="membertitle">getResourceURL</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">string</td> </tr> <tr> <td valign="top"><b>getResourceURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the URL of the resource. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasAnchor" class="membertitle">hasAnchor</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>hasAnchor</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return whether there is a non-empty anchor URL. When this method returns <b>false</b> then getAnchorURLs() will return an empty list. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAnchor" class="membertitle">getAnchor</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"><a href="XResourceId.html">XResourceId</a></td> </tr> <tr> <td valign="top"><b>getAnchor</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a new XResourceId that represents the anchor resource. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAnchorURLs" class="membertitle">getAnchorURLs</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAnchorURLs</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the, possibly empty, list of anchor URLs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getResourceTypePrefix" class="membertitle">getResourceTypePrefix</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">string</td> </tr> <tr> <td valign="top"><b>getResourceTypePrefix</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the type prefix of the resource URL. This includes all up to and including the second slash. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="compareTo" class="membertitle">compareTo</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">short</td> </tr> <tr> <td valign="top"><b>compareTo</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xId );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Compare the called <a href="XResourceId.html">XResourceId</a> object with the given one. </dd> <dd><p>The two resource ids are compared first by the number of their resource URLs and anchor URLs. When these numbers are the same then the URLs are compared like normal strings beginning with the resource URL.</p> </dd> <dt><b>Parameter xId</b></dt> <dd>The resource id to which the called resource id is compared. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>0</b> when the called object has the same number of URLs as the given object and all URLs of the called object are equal to their counterparts of the given object. Returns <code>-1</code> when the called object has a smaller number of URLs and <code>+1</code> when it has a larger number of URLs as the given object. When the number of URLs is the same then the result of comparing the first differing URL is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isBoundTo" class="membertitle">isBoundTo</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>isBoundTo</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xId,</td> </tr> <tr> <td/><td valign="top">[in] <a href="AnchorBindingMode.html">AnchorBindingMode</a></td> <td valign="bottom"> eMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return whether the anchor of the called resource id object represents the same resource as the given object. </dd> <dd><p>Note that not only the anchor of the given object is taken into account. The whole object, including the resource URL, is interpreted as anchor resource.</p> </dd> <dt><b>Parameter xAnchor</b></dt> <dd>The resource id of the anchor. </dd> <dt><b>Parameter eMode</b></dt> <dd>This mode specifies how the called resource has to be bound to the given anchor in order to have this function return <b>true</b>. <p>If eMode is <b>DIRECT</b> then the anchor of the called resource id has to be identical to the given anchor. If eMode is <b>INDIRECT</b> then the given anchor has to be a part of the anchor of the called resource. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isBoundToURL" class="membertitle">isBoundToURL</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>isBoundToURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sAnchorURL,</td> </tr> <tr> <td/><td valign="top">[in] <a href="AnchorBindingMode.html">AnchorBindingMode</a></td> <td valign="bottom"> eMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return whether the anchor of the called resource id object represents the same resource as the given anchor URL. This is a convenience variant of the <a href="#isBoundTo()">isBoundTo()</a> function that can also be seen as an optimization for the case that the anchor consists of exactly one URL. </dd> <dt><b>Parameter xAnchor</b></dt> <dd>The resource URL of the anchor. </dd> <dt><b>Parameter eMode</b></dt> <dd>This mode specifies how the called resource has to be bound to the given anchor in order to have this function return. See the description of <a href="#isBoundTo()">isBoundTo()</a> for more information. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clone" class="membertitle">clone</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"><a href="XResourceId.html">XResourceId</a></td> </tr> <tr> <td valign="top"><b>clone</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a copy of the called resource id. The caller becomes the owner of the new object. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2861
