java/javase/note/docs/api/java.base/java/text/Bidi.html at master · ScheniCode/java

908 lines (908 loc) · 37.4 KB
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<!-- Generated by javadoc -->
<title>Bidi (Java SE 12 &amp; JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.text.Bidi class">
<meta name="keywords" content="DIRECTION_LEFT_TO_RIGHT">
<meta name="keywords" content="DIRECTION_RIGHT_TO_LEFT">
<meta name="keywords" content="DIRECTION_DEFAULT_LEFT_TO_RIGHT">
<meta name="keywords" content="DIRECTION_DEFAULT_RIGHT_TO_LEFT">
<meta name="keywords" content="createLineBidi()">
<meta name="keywords" content="isMixed()">
<meta name="keywords" content="isLeftToRight()">
<meta name="keywords" content="isRightToLeft()">
<meta name="keywords" content="getLength()">
<meta name="keywords" content="baseIsLeftToRight()">
<meta name="keywords" content="getBaseLevel()">
<meta name="keywords" content="getLevelAt()">
<meta name="keywords" content="getRunCount()">
<meta name="keywords" content="getRunLevel()">
<meta name="keywords" content="getRunStart()">
<meta name="keywords" content="getRunLimit()">
<meta name="keywords" content="requiresBidi()">
<meta name="keywords" content="reorderVisually()">
<meta name="keywords" content="toString()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
<script type="text/javascript"><!--
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Bidi (Java SE 12 & JDK 12 )";
    catch(err) {
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":9,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Bidi.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<a id="skip.navbar.top">
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">java.text</a></div>
<h2 title="Class Bidi" class="title">Class Bidi</h2>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<ul class="inheritance">
<li>java.text.Bidi</li>
<div class="description">
<ul class="blockList">
<li class="blockList">
<pre>public final class <span class="typeNameLabel">Bidi</span>
extends <a href="../lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">This class implements the Unicode Bidirectional Algorithm.
 A Bidi object provides information on the bidirectional reordering of the text
 used to create it.  This is required, for example, to properly display Arabic
 or Hebrew text.  These languages are inherently mixed directional, as they order
 numbers from left-to-right while ordering most other text from right-to-left.
 Once created, a Bidi object can be queried to see if the text it represents is
 all left-to-right or all right-to-left.  Such objects are very lightweight and
 this text is relatively easy to process.
 If there are multiple runs of text, information about the runs can be accessed
 by indexing to get the start, limit, and level of a run.  The level represents
 both the direction and the 'nesting level' of a directional run.  Odd levels
 are right-to-left, while even levels are left-to-right.  So for example level
 0 represents left-to-right text, while level 1 represents right-to-left text, and
 level 2 represents left-to-right text embedded in a right-to-left run.</div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<h3>Field Summary</h3>
<div class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DIRECTION_DEFAULT_LEFT_TO_RIGHT">DIRECTION_DEFAULT_LEFT_TO_RIGHT</a></span></code></th>
<td class="colLast">
<div class="block">Constant indicating that the base direction depends on the first strong
 directional character in the text according to the Unicode
 Bidirectional Algorithm.</div>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DIRECTION_DEFAULT_RIGHT_TO_LEFT">DIRECTION_DEFAULT_RIGHT_TO_LEFT</a></span></code></th>
<td class="colLast">
<div class="block">Constant indicating that the base direction depends on the first strong
 directional character in the text according to the Unicode
 Bidirectional Algorithm.</div>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DIRECTION_LEFT_TO_RIGHT">DIRECTION_LEFT_TO_RIGHT</a></span></code></th>
<td class="colLast">
<div class="block">Constant indicating base direction is left-to-right.</div>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DIRECTION_RIGHT_TO_LEFT">DIRECTION_RIGHT_TO_LEFT</a></span></code></th>
<td class="colLast">
<div class="block">Constant indicating base direction is right-to-left.</div>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<h3>Constructor Summary</h3>
<div class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(char%5B%5D,int,byte%5B%5D,int,int,int)">Bidi</a></span>&#8203;(char[]&nbsp;text,
    int&nbsp;textStart,
    byte[]&nbsp;embeddings,
    int&nbsp;embStart,
    int&nbsp;paragraphLength,
    int&nbsp;flags)</code></th>
<td class="colLast">
<div class="block">Create Bidi from the given text, embedding, and direction information.</div>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,int)">Bidi</a></span>&#8203;(<a href="../lang/String.html" title="class in java.lang">String</a>&nbsp;paragraph,
    int&nbsp;flags)</code></th>
