Spec-Zone.ru › OpenJDK 24

Класс Bidi

java.lang.Object
java.text.Bidi
public final class Bidi extends Object
Этот класс реализует алгоритм Unicode Bidirectional Algorithm.

Объект Bidi предоставляет информацию о двунаправленном упорядочивании текста, используемого для его создания. Это необходимо, например, для правильного отображения текста на арабском или иврите. Эти языки по своей природе смешанно-направленные, поскольку цифры в них упорядочиваются слева направо, в то время как большинство других текстов упорядочивается справа налево.

После создания объект Bidi можно запросить, чтобы узнать, является ли текст, который он представляет, полностью слева направо или полностью справа налево. Такие объекты очень лёгкие, и этот текст относительно легко обрабатывать.

Если есть несколько блоков текста, информация о блоках может быть получена по индексу, чтобы получить начало, границу и уровень блока. Уровень представляет собой как направление, так и 'уровень вложенности' двунаправленного блока. Нечётные уровни — справа налево, а чётные — слева направо. Например, уровень 0 представляет текст слева направо, уровень 1 — справа налево, а уровень 2 — текст слева направо, вложенный в блок справа налево.

С:
1.4

Краткое описание полей

Модификатор и тип Поле Описание
static final int DIRECTION_DEFAULT_LEFT_TO_RIGHT
Константа, указывающая, что основное направление зависит от первого сильного направленного символа в тексте в соответствии с алгоритмом Unicode Bidirectional Algorithm.
static final int DIRECTION_DEFAULT_RIGHT_TO_LEFT
Константа, указывающая, что основное направление зависит от первого сильного направленного символа в тексте в соответствии с алгоритмом Unicode Bidirectional Algorithm.
static final int DIRECTION_LEFT_TO_RIGHT
Константа, указывающая, что основное направление — слева направо.
static final int DIRECTION_RIGHT_TO_LEFT
Константа, указывающая, что основное направление — справа налево.

Краткое описание конструкторов

Конструктор Описание
Bidi(char[] text, int textStart, byte[] embeddings, int embStart, int paragraphLength, int flags)
Создаёт объект Bidi из заданного текста, информации о вложении и направлении.
Bidi(String paragraph, int flags)
Создаёт объект Bidi из заданного абзаца текста и основного направления.
Bidi(AttributedCharacterIterator paragraph)
Создаёт объект Bidi из заданного абзаца текста.

Краткое описание методов

Модификатор и тип Метод Описание
boolean baseIsLeftToRight()
Возвращает true, если основное направление слева направо.
Bidi createLineBidi(int lineStart, int lineLimit)
Создаёт объект Bidi, представляющий информацию о двунаправленности строки текста в абзаце, представленном текущим объектом Bidi.
int getBaseLevel()
Возвращает базовый уровень (0, если слева направо, 1, если справа налево).
int getLength()
Возвращает длину текста в строке.
int getLevelAt(int offset)
Возвращает разрешённый уровень символа по смещению.
int getRunCount()
Возвращает количество блоков уровня.
int getRunLevel(int run)
Возвращает уровень n-го логического блока в этой строке.
int getRunLimit(int run)
Возвращает индекс символа после конца n-го логического блока в этой строке, как смещение от начала строки.
int getRunStart(int run)
Возвращает индекс символа в начале n-го логического блока в этой строке, как смещение от начала строки.
boolean isLeftToRight()
Возвращает true, если строка — это текст слева направо, и основное направление — слева направо.
boolean isMixed()
Возвращает true, если строка не слева направо или справа налево.
boolean isRightToLeft()
Возвращает true, если строка — это текст справа налево, и основное направление — справа налево.
static void reorderVisually(byte[] levels, int levelStart, Object[] objects, int objectStart, int count)
Переупорядочивает объекты в массиве в визуальном порядке на основе их уровней.
static boolean requiresBidi(char[] text, int start, int limit)
Возвращает true, если заданный текст требует анализа двунаправленности.
String toString()
Отображает внутреннее состояние двунаправленности, используется при отладке.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание полей

DIRECTION_LEFT_TO_RIGHT

public static final int DIRECTION_LEFT_TO_RIGHT
Константа, указывающая, что основное направление слева направо.
См. также:
  • Значения константных полей

DIRECTION_RIGHT_TO_LEFT

