Eclipse Platform
Release 4.2

org.eclipse.equinox.bidi
Class STextProcessor

java.lang.Object
  extended by org.eclipse.equinox.bidi.STextProcessor

public final class STextProcessor
extends Object

Provides methods to process bidirectional text with a specific structure. The methods in this class are the most straightforward way to add directional formatting characters to the source text to ensure correct presentation, or to remove those characters to restore the original text (for more explanations, please see the package documentation).

Restriction:
This class is not intended to be subclassed by clients.
Restriction:
This class is not intended to be instantiated by clients.

Method Summary
static String deprocess(String str)
          Removes directional formatting characters in the given string.
static String deprocessTyped(String str, String textType)
          Removes directional formatting characters in the given string.
static String getDefaultSeparators()
          Returns a string containing all the default separator characters to be used to segment a given string.
static String process(String str)
          Processes the given (lean) text and returns a string with appropriate directional formatting characters (full text).
static String process(String str, String separators)
          Processes a string that has a particular semantic meaning to render it correctly on bidi locales.
static String processTyped(String str, String textType)
          Processes a string that has a particular semantic meaning to render it correctly on bidi locales.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

process

public static String process(String str)
Processes the given (lean) text and returns a string with appropriate directional formatting characters (full text). This is equivalent to calling process(String str, String separators) with the default set of separators.

The processing adds directional formatting characters so that presentation using the Unicode Bidirectional Algorithm will provide the expected result. The text is segmented according to the provided separators. Each segment has the Unicode Bidi Algorithm applied to it, but as a whole, the string is oriented left to right.

For example, a file path such as d:\myfolder\FOLDER\MYFILE.java (where capital letters indicate RTL text) should render as d:\myfolder\REDLOF\ELIFYM.java.

Parameters:
str - the lean text to process.
Returns:
the processed string (full text).
See Also:
deprocess(String)

process

public static String process(String str,
                             String separators)
Processes a string that has a particular semantic meaning to render it correctly on bidi locales. For more details, see process(String).

Parameters:
str - the lean text to process.
separators - characters by which the string will be segmented.
Returns:
the processed string (full text).
See Also:
deprocess(String)

processTyped

public static String processTyped(String str,
                                  String textType)
Processes a string that has a particular semantic meaning to render it correctly on bidi locales. For more details, see process(String).

Parameters:
str - the lean text to process.
textType - an identifier for the structured text handler appropriate for the type of the text submitted. It may be one of the identifiers defined in STextTypeHandlerFactory or a type handler identifier registered by a plug-in.
Returns:
the processed string (full text).
See Also:
deprocessTyped(java.lang.String, java.lang.String)

deprocess

public static String deprocess(String str)
Removes directional formatting characters in the given string.

Parameters:
str - string with directional characters to remove (full text).
Returns:
string without directional formatting characters (lean text).

deprocessTyped

public static String deprocessTyped(String str,
                                    String textType)
Removes directional formatting characters in the given string.

Parameters:
str - string with directional characters to remove (full text).
textType - an identifier for the structured text handler appropriate for the type of the text submitted. It may be one of the identifiers defined in STextTypeHandlerFactory or a type handler identifier registered by a plug-in.
Returns:
string without directional formatting characters (lean text).
See Also:
processTyped(String, String)

getDefaultSeparators

public static String getDefaultSeparators()
Returns a string containing all the default separator characters to be used to segment a given string.

Returns:
string containing all separators.

Eclipse Platform
Release 4.2

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2013. All rights reserved.