<html> <head> <title>Interface XStringSubstitution</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="XStringSubstitution-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 XStringSubstitution</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A common interface for substituting string variables with other strings. </dd> <dd><p> The substitution algorithm and the syntax for a string variable are not part of this interface definition. Please look at the documentation of the implementation that must specify these parameters. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</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="#substituteVariables">substituteVariables</a></td> <td class="imsum_right">Exchanges variables inside a given text with a substitution text defined for the variables. </td> </tr> <tr> <td class="imsum_left"><a href="#reSubstituteVariables">reSubstituteVariables</a></td> <td class="imsum_right">Tries to replace parts of aText with variables that represents these sub strings. </td> </tr> <tr> <td class="imsum_left"><a href="#getSubstituteVariableValue">getSubstituteVariableValue</a></td> <td class="imsum_right">Returns the current value of a variable. </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="substituteVariables" class="membertitle">substituteVariables</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>substituteVariables</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aText,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bSubstRequired )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Exchanges variables inside a given text with a substitution text defined for the variables. </dd> <dd><p> The method iterates through it's internal variables list to match the variables in the given string. A match replaces the variable with the string defined for this variable. If no variable can be found in the string it will be returned unchanged. The behavior if a variable is found in the string but it is unknown for the implementation depends on the parameter bSubstRequired. </p> </dd> <dt><b>Parameter aText</b></dt> <dd>A string containing variables that should be substituted. </dd> <dt><b>Parameter bSubstRequired</b></dt> <dd>Specifies if a successfull substitution is required. The function throws a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if it finds a variable that is unknown. In this case it is possible that the returned string would not be what the caller expected! </dd> <dt><b>Returns</b></dt> <dd>Returns a string based on <var>aText</var> where all variables were exchanged with their value defined at calling time. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="reSubstituteVariables" class="membertitle">reSubstituteVariables</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>reSubstituteVariables</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aText );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Tries to replace parts of aText with variables that represents these sub strings. </dd> <dd><p> The method iterates through it's internal variable list and tries to match parts of the given string Tries to replace parts of <var>aText</var> with variables that represents these sub strings.If more than one variable matches the one with the longest matching sub string will be chosen. </p> </dd> <dt><b>Parameter aText</b></dt> <dd>A string where known substrings should be replaced by variables. </dd> <dt><b>Returns</b></dt> <dd>Returns the resubstituted string with variables for all parts that could be replaced. The unchanged argument will be returned if nothing can be resubtituted. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubstituteVariableValue" class="membertitle">getSubstituteVariableValue</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>getSubstituteVariableValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> variable )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the current value of a variable. </dd> <dd><p> The method iterates through it's internal variable list and tries to find the given variable. If the variable is unkown a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. </p> </dd> <dt><b>Parameter variable</b></dt> <dd>The name of a variable. </dd> <dt><b>Returns</b></dt> <dd>Returns a string that represents the variable. If the variable is unknown a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. </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
>
7729