public static final int DIRECTION_RIGHT_TO_LEFT
Константа, указывающая, что основное направление справа налево.
См. также:
  • Значения константных полей

DIRECTION_DEFAULT_LEFT_TO_RIGHT

public static final int DIRECTION_DEFAULT_LEFT_TO_RIGHT
Константа, указывающая, что основное направление зависит от первого сильного символа направления в тексте в соответствии с алгоритмом Unicode Bidirectional. Если сильного символа направления нет, основное направление слева направо.
См. также:
  • Значения константных полей

DIRECTION_DEFAULT_RIGHT_TO_LEFT

public static final int DIRECTION_DEFAULT_RIGHT_TO_LEFT
Константа, указывающая, что основное направление зависит от первого сильного символа направления в тексте в соответствии с алгоритмом Unicode Bidirectional. Если сильного символа направления нет, основное направление справа налево.
См. также:
  • Значения константных полей

Подробное описание конструкторов

Bidi

public Bidi(String paragraph, int flags)
Создаёт объект Bidi из заданного абзаца текста и основного направления.
Параметры:
paragraph - абзац текста
flags - набор флагов, которые управляют алгоритмом. Алгоритм понимает флаги DIRECTION_LEFT_TO_RIGHT, DIRECTION_RIGHT_TO_LEFT, DIRECTION_DEFAULT_LEFT_TO_RIGHT и DIRECTION_DEFAULT_RIGHT_TO_LEFT. Другие значения зарезервированы.

Bidi

public Bidi(AttributedCharacterIterator paragraph)
Создаёт объект Bidi из заданного абзаца текста.

Атрибут RUN_DIRECTION в тексте, если он присутствует, определяет основное направление (слева направо или справа налево). Если он отсутствует, основное направление вычисляется с помощью алгоритма Unicode Bidirectional, по умолчанию слева направо, если в тексте нет сильных символов направления. Этот атрибут, если он присутствует, должен быть применён ко всему тексту в абзаце.

Атрибут BIDI_EMBEDDING в тексте, если он присутствует, представляет информацию об уровне встраивания. Отрицательные значения от -1 до -62 указывают на переопределения в абсолютном значении уровня. Положительные значения от 1 до 62 указывают на встраивание. Там, где значения равны нулю или не определены, предполагается основной уровень встраивания, определяемый основным направлением.

Атрибут NUMERIC_SHAPING в тексте, если он присутствует, преобразует европейские цифры в другие десятичные цифры перед запуском алгоритма bidi. Этот атрибут, если он присутствует, должен быть применён ко всему тексту в абзаце.

Параметры:
paragraph - абзац текста с необязательной информацией об атрибутах символов и абзаца
См. также:
  • TextAttribute.BIDI_EMBEDDING
  • TextAttribute.NUMERIC_SHAPING
  • TextAttribute.RUN_DIRECTION

Bidi

public Bidi(char[] text, int textStart, byte[] embeddings, int embStart, int paragraphLength, int flags)
Создаёт объект Bidi из заданного текста, информации о встраивании и направлении. Массив встраиваний может быть null. Если присутствует, значения представляют информацию о уровне встраивания. Отрицательные значения от -1 до -61 указывают на переопределения в абсолютном значении уровня. Положительные значения от 1 до 61 указывают на встраивание. Где значения равны нулю, предполагается основной уровень встраивания, определяемый основным направлением.
Параметры:
text - массив, содержащий абзац текста для обработки.
textStart - индекс в массиве текста начала абзаца.
embeddings - массив, содержащий значения встраивания для каждого символа в абзаце. Может быть null, в этом случае предполагается, что нет внешней информации о встраивании.
embStart - индекс в массиве встраивания начала абзаца.
paragraphLength - длина абзаца в массивах текста и встраивания.
flags - набор флагов, которые управляют алгоритмом. Алгоритм понимает флаги DIRECTION_LEFT_TO_RIGHT, DIRECTION_RIGHT_TO_LEFT, DIRECTION_DEFAULT_LEFT_TO_RIGHT и DIRECTION_DEFAULT_RIGHT_TO_LEFT. Другие значения зарезервированы.

Подробное описание методов

createLineBidi