<td class="colLast">
<div class="block">Create Bidi from the given paragraph of text and base direction.</div>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.text.AttributedCharacterIterator)">Bidi</a></span>&#8203;(<a href="AttributedCharacterIterator.html" title="interface in java.text">AttributedCharacterIterator</a>&nbsp;paragraph)</code></th>
<td class="colLast">
<div class="block">Create Bidi from the given paragraph of text.</div>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor" id="i0">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#baseIsLeftToRight()">baseIsLeftToRight</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the base direction is left-to-right.</div>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="Bidi.html" title="class in java.text">Bidi</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createLineBidi(int,int)">createLineBidi</a></span>&#8203;(int&nbsp;lineStart,
              int&nbsp;lineLimit)</code></th>
<td class="colLast">
<div class="block">Create a Bidi object representing the bidi information on a line of text within
 the paragraph represented by the current Bidi.</div>
<tr class="altColor" id="i2">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseLevel()">getBaseLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the base level (0 if left-to-right, 1 if right-to-left).</div>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the length of text in the line.</div>
<tr class="altColor" id="i4">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLevelAt(int)">getLevelAt</a></span>&#8203;(int&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Return the resolved level of the character at offset.</div>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunCount()">getRunCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the number of level runs.</div>
<tr class="altColor" id="i6">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunLevel(int)">getRunLevel</a></span>&#8203;(int&nbsp;run)</code></th>
<td class="colLast">
<div class="block">Return the level of the nth logical run in this line.</div>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunLimit(int)">getRunLimit</a></span>&#8203;(int&nbsp;run)</code></th>
<td class="colLast">
<div class="block">Return the index of the character past the end of the nth logical run in this line, as
 an offset from the start of the line.</div>
<tr class="altColor" id="i8">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunStart(int)">getRunStart</a></span>&#8203;(int&nbsp;run)</code></th>
<td class="colLast">
<div class="block">Return the index of the character at the start of the nth logical run in this line, as
 an offset from the start of the line.</div>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLeftToRight()">isLeftToRight</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the line is all left-to-right text and the base direction is left-to-right.</div>
<tr class="altColor" id="i10">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMixed()">isMixed</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the line is not left-to-right or right-to-left.</div>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRightToLeft()">isRightToLeft</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the line is all right-to-left text, and the base direction is right-to-left.</div>
<tr class="altColor" id="i12">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reorderVisually(byte%5B%5D,int,java.lang.Object%5B%5D,int,int)">reorderVisually</a></span>&#8203;(byte[]&nbsp;levels,
               int&nbsp;levelStart,
               <a href="../lang/Object.html" title="class in java.lang">Object</a>[]&nbsp;objects,
               int&nbsp;objectStart,
               int&nbsp;count)</code></th>
<td class="colLast">
<div class="block">Reorder the objects in the array into visual order based on their levels.</div>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresBidi(char%5B%5D,int,int)">requiresBidi</a></span>&#8203;(char[]&nbsp;text,
            int&nbsp;start,
            int&nbsp;limit)</code></th>
<td class="colLast">
<div class="block">Return true if the specified text requires bidi analysis.</div>
<tr class="altColor" id="i14">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Display the bidi internal state, used in debugging.</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<h3>Methods declared in class&nbsp;java.lang.<a href="../lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../lang/Object.html#clone()">clone</a>, <a href="../lang/Object.html#equals(java.lang.Object)">equals</a>, <a href="../lang/Object.html#finalize()">finalize</a>, <a href="../lang/Object.html#getClass()">getClass</a>, <a href="../lang/Object.html#hashCode()">hashCode</a>, <a href="../lang/Object.html#notify()">notify</a>, <a href="../lang/Object.html#notifyAll()">notifyAll</a>, <a href="../lang/Object.html#wait()">wait</a>, <a href="../lang/Object.html#wait(long)">wait</a>, <a href="../lang/Object.html#wait(long,int)">wait</a></code></li>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<h3>Field Detail</h3>
<a id="DIRECTION_LEFT_TO_RIGHT">
<ul class="blockList">
<li class="blockList">
<h4>DIRECTION_LEFT_TO_RIGHT</h4>
<pre>public static final&nbsp;int DIRECTION_LEFT_TO_RIGHT</pre>
<div class="block">Constant indicating base direction is left-to-right.</div>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.text.Bidi.DIRECTION_LEFT_TO_RIGHT">Constant Field Values</a></dd>
<a id="DIRECTION_RIGHT_TO_LEFT">
<ul class="blockList">
<li class="blockList">
<h4>DIRECTION_RIGHT_TO_LEFT</h4>
<pre>public static final&nbsp;int DIRECTION_RIGHT_TO_LEFT</pre>
<div class="block">Constant indicating base direction is right-to-left.</div>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.text.Bidi.DIRECTION_RIGHT_TO_LEFT">Constant Field Values</a></dd>
<a id="DIRECTION_DEFAULT_LEFT_TO_RIGHT">
<ul class="blockList">
<li class="blockList">
<h4>DIRECTION_DEFAULT_LEFT_TO_RIGHT</h4>
<pre>public static final&nbsp;int DIRECTION_DEFAULT_LEFT_TO_RIGHT</pre>
<div class="block">Constant indicating that the base direction depends on the first strong
 directional character in the text according to the Unicode
 Bidirectional Algorithm.  If no strong directional character is present,
 the base direction is left-to-right.</div>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.text.Bidi.DIRECTION_DEFAULT_LEFT_TO_RIGHT">Constant Field Values</a></dd>
<a id="DIRECTION_DEFAULT_RIGHT_TO_LEFT">
<ul class="blockListLast">
<li class="blockList">
<h4>DIRECTION_DEFAULT_RIGHT_TO_LEFT</h4>
<pre>public static final&nbsp;int DIRECTION_DEFAULT_RIGHT_TO_LEFT</pre>
<div class="block">Constant indicating that the base direction depends on the first strong
 directional character in the text according to the Unicode
 Bidirectional Algorithm.  If no strong directional character is present,
 the base direction is right-to-left.</div>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#java.text.Bidi.DIRECTION_DEFAULT_RIGHT_TO_LEFT">Constant Field Values</a></dd>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,int)">
<ul class="blockList">
<li class="blockList">
<h4>Bidi</h4>
<pre>public&nbsp;Bidi&#8203;(<a href="../lang/String.html" title="class in java.lang">String</a>&nbsp;paragraph,
            int&nbsp;flags)</pre>
<div class="block">Create Bidi from the given paragraph of text and base direction.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paragraph</code> - a paragraph of text</dd>
<dd><code>flags</code> - a collection of flags that control the algorithm.  The
 algorithm understands the flags DIRECTION_LEFT_TO_RIGHT, DIRECTION_RIGHT_TO_LEFT,
 DIRECTION_DEFAULT_LEFT_TO_RIGHT, and DIRECTION_DEFAULT_RIGHT_TO_LEFT.
 Other values are reserved.</dd>
<a id="&lt;init&gt;(java.text.AttributedCharacterIterator)">
<ul class="blockList">
<li class="blockList">
<h4>Bidi</h4>
<pre>public&nbsp;Bidi&#8203;(<a href="AttributedCharacterIterator.html" title="interface in java.text">AttributedCharacterIterator</a>&nbsp;paragraph)</pre>
<div class="block">Create Bidi from the given paragraph of text.
 The RUN_DIRECTION attribute in the text, if present, determines the base
 direction (left-to-right or right-to-left).  If not present, the base
 direction is computes using the Unicode Bidirectional Algorithm, defaulting to left-to-right
 if there are no strong directional characters in the text.  This attribute, if
 present, must be applied to all the text in the paragraph.
 The BIDI_EMBEDDING attribute in the text, if present, represents embedding level
 information.  Negative values from -1 to -62 indicate overrides at the absolute value
 of the level.  Positive values from 1 to 62 indicate embeddings.  Where values are
 zero or not defined, the base embedding level as determined by the base direction
 is assumed.
 The NUMERIC_SHAPING attribute in the text, if present, converts European digits to
 other decimal digits before running the bidi algorithm.  This attribute, if present,
 must be applied to all the text in the paragraph.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paragraph</code> - a paragraph of text with optional character and paragraph attribute information</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../java.desktop/java/awt/font/TextAttribute.html#BIDI_EMBEDDING"><code>TextAttribute.BIDI_EMBEDDING</code></a>, 
