<html> <head> <title>Interface XStringAbbreviation</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="XStringAbbreviation-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">util</a> :: </p> </td> </tr> <tr> <td class="title">interface XStringAbbreviation</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Abbreviate arbitrary strings. </dd> <dd><p>It is expected that there will be different implementations of this interface, that each expect strings conforming to a certain structure (e.g., URIs, platform-specific file paths, or newsgroup names). The abbreviation algorithms will then take into account the structural information.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XStringWidth.html">XStringWidth</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="#abbreviateString">abbreviateString</a></td> <td class="imsum_right">Abbreviate a string, so that the resulting abbreviated string is not wider than some given width. </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="abbreviateString" class="membertitle">abbreviateString</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>abbreviateString</b>(</td> <td valign="top">[in] <a href="XStringWidth.html">XStringWidth</a></td> <td valign="bottom"> xStringWidth,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nWidth,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Abbreviate a string, so that the resulting abbreviated string is not wider than some given width. </dd> <dd><p>The width of a string is an abstract concept here, measured via an <a href="XStringWidth.html">XStringWidth</a> interface. Examples are the number of characters in the string (<a href="XStringWidth.html">XStringWidth</a> will measure the string's length), or the width in pixel when displayed with a specific font (which <a href="XStringWidth.html">XStringWidth</a> would encapsulate).</p> </dd> <dt><b>Parameter xStringWidth</b></dt> <dd>The interface that makes concrete the abstract notion of string width. </dd> <dt><b>Parameter nWidth</b></dt> <dd>The resulting abbreviated string's width will be no larger than this. </dd> <dt><b>Parameter aString</b></dt> <dd>The string that is abbreviated. </dd> <dt><b>Returns</b></dt> <dd>an abbreviated string. </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>