StructuredTextEnvironment (Eclipse Platform API Specification)

java.lang.Object
- org.eclipse.equinox.bidi.advanced.StructuredTextEnvironment

```
public class StructuredTextEnvironment
extends java.lang.Object
```
Describes the environment within which structured text strings are processed. It includes:
- locale,
- desired orientation,
- text mirroring attributes.

Field Summary

Fields
Modifier and Type	Field and Description
`static StructuredTextEnvironment`	`DEFAULT` Pre-defined `StructuredTextEnvironment` instance which uses default locale, non-mirrored environment, and a Left-to-Right presentation component.
`static int`	`ORIENT_CONTEXTUAL` Specifies that a GUI component should display text depending on the context (value is 2).
`static int`	`ORIENT_CONTEXTUAL_LTR` Specifies that a GUI component should display text depending on the context with default orientation being Left-To-Right (value is 2).
`static int`	`ORIENT_CONTEXTUAL_RTL` Specifies that a GUI component should display text depending on the context with default orientation being Right-To-Left (value is 3).
`static int`	`ORIENT_IGNORE` Used to specify that no directional formatting characters should be added as prefix or suffix (value is 8).
`static int`	`ORIENT_LTR` Specifies that a GUI component should display text Left-To-Right (value is 0).
`static int`	`ORIENT_RTL` Specifies that a GUI component should display text Right-To-Left (value is 1).
`static int`	`ORIENT_UNKNOWN` Used when the orientation of a GUI component is not known (value is 4).

Constructor Summary

Constructors
Constructor and Description
`StructuredTextEnvironment(java.lang.String lang, boolean mirrored, int orientation)` Creates an instance of a structured text environment.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getLanguage()` Returns a 2-letters code representing a language as defined by ISO-639.
`boolean`	`getMirrored()` Returns a flag indicating that structured text processed within this environment should assume that the GUI is mirrored (globally going from right to left).
`int`	`getOrientation()` Returns the orientation (a.k.a. base direction) of the GUI component in which the full structured text will be displayed.
`int`	`hashCode()`
`boolean`	`isProcessingNeeded()` Deprecated. let users control bidi processing independent of the locale

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ORIENT_LTR
```
public static final int ORIENT_LTR
```
    Specifies that a GUI component should display text Left-To-Right (value is 0).
    
    See Also:
    
    Constant Field Values
  - ORIENT_RTL
```
public static final int ORIENT_RTL
```
    Specifies that a GUI component should display text Right-To-Left (value is 1).
    
    See Also:
    
    Constant Field Values
  - ORIENT_CONTEXTUAL
```
public static final int ORIENT_CONTEXTUAL
```
    Specifies that a GUI component should display text depending on the context (value is 2).
    
    See Also:
    
    Constant Field Values
  - ORIENT_CONTEXTUAL_LTR
```
public static final int ORIENT_CONTEXTUAL_LTR
```
    Specifies that a GUI component should display text depending on the context with default orientation being Left-To-Right (value is 2).
    
    See Also:
    
    Constant Field Values
  - ORIENT_CONTEXTUAL_RTL
```
public static final int ORIENT_CONTEXTUAL_RTL
```
    Specifies that a GUI component should display text depending on the context with default orientation being Right-To-Left (value is 3).
    
    See Also:
    
    Constant Field Values
  - ORIENT_UNKNOWN
```
public static final int ORIENT_UNKNOWN
```
    Used when the orientation of a GUI component is not known (value is 4).
    
    See Also:
    
    Constant Field Values
  - ORIENT_IGNORE
```
public static final int ORIENT_IGNORE
```
    Used to specify that no directional formatting characters should be added as prefix or suffix (value is 8).
    
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final StructuredTextEnvironment DEFAULT
```
    Pre-defined StructuredTextEnvironment instance which uses default locale, non-mirrored environment, and a Left-to-Right presentation component.
- Constructor Detail
  - StructuredTextEnvironment
```
public StructuredTextEnvironment(java.lang.String lang,
                                 boolean mirrored,
                                 int orientation)
```
    Creates an instance of a structured text environment.
    
    Parameters:
    
    lang - the language of the environment, encoded as specified in ISO-639. Might be null, in which case the default locale is used.
    
    mirrored - specifies if the environment is mirrored.
    
    orientation - the orientation of the GUI component, one of the values: ORIENT_LTR, ORIENT_RTL, ORIENT_CONTEXTUAL_LTR, ORIENT_CONTEXTUAL_RTL, ORIENT_UNKNOWN, or ORIENT_IGNORE.
- Method Detail
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns a 2-letters code representing a language as defined by ISO-639.
    
    Returns:
    
    language of the environment
  - getMirrored
```
public boolean getMirrored()
```
    Returns a flag indicating that structured text processed within this environment should assume that the GUI is mirrored (globally going from right to left).
    
    Returns:
    
    true if environment is mirrored
  - getOrientation
```
public int getOrientation()
```
    Returns the orientation (a.k.a. base direction) of the GUI component in which the full structured text will be displayed.
    The orientation value is one of the following:
    - ORIENT_LTR,
    - ORIENT_RTL,
    - ORIENT_CONTEXTUAL_LTR,
    - ORIENT_CONTEXTUAL_RTL,
    - ORIENT_UNKNOWN, or
    - ORIENT_IGNORE
  - isProcessingNeeded
```
public boolean isProcessingNeeded()
```
    Deprecated. let users control bidi processing independent of the locale
    
    Checks if bidi processing is needed in this environment. The result depends on the operating system (must be supported by this package) and on the language supplied when constructing the instance (it must be a language using a bidirectional script).
    Note: This API is rarely used any more. E.g. in Eclipse/JFace, bidi support is typically controlled by the application via org.eclipse.jface.util.BidiUtils#setBidiSupport(boolean).
    
    Returns:
    
    true if bidi processing is needed in this environment.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StructuredTextEnvironment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORIENT_LTR

ORIENT_RTL

ORIENT_CONTEXTUAL

ORIENT_CONTEXTUAL_LTR

ORIENT_CONTEXTUAL_RTL

ORIENT_UNKNOWN

ORIENT_IGNORE

DEFAULT

Constructor Detail

StructuredTextEnvironment

Method Detail

getLanguage

getMirrored

getOrientation

isProcessingNeeded

hashCode

equals