blob: 9286b1d57ac6e60b8a41b75f88768003e8632278 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<body bgcolor="white">
<p>
This package provides classes for users who need finer control
on structured text handling.
In particular, the user should use the methods in the
<a href="IStructuredTextExpert.html">IStructuredTextExpert</a> class
in the following cases:</p>
<ul>
<li>The structured type handler to use is not one of those
predefined in <a href="../StructuredTextTypeHandlerFactory.html">
StructuredTextTypeHandlerFactory</a>.</li>
<li>A non-default <a href="StructuredTextEnvironment.html">
environment</a> needs to be specified.</li>
<li>A call to a method processing a piece of text may create a state
which affects the processing of the next piece of text.</li>
<li>The user needs to manage the offsets where directional formatting
characters are inserted in the text.</li>
</ul>
<p>
Note that the basic functions are provided in package
<a href="../package-summary.html">
org.eclipse.equinox.bidi</a> and its
<a href="../StructuredTextProcessor.html">StructuredTextProcessor</a> class.
</p><p>
To access the more sophisticated methods for processing structured text,
the user should proceed as follows:</p>
<ul>
<li>The user has to obtain an appropriate
<code>IStructuredTextExpert</code> instance using the methods in
<a href="StructuredTextExpertFactory.html">StructuredTextExpertFactory</a>.</li>
<li>The user may then invoke the more sophisticated methods provided by
<a href="IStructuredTextExpert.html">IStructuredTextExpert</a>
for processing the structured text.</li>
<li>If those methods should work in an environment different from the default,
the user may specify properties of the environment using the class
<a href="StructuredTextEnvironment.html">StructuredTextEnvironment</a>.
<p>
This should be done before obtaining a <code>IStructuredTextExpert</code> instance,
and the specific environment must be specified when invoking
<code>StructuredTextExpertFactory</code> methods. This will
associate a type handler with the given environment and provide
a customized <code>IStructuredTextExpert</code> instance to the user.</p></li>
</ul>
</body>
</html>