OpenJDK 27 · java.awt.ComponentOrientation · APIdia, the JavaDoc alternative

The ComponentOrientation class encapsulates the language-sensitive orientation that is to be used to order the elements of a component or of text. It is used to reflect the differences in this ordering between Western alphabets, Middle Eastern (such as Hebrew), and Far Eastern (such as Japanese).

Fundamentally, this governs items (such as characters) which are laid out in lines, with the lines then laid out in a block. This also applies to items in a widget: for example, in a check box where the box is positioned relative to the text.

There are four different orientations used in modern languages as in the following table.

LT          RT          TL          TR
A B C       C B A       A D G       G D A
D E F       F E D       B E H       H E B
G H I       I H G       C F I       I F C

(In the header, the two-letter abbreviation represents the item direction in the first letter, and the line direction in the second. For example, LT means "items left-to-right, lines top-to-bottom", TL means "items top-to-bottom, lines left-to-right", and so on.)

The orientations are:

LT - Western Europe (optional for Japanese, Chinese, Korean)
RT - Middle East (Arabic, Hebrew)
TR - Japanese, Chinese, Korean
TL - Mongolian

Components whose view and controller code depends on orientation should use the isLeftToRight() and isHorizontal() methods to determine their behavior. They should not include switch-like code that keys off of the constants, such as:

if (orientation == LEFT_TO_RIGHT) {
  ...
} else if (orientation == RIGHT_TO_LEFT) {
  ...
} else {
  // Oops
}

This is unsafe, since more constants may be added in the future and since it is not guaranteed that orientation objects will be unique.

Field Summary

Modifier and Type	Field and Description
private static final int	HORIZ_BIT
public static final ComponentOrientation	LEFT_TO_RIGHT Items run left to right and lines flow top to bottom Examples: English, French.
private static final int	LTR_BIT
private int	orientation
public static final ComponentOrientation	RIGHT_TO_LEFT Items run right to left and lines flow top to bottom Examples: Arabic, Hebrew.
private static final long	serialVersionUID Use serialVersionUID from JDK 1.6 for interoperability.
private static final int	UNK_BIT
public static final ComponentOrientation	UNKNOWN Indicates that a component's orientation has not been set.

Access	Constructor and Description
private	ComponentOrientation(int value)

Method Summary

Modifier and Type	Method and Description
public static ComponentOrientation	Returns: the orientation for the locale getOrientation(Locale the specified locale locale) Returns the orientation that is appropriate for the given locale.
public static ComponentOrientation	Returns: the orientation getOrientation(ResourceBundle the bundle to use bdl) Deprecated As of J2SE 1.4, use `getOrientation(java.util.Locale)`. Returns the orientation appropriate for the given ResourceBundle's localization.
public boolean	Returns: `true` if this orientation has horizontal lines isHorizontal() Are lines horizontal?
public boolean	Returns: `true` if this orientation is left-to-right isLeftToRight() HorizontalLines: Do items run left-to-right?

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

HORIZ_BIT	back to summary
private static final int HORIZ_BIT

LEFT_TO_RIGHT	back to summary
public static final ComponentOrientation LEFT_TO_RIGHT Items run left to right and lines flow top to bottom Examples: English, French.

LTR_BIT	back to summary
private static final int LTR_BIT

orientation	back to summary
private int orientation

RIGHT_TO_LEFT	back to summary
public static final ComponentOrientation RIGHT_TO_LEFT Items run right to left and lines flow top to bottom Examples: Arabic, Hebrew.

serialVersionUID	back to summary
private static final long serialVersionUID Use serialVersionUID from JDK 1.6 for interoperability. Annotations @Serial

UNK_BIT	back to summary
private static final int UNK_BIT

UNKNOWN	back to summary
public static final ComponentOrientation UNKNOWN Indicates that a component's orientation has not been set. To preserve the behavior of existing applications, isLeftToRight will return true for this value.

Constructor Detail

ComponentOrientation	back to summary
private ComponentOrientation(int value)

Method Detail

getOrientation	back to summary
public static ComponentOrientation getOrientation(Locale locale) Returns the orientation that is appropriate for the given locale. Parameters locale:Locale the specified locale Returns:ComponentOrientation the orientation for the locale

getOrientation

back to summary

public static ComponentOrientation getOrientation(Locale locale)

Returns the orientation that is appropriate for the given locale.

Parameters

locale:Locale: the specified locale

Returns:ComponentOrientation

the orientation for the locale

getOrientation back to summary

getOrientation	back to summary
public static ComponentOrientation getOrientation(ResourceBundle bdl) Deprecated As of J2SE 1.4, use `getOrientation(java.util.Locale)`. Returns the orientation appropriate for the given ResourceBundle's localization. Three approaches are tried, in the following order: Retrieve a ComponentOrientation object from the ResourceBundle using the string "Orientation" as the key. Use the ResourceBundle.getLocale to determine the bundle's locale, then return the orientation for that locale. Return the default locale's orientation. Parameters bdl:ResourceBundle the bundle to use Returns:ComponentOrientation the orientation Annotations @Deprecated

public static ComponentOrientation getOrientation(ResourceBundle bdl)

Deprecated

As of J2SE 1.4, use getOrientation(java.util.Locale).

Returns the orientation appropriate for the given ResourceBundle's localization. Three approaches are tried, in the following order:

Retrieve a ComponentOrientation object from the ResourceBundle using the string "Orientation" as the key.
Use the ResourceBundle.getLocale to determine the bundle's locale, then return the orientation for that locale.
Return the default locale's orientation.

Parameters

bdl:ResourceBundle: the bundle to use

Returns:ComponentOrientation

the orientation

Annotations

@Deprecated

isHorizontal back to summary

isHorizontal	back to summary
public boolean isHorizontal() Are lines horizontal? This will return true for horizontal, left-to-right writing systems such as Roman. Returns:boolean `true` if this orientation has horizontal lines

public boolean isHorizontal()

Are lines horizontal? This will return true for horizontal, left-to-right writing systems such as Roman.

Returns:boolean: true if this orientation has horizontal lines

isLeftToRight back to summary

isLeftToRight	back to summary
public boolean isLeftToRight() HorizontalLines: Do items run left-to-right? Vertical Lines: Do lines run left-to-right? This will return true for horizontal, left-to-right writing systems such as Roman. Returns:boolean `true` if this orientation is left-to-right

public boolean isLeftToRight()

HorizontalLines: Do items run left-to-right?
Vertical Lines: Do lines run left-to-right?
This will return true for horizontal, left-to-right writing systems such as Roman.

Returns:boolean: true if this orientation is left-to-right

public final Class ComponentOrientation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail