Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt.im

Class InputMethodHighlight

public class InputMethodHighlight
extends Object
This describes the highlight attributes of text composed in an input method. The description includes an abstract level (whether text has been converted yet, and whether it is selected), and a concrete level (which style attributes are used in rendering). If no concrete level is defined, the renderer should use Toolkit.mapInputMethodHighlight(InputMethodHighlight). An example of conversion state is kana -> kanji.

Instances of this class are typically used in AttributedCharacterIterators, and may be wrapped in Annotations to separate text segments.

Since:
1.2
See Also:
AttributedCharacterIterator, Annotation

Field Summary

static int
CONVERTED_TEXT
Converted text state (after conversion).
static int
RAW_TEXT
Raw text state (before conversion).
static InputMethodHighlight
SELECTED_CONVERTED_TEXT_HIGHLIGHT
Default do-nothing highlighting for selected converted text.
static InputMethodHighlight
SELECTED_RAW_TEXT_HIGHLIGHT
Default do-nothing highlighting for selected raw text.
static InputMethodHighlight
UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
Default do-nothing highlighting for unselected converted text.
static InputMethodHighlight
UNSELECTED_RAW_TEXT_HIGHLIGHT
Default do-nothing highlighting for unselected raw text.

Constructor Summary

InputMethodHighlight(boolean selected, int state)
Create an input method highlight style, with variation 0 and null style mapping.
InputMethodHighlight(boolean selected, int state, int variation)
Create an input method highlight style, with null style mapping.
InputMethodHighlight(boolean selected, int state, int variation, Map style)
Create an input method highlight style.

Method Summary

Map
?> getStyle()
Return the rendering style attributes map, or null if it should be the default mapping.
int
getState()
Return the conversion state of the highlighted text.
int
getVariation()
Return the highlighting style variation.
boolean
isSelected()
Return whether the highlighting applies to selected text.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONVERTED_TEXT

public static final int CONVERTED_TEXT
Converted text state (after conversion).
Field Value:
1

RAW_TEXT

public static final int RAW_TEXT
Raw text state (before conversion).
Field Value:
0

SELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
Default do-nothing highlighting for selected converted text.

SELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
Default do-nothing highlighting for selected raw text.

UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
Default do-nothing highlighting for unselected converted text.

UNSELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
Default do-nothing highlighting for unselected raw text.

Constructor Details

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state)
Create an input method highlight style, with variation 0 and null style mapping.
Parameters:
selected - whether the text range is selected
state - either RAW_TEXT or CONVERTED_TEXT
Throws:
IllegalArgumentException - if state is invalid

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation)
Create an input method highlight style, with null style mapping.
Parameters:
selected - whether the text range is selected
state - either RAW_TEXT or CONVERTED_TEXT
variation - the style variation
Throws:
IllegalArgumentException - if state is invalid

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation,
                            Map style)
Create an input method highlight style.
Parameters:
selected - whether the text range is selected
state - either RAW_TEXT or CONVERTED_TEXT
variation - the style variation
style - an unmodifiable map of rendering styles, or null
Throws:
IllegalArgumentException - if state is invalid
Since:
1.3

Method Details

?> getStyle

public Map?> getStyle()
Return the rendering style attributes map, or null if it should be the default mapping.
Returns:
the style map
Since:
1.3

getState

public int getState()
Return the conversion state of the highlighted text.
Returns:
one of RAW_TEXT or CONVERTED_TEXT

getVariation

public int getVariation()
Return the highlighting style variation.
Returns:
the variation

isSelected

public boolean isSelected()
Return whether the highlighting applies to selected text.
Returns:
the selection status
InputMethodHighlight.java -- highlights the current text selection Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About