<a href="../../../java.desktop/java/awt/font/TextAttribute.html#NUMERIC_SHAPING"><code>TextAttribute.NUMERIC_SHAPING</code></a>, 
<a href="../../../java.desktop/java/awt/font/TextAttribute.html#RUN_DIRECTION"><code>TextAttribute.RUN_DIRECTION</code></a></dd>
<a id="&lt;init&gt;(char[],int,byte[],int,int,int)">
<ul class="blockListLast">
<li class="blockList">
<h4>Bidi</h4>
<pre>public&nbsp;Bidi&#8203;(char[]&nbsp;text,
            int&nbsp;textStart,
            byte[]&nbsp;embeddings,
            int&nbsp;embStart,
            int&nbsp;paragraphLength,
            int&nbsp;flags)</pre>
<div class="block">Create Bidi from the given text, embedding, and direction information.
 The embeddings array may be null.  If present, the values represent embedding level
 information.  Negative values from -1 to -61 indicate overrides at the absolute value
 of the level.  Positive values from 1 to 61 indicate embeddings.  Where values are
 zero, the base embedding level as determined by the base direction is assumed.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - an array containing the paragraph of text to process.</dd>
<dd><code>textStart</code> - the index into the text array of the start of the paragraph.</dd>
<dd><code>embeddings</code> - an array containing embedding values for each character in the paragraph.
 This can be null, in which case it is assumed that there is no external embedding information.</dd>
<dd><code>embStart</code> - the index into the embedding array of the start of the paragraph.</dd>
<dd><code>paragraphLength</code> - the length of the paragraph in the text and embeddings arrays.</dd>
<dd><code>flags</code> - a collection of flags that control the algorithm.  The
 algorithm understands the flags DIRECTION_LEFT_TO_RIGHT, DIRECTION_RIGHT_TO_LEFT,
 DIRECTION_DEFAULT_LEFT_TO_RIGHT, and DIRECTION_DEFAULT_RIGHT_TO_LEFT.
 Other values are reserved.</dd>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<h3>Method Detail</h3>
<a id="createLineBidi(int,int)">
<ul class="blockList">
<li class="blockList">
<h4>createLineBidi</h4>
<pre class="methodSignature">public&nbsp;<a href="Bidi.html" title="class in java.text">Bidi</a>&nbsp;createLineBidi&#8203;(int&nbsp;lineStart,
                           int&nbsp;lineLimit)</pre>
<div class="block">Create a Bidi object representing the bidi information on a line of text within
 the paragraph represented by the current Bidi.  This call is not required if the
 entire paragraph fits on one line.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lineStart</code> - the offset from the start of the paragraph to the start of the line.</dd>
<dd><code>lineLimit</code> - the offset from the start of the paragraph to the limit of the line.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Bidi</code> object</dd>
<a id="isMixed()">
<ul class="blockList">
<li class="blockList">
<h4>isMixed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMixed()</pre>
<div class="block">Return true if the line is not left-to-right or right-to-left.  This means it either has mixed runs of left-to-right
 and right-to-left text, or the base direction differs from the direction of the only run of text.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the line is not left-to-right or right-to-left.</dd>
<a id="isLeftToRight()">
<ul class="blockList">
<li class="blockList">
<h4>isLeftToRight</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isLeftToRight()</pre>
<div class="block">Return true if the line is all left-to-right text and the base direction is left-to-right.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the line is all left-to-right text and the base direction is left-to-right</dd>
<a id="isRightToLeft()">
<ul class="blockList">
<li class="blockList">
<h4>isRightToLeft</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRightToLeft()</pre>
<div class="block">Return true if the line is all right-to-left text, and the base direction is right-to-left.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the line is all right-to-left text, and the base direction is right-to-left</dd>
<a id="getLength()">
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getLength()</pre>
<div class="block">Return the length of text in the line.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the length of text in the line</dd>
<a id="baseIsLeftToRight()">
<ul class="blockList">
<li class="blockList">
<h4>baseIsLeftToRight</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;baseIsLeftToRight()</pre>
<div class="block">Return true if the base direction is left-to-right.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the base direction is left-to-right</dd>
<a id="getBaseLevel()">
<ul class="blockList">
<li class="blockList">
<h4>getBaseLevel</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBaseLevel()</pre>
<div class="block">Return the base level (0 if left-to-right, 1 if right-to-left).</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the base level</dd>
<a id="getLevelAt(int)">
<ul class="blockList">
<li class="blockList">
<h4>getLevelAt</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getLevelAt&#8203;(int&nbsp;offset)</pre>
<div class="block">Return the resolved level of the character at offset.  If offset is
 &lt; 0 or &ge; the length of the line, return the base direction
 level.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - the index of the character for which to return the level</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resolved level of the character at offset</dd>
