java.awt

Class ComponentOrientation

  • java.lang.Object
    • java.awt.ComponentOrientation
  • All Implemented Interfaces:
    java.io.Serializable
    public final class ComponentOrientation extends java.lang.Object implements java.io.Serializable
    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.
    See Also:
    Serialized Form
    • Fields 
      Modifier and Type Field and Description
      Ordinary member indicator LEFT_TO_RIGHT Reveal DetailHide Detail
      Items run left to right and lines flow top to bottom Examples: English, French.
      Ordinary member indicator RIGHT_TO_LEFT Reveal DetailHide Detail
      Items run right to left and lines flow top to bottom Examples: Arabic, Hebrew.
      Ordinary member indicator UNKNOWN Reveal DetailHide Detail
      Indicates that a component's orientation has not been set.
    • Static Methods 
      Modifier and Type Static Method and Description
      Ordinary member indicator getOrientation Reveal DetailHide Detail
      Returns the orientation that is appropriate for the given locale.
      Ordinary member indicator getOrientation Reveal DetailHide Detail
      Deprecated. As of J2SE 1.4, use getOrientation(java.util.Locale).
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator isHorizontal Reveal DetailHide Detail
      Are lines horizontal? This will return true for horizontal, left-to-right writing systems such as Roman.
      Ordinary member indicator isLeftToRight Reveal DetailHide Detail
      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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
This document was created by Dulcet from the OpenJDK sources. Copyright © 1993, 2012 Oracle and/or its affiliates. All rights reserved.

SourceForge