org.eclipse.swt.internal

Class BidiUtil

java.lang.Object

org.eclipse.swt.internal.BidiUtil

public class BidiUtil
extends java.lang.Object

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static Callback	callback
(package private) static java.lang.String	CD_PG_ARABIC
(package private) static java.lang.String	CD_PG_HEBREW
static int	CLASS_ARABIC
static int	CLASS_HEBREW
static int	CLASS_LATINNUMBER
static int	CLASS_LOCALNUMBER
(package private) static java.lang.String	CLASS_NAME
static int	CLASSIN
(package private) static int	ETO_CLIPPED
(package private) static int	ETO_GLYPH_INDEX
(package private) static int	GCP_CLASSIN
(package private) static int	GCP_GLYPHSHAPE
(package private) static int	GCP_LIGATE
(package private) static int	GCP_REORDER
(package private) static byte	GCPCLASS_ARABIC
(package private) static byte	GCPCLASS_HEBREW
(package private) static byte	GCPCLASS_LATINNUMBER
(package private) static byte	GCPCLASS_LOCALNUMBER
(package private) static int	GCPGLYPH_LINKAFTER
(package private) static int	GCPGLYPH_LINKBEFORE
static int	GLYPHSHAPE
(package private) static int	HKL_NEXT
(package private) static int	HKL_PREV
(package private) static int	isBidiPlatform
static int	KEYBOARD_BIDI
static int	KEYBOARD_NON_BIDI
(package private) static java.util.Hashtable	keyMap
(package private) static int	LANG_ARABIC
(package private) static int	LANG_FARSI
(package private) static int	LANG_HEBREW
(package private) static java.util.Hashtable	languageMap
static int	LIGATE
static int	LINKAFTER
static int	LINKBEFORE
(package private) static java.util.Hashtable	oldProcMap
static int	REORDER

Constructor Summary

Constructors

Constructor and Description
BidiUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addLanguageListener(Control control, java.lang.Runnable runnable)
static void	addLanguageListener(int hwnd, java.lang.Runnable runnable) Adds a language listener.
static void	drawGlyphs(GC gc, char[] renderBuffer, int[] renderDx, int x, int y) Wraps the ExtTextOut function.
(package private) static int	EnumSystemLanguageGroupsProc(int lpLangGrpId, int lpLangGrpIdString, int lpLangGrpName, int options, int lParam) Proc used for OS.EnumSystemLanguageGroups call during isBidiPlatform test.
static int	getFontBidiAttributes(GC gc) Return bidi attribute information for the font in the specified gc.
static int	getKeyboardLanguage() Return the active keyboard language type.
(package private) static int[]	getKeyboardLanguageList() Return the languages that are installed for the keyboard.
static void	getOrderInfo(GC gc, java.lang.String text, int[] order, byte[] classBuffer, int flags, int[] offsets) Return bidi ordering information for the given text.
static char[]	getRenderInfo(GC gc, java.lang.String text, int[] order, byte[] classBuffer, int[] dx, int flags, int[] offsets) Return ordering and rendering information for the given text.
(package private) static boolean	isBidiLang(int lang)
static boolean	isBidiPlatform() Return whether or not the platform supports a bidi language.
static boolean	isKeyboardBidi() Return whether or not the keyboard supports input of a bidi language.
static void	removeLanguageListener(Control control)
static void	removeLanguageListener(int hwnd) Removes the specified language listener.
(package private) static void	reverse(char[] charArray) Reverse the character array.
(package private) static void	reverse(int[] intArray) Reverse the integer array.
static void	setKeyboardLanguage(int language) Switch the keyboard language to the specified language type.
static boolean	setOrientation(Control control, int orientation)
static boolean	setOrientation(int hwnd, int orientation) Sets the orientation (writing order) of the specified control.
(package private) static void	subclass(int hwnd) Override the window proc.
(package private) static void	translateOrder(int[] orderArray, int glyphCount, boolean isRightOriented) Adjust the order array so that it is relative to the start of the line.
(package private) static void	unsubclass(int hwnd) Remove the overridden the window proc.
(package private) static int	windowProc(int hwnd, int msg, int wParam, int lParam) Window proc to intercept keyboard language switch event (WS_INPUTLANGCHANGE) and widget orientation changes.

Methods inherited from class java.lang.Object

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

Field Detail

KEYBOARD_NON_BIDI

public static final int KEYBOARD_NON_BIDI

See Also:

Constant Field Values

KEYBOARD_BIDI

public static final int KEYBOARD_BIDI

See Also:

Constant Field Values

isBidiPlatform

static int isBidiPlatform

CLASSIN

public static final int CLASSIN

See Also:

Constant Field Values

LINKBEFORE

public static final int LINKBEFORE

See Also:

Constant Field Values

LINKAFTER

public static final int LINKAFTER

See Also:

Constant Field Values

languageMap

static java.util.Hashtable languageMap

keyMap

static java.util.Hashtable keyMap

oldProcMap

static java.util.Hashtable oldProcMap

CLASS_NAME

static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

callback

static Callback callback

GCP_REORDER

static final int GCP_REORDER

See Also:

Constant Field Values

GCP_GLYPHSHAPE

static final int GCP_GLYPHSHAPE

See Also:

Constant Field Values

GCP_LIGATE

static final int GCP_LIGATE

See Also:

Constant Field Values

GCP_CLASSIN

static final int GCP_CLASSIN

See Also:

Constant Field Values

GCPCLASS_ARABIC

static final byte GCPCLASS_ARABIC

See Also:

Constant Field Values

GCPCLASS_HEBREW

static final byte GCPCLASS_HEBREW

See Also:

Constant Field Values

GCPCLASS_LOCALNUMBER

static final byte GCPCLASS_LOCALNUMBER

See Also:

Constant Field Values

GCPCLASS_LATINNUMBER

static final byte GCPCLASS_LATINNUMBER

See Also:

Constant Field Values

GCPGLYPH_LINKBEFORE

static final int GCPGLYPH_LINKBEFORE

See Also:

Constant Field Values

GCPGLYPH_LINKAFTER

static final int GCPGLYPH_LINKAFTER

See Also:

Constant Field Values

ETO_CLIPPED

static final int ETO_CLIPPED

See Also:

Constant Field Values

ETO_GLYPH_INDEX

static final int ETO_GLYPH_INDEX

See Also:

Constant Field Values

LANG_ARABIC

static final int LANG_ARABIC

See Also:

Constant Field Values

LANG_HEBREW

static final int LANG_HEBREW

See Also:

Constant Field Values

LANG_FARSI

static final int LANG_FARSI

See Also:

Constant Field Values

CD_PG_HEBREW

static final java.lang.String CD_PG_HEBREW

See Also:

Constant Field Values

CD_PG_ARABIC

static final java.lang.String CD_PG_ARABIC

See Also:

Constant Field Values

HKL_NEXT

static final int HKL_NEXT

See Also:

Constant Field Values

HKL_PREV

static final int HKL_PREV

See Also:

Constant Field Values

CLASS_HEBREW

public static final int CLASS_HEBREW

See Also:

Constant Field Values

CLASS_ARABIC

public static final int CLASS_ARABIC

See Also:

Constant Field Values

CLASS_LOCALNUMBER

public static final int CLASS_LOCALNUMBER

See Also:

Constant Field Values

CLASS_LATINNUMBER

public static final int CLASS_LATINNUMBER

See Also:

Constant Field Values

REORDER

public static final int REORDER

See Also:

Constant Field Values

LIGATE

public static final int LIGATE

See Also:

Constant Field Values

GLYPHSHAPE

public static final int GLYPHSHAPE

See Also:

Constant Field Values

Constructor Detail

BidiUtil

public BidiUtil()

Method Detail

addLanguageListener

public static void addLanguageListener(int hwnd,
                       java.lang.Runnable runnable)

Adds a language listener. The listener will get notified when the language of the keyboard changes (via Alt-Shift on Win platforms). Do this by creating a window proc for the Control so that the window messages for the Control can be monitored.

Parameters:

hwnd - the handle of the Control that is listening for keyboard language changes

runnable - the code that should be executed when a keyboard language change occurs

addLanguageListener

public static void addLanguageListener(Control control,
                       java.lang.Runnable runnable)

EnumSystemLanguageGroupsProc

static int EnumSystemLanguageGroupsProc(int lpLangGrpId,
                               int lpLangGrpIdString,
                               int lpLangGrpName,
                               int options,
                               int lParam)

Proc used for OS.EnumSystemLanguageGroups call during isBidiPlatform test.

drawGlyphs

public static void drawGlyphs(GC gc,
              char[] renderBuffer,
              int[] renderDx,
              int x,
              int y)

Wraps the ExtTextOut function.

Parameters:

gc - the gc to use for rendering

renderBuffer - the glyphs to render as an array of characters

renderDx - the width of each glyph in renderBuffer

x - x position to start rendering

y - y position to start rendering

getRenderInfo

public static char[] getRenderInfo(GC gc,
                   java.lang.String text,
                   int[] order,
                   byte[] classBuffer,
                   int[] dx,
                   int flags,
                   int[] offsets)

Return ordering and rendering information for the given text. Wraps the GetFontLanguageInfo and GetCharacterPlacement functions.

Parameters:

gc - the GC to use for measuring of this line, input parameter

text - text that bidi data should be calculated for, input parameter

order - an array of integers representing the visual position of each character in the text array, output parameter