<a id="getRunCount()">
<ul class="blockList">
<li class="blockList">
<h4>getRunCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRunCount()</pre>
<div class="block">Return the number of level runs.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of level runs</dd>
<a id="getRunLevel(int)">
<ul class="blockList">
<li class="blockList">
<h4>getRunLevel</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRunLevel&#8203;(int&nbsp;run)</pre>
<div class="block">Return the level of the nth logical run in this line.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>run</code> - the index of the run, between 0 and <code>getRunCount()</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the level of the run</dd>
<a id="getRunStart(int)">
<ul class="blockList">
<li class="blockList">
<h4>getRunStart</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRunStart&#8203;(int&nbsp;run)</pre>
<div class="block">Return the index of the character at the start of the nth logical run in this line, as
 an offset from the start of the line.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>run</code> - the index of the run, between 0 and <code>getRunCount()</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the start of the run</dd>
<a id="getRunLimit(int)">
<ul class="blockList">
<li class="blockList">
<h4>getRunLimit</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRunLimit&#8203;(int&nbsp;run)</pre>
<div class="block">Return the index of the character past the end of the nth logical run in this line, as
 an offset from the start of the line.  For example, this will return the length
 of the line for the last run on the line.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>run</code> - the index of the run, between 0 and <code>getRunCount()</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>limit the limit of the run</dd>
<a id="requiresBidi(char[],int,int)">
<ul class="blockList">
<li class="blockList">
<h4>requiresBidi</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;requiresBidi&#8203;(char[]&nbsp;text,
                                   int&nbsp;start,
                                   int&nbsp;limit)</pre>
<div class="block">Return true if the specified text requires bidi analysis.  If this returns false,
 the text will display left-to-right.  Clients can then avoid constructing a Bidi object.
 Text in the Arabic Presentation Forms area of Unicode is presumed to already be shaped
 and ordered for display, and so will not cause this function to return true.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text containing the characters to test</dd>
<dd><code>start</code> - the start of the range of characters to test</dd>
<dd><code>limit</code> - the limit of the range of characters to test</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the range of characters requires bidi analysis</dd>
<a id="reorderVisually(byte[],int,java.lang.Object[],int,int)">
<ul class="blockList">
<li class="blockList">
<h4>reorderVisually</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;reorderVisually&#8203;(byte[]&nbsp;levels,
                                   int&nbsp;levelStart,
                                   <a href="../lang/Object.html" title="class in java.lang">Object</a>[]&nbsp;objects,
                                   int&nbsp;objectStart,
                                   int&nbsp;count)</pre>
<div class="block">Reorder the objects in the array into visual order based on their levels.
 This is a utility function to use when you have a collection of objects
 representing runs of text in logical order, each run containing text
 at a single level.  The elements at <code>index</code> from
 <code>objectStart</code> up to <code>objectStart + count</code>
 in the objects array will be reordered into visual order assuming
 each run of text has the level indicated by the corresponding element
 in the levels array (at <code>index - objectStart + levelStart</code>).</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>levels</code> - an array representing the bidi level of each object</dd>
<dd><code>levelStart</code> - the start position in the levels array</dd>
<dd><code>objects</code> - the array of objects to be reordered into visual order</dd>
<dd><code>objectStart</code> - the start position in the objects array</dd>
<dd><code>count</code> - the number of objects to reorder</dd>
<a id="toString()">
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="../lang/String.html" title="class in java.lang">String</a>&nbsp;toString()</pre>
<div class="block">Display the bidi internal state, used in debugging.</div>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../lang/Object.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../lang/Object.html" title="class in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of the object.</dd>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Bidi.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
<a id="skip.navbar.bottom">
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&amp;id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> &copy; 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Bidi.html

Latest commit

History

Bidi.html

File metadata and controls