public Bidi createLineBidi(int lineStart, int lineLimit)
Создаёт объект Bidi, представляющий информацию bidi для строки текста в абзаце, представленном текущим объектом Bidi. Этот вызов не требуется, если весь абзац помещается в одну строку.
Параметры:
lineStart - смещение от начала абзаца до начала строки.
lineLimit - смещение от начала абзаца до конца строки.
Возвращает:
объект Bidi

isMixed

public boolean isMixed()
Возвращает true, если строка не слева направо или справа налево. Это означает, что она либо содержит смешанные фрагменты текста слева направо и справа налево, либо основное направление отличается от направления единственного фрагмента текста.
Возвращает:
true, если строка не слева направо или справа налево.

isLeftToRight

public boolean isLeftToRight()
Возвращает true, если строка состоит только из текста слева направо, и основное направление слева направо.
Возвращает:
true, если строка состоит только из текста слева направо, и основное направление слева направо

isRightToLeft

public boolean isRightToLeft()
Возвращает true, если строка состоит только из текста справа налево, и основное направление справа налево.
Возвращает:
true, если строка состоит только из текста справа налево, и основное направление справа налево

getLength

public int getLength()
Возвращает длину текста в строке.
Возвращает:
длину текста в строке

baseIsLeftToRight

public boolean baseIsLeftToRight()
Возвращает true, если основное направление слева направо.
Возвращает:
true, если основное направление слева направо

getBaseLevel

public int getBaseLevel()
Возвращает базовый уровень (0, если слева направо, 1, если справа налево).
Возвращает:
базовый уровень

getLevelAt

public int getLevelAt(int offset)
Возвращает разрешённый уровень символа по смещению. Если смещение < 0 или ≥ длины строки, возвращает уровень основного направления.
Параметры:
offset - индекс символа, для которого требуется вернуть уровень
Возвращает:
разрешённый уровень символа по смещению

getRunCount

public int getRunCount()
Возвращает количество фрагментов уровня.
Возвращает:
количество фрагментов уровня

getRunLevel

public int getRunLevel(int run)
Возвращает уровень n-го логического фрагмента в этой строке.
Параметры:
run - индекс фрагмента, от 0 до getRunCount()
Возвращает:
уровень фрагмента

getRunStart

public int getRunStart(int run)
Возвращает индекс символа в начале n-го логического фрагмента в этой строке, как смещение от начала строки.
Параметры:
run - индекс фрагмента, от 0 до getRunCount()
Возвращает:
начало фрагмента

getRunLimit

public int getRunLimit(int run)
Возвращает индекс символа после конца n-го логического фрагмента в этой строке, как смещение от начала строки. Например, для последнего фрагмента в строке возвращается длина строки.
Параметры:
run - индекс фрагмента, от 0 до getRunCount()
Возвращает:
предел фрагмента

requiresBidi

public static boolean requiresBidi(char[] text, int start, int limit)
Возвращает true, если для указанного текста требуется анализ bidi. Если это возвращает false, текст будет отображаться слева направо. Клиенты могут тогда избежать создания объекта Bidi. Текст в области Arabic Presentation Forms Unicode предполагается уже оформленным и отсортированным для отображения, и поэтому не заставит эту функцию возвращать true.
Параметры:
text - текст, содержащий символы для проверки
start - начало диапазона символов для проверки
limit - граница диапазона символов для проверки
Возвращает:
true, если диапазон символов требует анализа bidi

reorderVisually

public static void reorderVisually(byte[] levels, int levelStart, Object[] objects, int objectStart, int count)
Переупорядочивает объекты в массиве в визуальном порядке, основанном на их уровнях. Это вспомогательная функция для использования, когда у вас есть набор объектов, представляющих блоки текста в логическом порядке, каждый блок содержит текст на одном уровне. Элементы с index по objectStart до objectStart + count в массиве объектов будут переупорядочены в визуальный порядок, предполагая, что каждый блок текста имеет уровень, указанный соответствующим элементом в массиве уровней (в index - objectStart + levelStart).
Параметры:
levels - массив, представляющий уровень bidi каждого объекта
levelStart - начальная позиция в массиве уровней
objects - массив объектов, которые должны быть переупорядочены в визуальном порядке
objectStart - начальная позиция в массиве объектов
count - количество объектов для переупорядочения

toString

public String toString()
Отображает внутреннее состояние bidi, используется при отладке.
Переопределяет:
toString в классе Object
Возвращает:
строковое представление объекта

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/text/Bidi.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API