|
Eclipse Platform Kepler (4.3) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.bidi.advanced.StructuredTextEnvironment
public class StructuredTextEnvironment
Describes the environment within which structured text strings are processed. It includes:
Field Summary | |
---|---|
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 | |
---|---|
StructuredTextEnvironment(java.lang.String lang,
boolean mirrored,
int orientation)
Creates an instance of a structured text environment. |
Method Summary | |
---|---|
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()
Checks if bidi processing is needed in this environment. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ORIENT_LTR
public static final int ORIENT_RTL
public static final int ORIENT_CONTEXTUAL
public static final int ORIENT_CONTEXTUAL_LTR
public static final int ORIENT_CONTEXTUAL_RTL
public static final int ORIENT_UNKNOWN
public static final int ORIENT_IGNORE
public static final StructuredTextEnvironment DEFAULT
StructuredTextEnvironment
instance which uses default locale,
non-mirrored environment, and a Left-to-Right presentation component.
Constructor Detail |
---|
public StructuredTextEnvironment(java.lang.String lang, boolean mirrored, int orientation)
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 |
---|
public java.lang.String getLanguage()
public boolean getMirrored()
true
if environment is mirroredpublic int getOrientation()
The orientation value is one of the following:
ORIENT_LTR
,ORIENT_RTL
,ORIENT_CONTEXTUAL_LTR
,ORIENT_CONTEXTUAL_RTL
,ORIENT_UNKNOWN
, orORIENT_IGNORE
public boolean isProcessingNeeded()
true
if bidi processing is needed in this environment.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
Eclipse Platform Kepler (4.3) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2012. All rights reserved.