classBuffer - an array of integers representing the type (e.g., ARABIC, HEBREW, LOCALNUMBER) of each character in the text array, input/output parameter

dx - an array of integers representing the pixel width of each glyph in the returned glyph buffer, output parameter

flags - an integer representing rendering flag information, input parameter

offsets - text segments that should be measured and reordered separately, input parameter. See org.eclipse.swt.custom.BidiSegmentEvent for details.

Returns:

buffer with the glyphs that should be rendered for the given text

getOrderInfo

public static void getOrderInfo(GC gc,
                java.lang.String text,
                int[] order,
                byte[] classBuffer,
                int flags,
                int[] offsets)

Return bidi ordering information for the given text. Does not return rendering information (e.g., glyphs, glyph distances). Use this method when you only need ordering information. Doing so will improve performance. Wraps the GetFontLanguageInfo and GetCharacterPlacement functions.

Parameters:

gc - the GC to use for measuring of this line, input parameter

text - text that bidi data should be calculated for, input parameter

order - an array of integers representing the visual position of each character in the text array, output parameter

classBuffer - an array of integers representing the type (e.g., ARABIC, HEBREW, LOCALNUMBER) of each character in the text array, input/output parameter

flags - an integer representing rendering flag information, input parameter

offsets - text segments that should be measured and reordered separately, input parameter. See org.eclipse.swt.custom.BidiSegmentEvent for details.

getFontBidiAttributes

public static int getFontBidiAttributes(GC gc)

Return bidi attribute information for the font in the specified gc.

Parameters:

gc - the gc to query

Returns:

bitwise OR of the REORDER, LIGATE and GLYPHSHAPE flags defined by this class.

getKeyboardLanguage

public static int getKeyboardLanguage()

Return the active keyboard language type.

Returns:

an integer representing the active keyboard language (KEYBOARD_BIDI, KEYBOARD_NON_BIDI)

getKeyboardLanguageList

static int[] getKeyboardLanguageList()

Return the languages that are installed for the keyboard.

Returns:

integer array with an entry for each installed language

isBidiLang

static boolean isBidiLang(int lang)

isBidiPlatform

public static boolean isBidiPlatform()

Return whether or not the platform supports a bidi language. Determine this by looking at the languages that are installed.

Returns:

true if bidi is supported, false otherwise. Always false on Windows CE.

isKeyboardBidi

public static boolean isKeyboardBidi()

Return whether or not the keyboard supports input of a bidi language. Determine this by looking at the languages that are installed for the keyboard.

Returns:

true if bidi is supported, false otherwise.

removeLanguageListener

public static void removeLanguageListener(int hwnd)

Removes the specified language listener.

Parameters:

hwnd - the handle of the Control that is listening for keyboard language changes

removeLanguageListener

public static void removeLanguageListener(Control control)

setKeyboardLanguage

public static void setKeyboardLanguage(int language)

Switch the keyboard language to the specified language type. We do not distinguish between multiple bidi or multiple non-bidi languages, so set the keyboard to the first language of the given type.

Parameters:

language - integer representing language. One of KEYBOARD_BIDI, KEYBOARD_NON_BIDI.

setOrientation

public static boolean setOrientation(int hwnd,
                     int orientation)

Sets the orientation (writing order) of the specified control. Text will be right aligned for right to left writing order.

Parameters:

hwnd - the handle of the Control to change the orientation of

orientation - one of SWT.RIGHT_TO_LEFT or SWT.LEFT_TO_RIGHT

Returns:

true if the orientation was changed, false if the orientation could not be changed

setOrientation

public static boolean setOrientation(Control control,
                     int orientation)

subclass

static void subclass(int hwnd)

Override the window proc.

Parameters:

hwnd - control to override the window proc of

reverse

static void reverse(char[] charArray)

Reverse the character array. Used for right orientation.

Parameters:

charArray - character array to reverse

reverse

static void reverse(int[] intArray)

Reverse the integer array. Used for right orientation.

Parameters:

intArray - integer array to reverse

translateOrder

static void translateOrder(int[] orderArray,
                  int glyphCount,
                  boolean isRightOriented)

Adjust the order array so that it is relative to the start of the line. Also reverse the order array if the orientation is to the right.

Parameters:

orderArray - integer array of order values to translate

glyphCount - number of glyphs that have been processed for the current line

isRightOriented - flag indicating whether or not current orientation is to the right

unsubclass

static void unsubclass(int hwnd)

Remove the overridden the window proc.

Parameters:

hwnd - control to remove the window proc override for

windowProc

static int windowProc(int hwnd,
             int msg,
             int wParam,
             int lParam)

Window proc to intercept keyboard language switch event (WS_INPUTLANGCHANGE) and widget orientation changes. Run the Control's registered runnable when the keyboard language is switched.

Parameters:

hwnd - handle of the control that is listening for the keyboard language change event

msg - window message