Initial revision
From-SVN: r102074
This commit is contained in:
Tom Tromey
@@ -0,0 +1,434 @@
|
||||
/* InputContext.java -- provides the context for text input
|
||||
Copyright (C) 2002, 2003, 2004, 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. */
|
||||
|
||||
|
||||
package java.awt.im;
|
||||
|
||||
import gnu.java.util.EmptyEnumeration;
|
||||
|
||||
import java.awt.AWTEvent;
|
||||
import java.awt.AWTException;
|
||||
import java.awt.Component;
|
||||
import java.awt.im.spi.InputMethod;
|
||||
import java.awt.im.spi.InputMethodDescriptor;
|
||||
import java.io.BufferedReader;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.net.URL;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Enumeration;
|
||||
import java.util.HashMap;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* Provides a context for controlling input methods and keyboard layouts.
|
||||
* This class provides the communication layer between the client component,
|
||||
* and the various locale-dependent text entry input methods that can be used
|
||||
* for the client. By default, there is one instance per Window, shared among
|
||||
* all components, but this limits text entry to one component at a time.
|
||||
* Thus, text components can create their own instance to allow text entry
|
||||
* in multiple components at a time.
|
||||
*
|
||||
* <p>By using the interfaces of {@link java.awt.im.spi}, you can install
|
||||
* extensions which allow additional input methods. Some of these may use
|
||||
* platform native input methods, or keyboard layouts provided by the platform.
|
||||
* Input methods are unavailable if none have been installed and the platform
|
||||
* has no underlying native input methods. Extensions are installed as jar
|
||||
* files, usually accessed in the default extension location or specified by
|
||||
* the -extdir VM flag. The jar must contain a file named
|
||||
* "META_INF/services/java.awt.im.spi.InputMethodDescriptor" which lists,
|
||||
* one entry per line in UTF-8 encoding, each class in the jar that implements
|
||||
* java.awt.im.spi.InputMethodDescriptor.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @see Component#getInputContext()
|
||||
* @see Component#enableInputMethods(boolean)
|
||||
* @since 1.2
|
||||
* @status updated to 1.4, but unverified
|
||||
*/
|
||||
public class InputContext
|
||||
{
|
||||
/**
|
||||
* The list of installed input method descriptors.
|
||||
*/
|
||||
private static final ArrayList descriptors = new ArrayList();
|
||||
static
|
||||
{
|
||||
Enumeration e;
|
||||
try
|
||||
{
|
||||
e = ClassLoader.getSystemResources
|
||||
("META_INF/services/java.awt.im.spi.InputMethodDescriptor");
|
||||
}
|
||||
catch (IOException ex)
|
||||
{
|
||||
// XXX Should we do something else?
|
||||
e = EmptyEnumeration.getInstance();
|
||||
}
|
||||
while (e.hasMoreElements())
|
||||
{
|
||||
URL url = (URL) e.nextElement();
|
||||
BufferedReader in;
|
||||
String line;
|
||||
try
|
||||
{
|
||||
in = new BufferedReader
|
||||
(new InputStreamReader(url.openConnection().getInputStream(),
|
||||
"UTF-8"));
|
||||
line = in.readLine().trim();
|
||||
}
|
||||
catch (IOException ignored)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
outer:
|
||||
while (line != null)
|
||||
{
|
||||
try
|
||||
{
|
||||
if (line.charAt(0) != '#')
|
||||
{
|
||||
Class c = Class.forName(line);
|
||||
descriptors.add((InputMethodDescriptor) c.newInstance());
|
||||
}
|
||||
line = in.readLine().trim();
|
||||
}
|
||||
catch (IOException ex)
|
||||
{
|
||||
continue outer;
|
||||
}
|
||||
catch (Exception ignored)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** The current input method; null if no input methods are installed. */
|
||||
private InputMethod im;
|
||||
|
||||
/** Map of locales to the most recently selected input method. */
|
||||
private final HashMap recent = new HashMap();
|
||||
|
||||
/** The list of acceptable character subsets. */
|
||||
private Character.Subset[] subsets;
|
||||
|
||||
/**
|
||||
* Construct an InputContext. This is protected, so clients must use
|
||||
* {@link #getInstance()} instead.
|
||||
*/
|
||||
protected InputContext()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new InputContext.
|
||||
*
|
||||
* @return a new instance, initialized to the default locale if available
|
||||
*/
|
||||
public static InputContext getInstance()
|
||||
{
|
||||
InputContext ic = new InputContext();
|
||||
ic.selectInputMethod(Locale.getDefault());
|
||||
return ic;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to select an input method or keyboard layout which supports the
|
||||
* given locale. This returns true if a locale is available and was selected.
|
||||
* The following steps are taken in choosing an input method:<ul>
|
||||
* <li>If the currently selected input method or keyboard layout supports
|
||||
* the requested locale, it remains selected.</li>
|
||||
* <li>If there is no input method or keyboard layout available that
|
||||
* supports the requested locale, the current input method or keyboard
|
||||
* layout remains selected.</li>
|
||||
* <li>If the user has previously selected an input method or keyboard
|
||||
* layout for the requested locale from the user interface, then the most
|
||||
* recently selected such input method or keyboard layout is reselected.</li>
|
||||
* <li>Otherwise, an input method or keyboard layout that supports the
|
||||
* requested locale is selected in an implementation dependent way. This
|
||||
* implementation chooses the first input method which supports the requested
|
||||
* locale based on the InputMethodDescriptors loaded from the extensions
|
||||
* installed on the CLASSPATH.</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p>Before switching away from an input method, any currently uncommitted
|
||||
* text is committed. Not all host operating systems provide API to
|
||||
* determine the locale of the currently selected native input method or
|
||||
* keyboard layout, and to select a native input method or keyboard layout
|
||||
* by locale. For host operating systems that don't provide such API,
|
||||
* selectInputMethod assumes that native input methods or keyboard layouts
|
||||
* provided by the host operating system support only the system's default
|
||||
* locale.
|
||||
*
|
||||
* <p>An example of where this may be called is in a multi-language document,
|
||||
* when moving the insertion point between sections of different locale, so
|
||||
* that the user may use the input method appropriate to that section of the
|
||||
* document.
|
||||
*
|
||||
* @param locale the desired new locale
|
||||
* @return true if the new locale is active
|
||||
* @throws NullPointerException if locale is null
|
||||
*/
|
||||
public boolean selectInputMethod(Locale locale)
|
||||
{
|
||||
if (im != null && im.setLocale(locale))
|
||||
{
|
||||
recent.put(locale, im);
|
||||
return true;
|
||||
}
|
||||
InputMethod next = (InputMethod) recent.get(locale);
|
||||
outer:
|
||||
if (next != null)
|
||||
for (int i = 0, limit = descriptors.size(); i < limit; i++)
|
||||
{
|
||||
InputMethodDescriptor d = (InputMethodDescriptor) descriptors.get(i);
|
||||
Locale[] list;
|
||||
try
|
||||
{
|
||||
list = d.getAvailableLocales();
|
||||
}
|
||||
catch (AWTException ignored)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
for (int j = list.length; --j >= 0; )
|
||||
if (locale.equals(list[j]))
|
||||
{
|
||||
try
|
||||
{
|
||||
next = d.createInputMethod();
|
||||
recent.put(locale, next);
|
||||
}
|
||||
catch (Exception ignored)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (next == null)
|
||||
return false;
|
||||
// XXX I'm not sure if this does all the necessary steps in the switch.
|
||||
if (im != null)
|
||||
{
|
||||
try
|
||||
{
|
||||
next.setCompositionEnabled(im.isCompositionEnabled());
|
||||
}
|
||||
catch (UnsupportedOperationException ignored)
|
||||
{
|
||||
}
|
||||
im.endComposition();
|
||||
im.deactivate(false);
|
||||
im.hideWindows();
|
||||
}
|
||||
im = next;
|
||||
im.setLocale(locale);
|
||||
im.setCharacterSubsets(subsets);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current locale of the current input method or keyboard
|
||||
* layout. Returns null if the input context does not have a current input
|
||||
* method or keyboard layout or if the current input method's
|
||||
* {@link InputMethod#getLocale()} method returns null. Not all host
|
||||
* operating systems provide API to determine the locale of the currently
|
||||
* selected native input method or keyboard layout. For host operating
|
||||
* systems that don't provide such API, getLocale assumes that the current
|
||||
* locale of all native input methods or keyboard layouts provided by the
|
||||
* host operating system is the system's default locale.
|
||||
*
|
||||
* @return the locale of the current input method, or null
|
||||
* @since 1.3
|
||||
*/
|
||||
public Locale getLocale()
|
||||
{
|
||||
return im == null ? null : im.getLocale();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the subsets of Unicode characters allowed to be input by the current
|
||||
* input method, as well as subsequent input methods. The value of null
|
||||
* implies all characters are legal. Applications should not rely on this
|
||||
* behavior, since native host input methods may not allow restrictions.
|
||||
* If no current input method is available, this has no immediate effect.
|
||||
*
|
||||
* @param subsets the set of Unicode subsets to accept, or null
|
||||
*/
|
||||
public void setCharacterSubsets(Character.Subset[] subsets)
|
||||
{
|
||||
this.subsets = subsets;
|
||||
if (im != null)
|
||||
im.setCharacterSubsets(subsets);
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the enabled status of the current input method. An input method
|
||||
* that is enabled for composition interprets incoming events for both
|
||||
* composition and control purposes, while a disabled input method only
|
||||
* interprets control commands (including commands to enable itself).
|
||||
*
|
||||
* @param enable whether to enable the input method
|
||||
* @throws UnsupportedOperationException if there is no current input method,
|
||||
* or the input method does not support enabling
|
||||
* @see #isCompositionEnabled()
|
||||
* @since 1.3
|
||||
*/
|
||||
public void setCompositionEnabled(boolean enable)
|
||||
{
|
||||
if (im == null)
|
||||
throw new UnsupportedOperationException();
|
||||
im.setCompositionEnabled(enable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Find out if the current input method is enabled.
|
||||
*
|
||||
* @return true if the current input method is enabled
|
||||
* @throws UnsupportedOperationException if there is no current input method,
|
||||
* or the input method does not support enabling
|
||||
* @see #setCompositionEnabled(boolean)
|
||||
* @since 1.3
|
||||
*/
|
||||
public boolean isCompositionEnabled()
|
||||
{
|
||||
if (im == null)
|
||||
throw new UnsupportedOperationException();
|
||||
return im.isCompositionEnabled();
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts a reconversion operation in the current input method. The input
|
||||
* method gets theh text to reconvert from the client component, using
|
||||
* {@link InputMethodRequests#getSelectedText(Attribute[])}. Then the
|
||||
* composed and committed text produced by the operation is sent back to
|
||||
* the client using a sequence of InputMethodRequests.
|
||||
*
|
||||
* @throws UnsupportedOperationException if there is no current input method,
|
||||
* or the input method does not support reconversion
|
||||
* @since 1.3
|
||||
*/
|
||||
public void reconvert()
|
||||
{
|
||||
if (im == null)
|
||||
throw new UnsupportedOperationException();
|
||||
im.reconvert();
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatches an event to the current input method. This is called
|
||||
* automatically by AWT. If no input method is available, then the event
|
||||
* will never be consumed.
|
||||
*
|
||||
* @param event the event to dispatch
|
||||
* @throws NullPointerException if event is null
|
||||
*/
|
||||
public void dispatchEvent(AWTEvent event)
|
||||
{
|
||||
if (im != null)
|
||||
im.dispatchEvent(event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Notifies the input context that a client component has been removed from
|
||||
* its containment hierarchy, or that input method support has been disabled
|
||||
* for the component. This method is usually called from the client
|
||||
* component's {@link Component#removeNotify()} method. Potentially pending
|
||||
* input from input methods for this component is discarded. If no input
|
||||
* methods are available, then this method has no effect.
|
||||
*
|
||||
* @param client the client component
|
||||
* @throws NullPointerException if client is null
|
||||
*/
|
||||
public void removeNotify(Component client)
|
||||
{
|
||||
// XXX What to do with client information?
|
||||
if (im != null)
|
||||
{
|
||||
im.deactivate(false);
|
||||
im.removeNotify();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Ends any input composition that may currently be going on in this
|
||||
* context. Depending on the platform and possibly user preferences, this
|
||||
* may commit or delete uncommitted text. Any changes to the text are
|
||||
* communicated to the active component using an input method event. If no
|
||||
* input methods are available, then this method has no effect. This may
|
||||
* be called for a variety of reasons, such as when the user moves the
|
||||
* insertion point in the client text outside the range of the composed text,
|
||||
* or when text is saved to file.
|
||||
*/
|
||||
public void endComposition()
|
||||
{
|
||||
if (im != null)
|
||||
im.endComposition();
|
||||
}
|
||||
|
||||
/**
|
||||
* Disposes of the input context and release the resources used by it.
|
||||
* Called automatically by AWT for the default input context of each
|
||||
* Window. If no input methods are available, then this method has no
|
||||
* effect.
|
||||
*/
|
||||
public void dispose()
|
||||
{
|
||||
if (im != null)
|
||||
{
|
||||
im.deactivate(false);
|
||||
im.dispose();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a control object from the current input method, or null. A
|
||||
* control object provides implementation-dependent methods that control
|
||||
* the behavior of the input method or obtain information from the input
|
||||
* method. Clients have to compare the result against known input method
|
||||
* control object types. If no input methods are available or the current
|
||||
* input method does not provide an input method control object, then null
|
||||
* is returned.
|
||||
*
|
||||
* @return the control object, or null
|
||||
*/
|
||||
public Object getInputMethodControlObject()
|
||||
{
|
||||
return im == null ? null : im.getControlObject();
|
||||
}
|
||||
} // class InputContext
|
||||
@@ -0,0 +1,185 @@
|
||||
/* 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. */
|
||||
|
||||
package java.awt.im;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* 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
|
||||
* {@link Toolkit#mapInputMethodHighlight(InputMethodHighlight)}. An example
|
||||
* of conversion state is kana -> kanji.
|
||||
*
|
||||
* <p>Instances of this class are typically used in
|
||||
* AttributedCharacterIterators, and may be wrapped in Annotations to separate
|
||||
* text segments.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @see AttributedCharacterIterators
|
||||
* @see Annotation
|
||||
* @since 1.2
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public class InputMethodHighlight
|
||||
{
|
||||
/** Raw text state (before conversion). */
|
||||
public static final int RAW_TEXT = 0;
|
||||
|
||||
/** Converted text state (after conversion). */
|
||||
public static final int CONVERTED_TEXT = 1;
|
||||
|
||||
/** Default do-nothing highlighting for unselected raw text. */
|
||||
public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
|
||||
= new InputMethodHighlight(false, RAW_TEXT);
|
||||
|
||||
/** Default do-nothing highlighting for selected raw text. */
|
||||
public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
|
||||
= new InputMethodHighlight(true, RAW_TEXT);
|
||||
|
||||
/** Default do-nothing highlighting for unselected converted text. */
|
||||
public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
|
||||
= new InputMethodHighlight(false, CONVERTED_TEXT);
|
||||
|
||||
/** Default do-nothing highlighting for selected converted text. */
|
||||
public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
|
||||
= new InputMethodHighlight(true, CONVERTED_TEXT);
|
||||
|
||||
/** Whether the highlighting applies to selected text. */
|
||||
private final boolean selected;
|
||||
|
||||
/** The state of highlighted text. */
|
||||
private final int state;
|
||||
|
||||
/** Any variation on the highlighting style. */
|
||||
private final int variation;
|
||||
|
||||
/** The unmodifiable map of rendering styles. */
|
||||
private final Map style;
|
||||
|
||||
/**
|
||||
* Create an input method highlight style, with variation 0 and null style
|
||||
* mapping.
|
||||
*
|
||||
* @param selected whether the text range is selected
|
||||
* @param state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT}
|
||||
* @throws IllegalArgumentException if state is invalid
|
||||
*/
|
||||
public InputMethodHighlight(boolean selected, int state)
|
||||
{
|
||||
this(selected, state, 0, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an input method highlight style, with null style mapping.
|
||||
*
|
||||
* @param selected whether the text range is selected
|
||||
* @param state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT}
|
||||
* @param variation the style variation
|
||||
* @throws IllegalArgumentException if state is invalid
|
||||
*/
|
||||
public InputMethodHighlight(boolean selected, int state, int variation)
|
||||
{
|
||||
this(selected, state, variation, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an input method highlight style.
|
||||
*
|
||||
* @param selected whether the text range is selected
|
||||
* @param state either {@link #RAW_TEXT} or {@link #CONVERTED_TEXT}
|
||||
* @param variation the style variation
|
||||
* @param style an unmodifiable map of rendering styles, or null
|
||||
* @throws IllegalArgumentException if state is invalid
|
||||
* @since 1.3
|
||||
*/
|
||||
public InputMethodHighlight(boolean selected, int state, int variation,
|
||||
Map style)
|
||||
{
|
||||
if (state != RAW_TEXT && state != CONVERTED_TEXT)
|
||||
throw new IllegalArgumentException();
|
||||
this.selected = selected;
|
||||
this.state = state;
|
||||
this.variation = variation;
|
||||
this.style = style;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return whether the highlighting applies to selected text.
|
||||
*
|
||||
* @return the selection status
|
||||
*/
|
||||
public boolean isSelected()
|
||||
{
|
||||
return selected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the conversion state of the highlighted text.
|
||||
*
|
||||
* @return one of {@link #RAW_TEXT} or {@link #CONVERTED_TEXT}
|
||||
*/
|
||||
public int getState()
|
||||
{
|
||||
return state;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the highlighting style variation.
|
||||
*
|
||||
* @return the variation
|
||||
*/
|
||||
public int getVariation()
|
||||
{
|
||||
return variation;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the rendering style attributes map, or null if it should be the
|
||||
* default mapping.
|
||||
*
|
||||
* @return the style map
|
||||
* @since 1.3
|
||||
*/
|
||||
public Map getStyle()
|
||||
{
|
||||
return style;
|
||||
}
|
||||
} // class InputMethodHighlight
|
||||
@@ -0,0 +1,153 @@
|
||||
/* InputMethodRequests.java -- handles text insertion via input methods
|
||||
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. */
|
||||
|
||||
package java.awt.im;
|
||||
|
||||
import java.awt.Rectangle;
|
||||
import java.awt.font.TextHitInfo;
|
||||
import java.text.AttributedCharacterIterator;
|
||||
import java.text.AttributedCharacterIterator.Attribute;
|
||||
|
||||
/**
|
||||
* This interface handles requests made by input methods on text editing
|
||||
* components. A component must specify a handler for input methods that
|
||||
* implements this interface, and which supports one of two user interfaces:
|
||||
* <ul><li><em>on-the-spot</em>: composed text is shown in place</li>
|
||||
* <li><em>below-the-spot</em>: composed text is in a separate window,
|
||||
* usually below the main text window, until it is committed into place at
|
||||
* the insertion point, overwriting any selected text</li></ul>
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @see Component#getInputMethodRequests()
|
||||
* @see InputMethodListener
|
||||
* @since 1.2
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public interface InputMethodRequests
|
||||
{
|
||||
/**
|
||||
* Gets the location of a given offset of the text. This can be used to
|
||||
* position a composition window near the location of where the composed
|
||||
* text will be inserted.
|
||||
*
|
||||
* <p>If the component has composed text (from the most recent
|
||||
* InputMethodEvent), then offset 0 indicates the location of the first
|
||||
* character of this composed text. Otherwise, the offset is ignored, and
|
||||
* the location should be the beginning of the final line of selected
|
||||
* text (in horizontal left-to-right text, like English, this would be the
|
||||
* lower left corner of the selction; in vertical top-to-bottom text, like
|
||||
* Chinese, this would be the top right corner of the selection).
|
||||
*
|
||||
* <p>The location returned is a 0-thickness caret (either horizontal or
|
||||
* vertical, depending on text flow), mapped to absolute screen coordinates.
|
||||
*
|
||||
* @param offset offset within composed text, or null
|
||||
* @return the screen location of the caret at the offset
|
||||
*/
|
||||
Rectangle getTextLocation(TextHitInfo offset);
|
||||
|
||||
/**
|
||||
* Get the text offset for the given screen coordinate. The offset is
|
||||
* relative to the composed text, and the return is null if it is outside
|
||||
* the range of composed text. For example, this can be used to find
|
||||
* where a mouse click should pop up a text composition window.
|
||||
*
|
||||
* @param x the x screen coordinate
|
||||
* @param y the y screen coordinate
|
||||
* @return a text hit info describing the composed text offset
|
||||
*/
|
||||
TextHitInfo getLocationOffset(int x, int y);
|
||||
|
||||
/**
|
||||
* Gets the offset where the committed text exists in the text editing
|
||||
* component. This can be used to examine the text surrounding the insert
|
||||
* position.
|
||||
*
|
||||
* @return the offset of the insert position
|
||||
*/
|
||||
int getInsertPositionOffset();
|
||||
|
||||
/**
|
||||
* Gets an interator which provides access to the text and its attributes,
|
||||
* except for the uncommitted text. The input method may provide a list of
|
||||
* attributes it is interested in; and the iterator need not provide
|
||||
* information on the remaining attributes. If the attribute list is null,
|
||||
* the iterator must list all attributes.
|
||||
*
|
||||
* @param beginIndex the index of the first character in the iteration
|
||||
* @param endIndex the index of the last character in the iteration
|
||||
* @param attributes a list of attributes interested in, or null
|
||||
* @return an iterator over the region of text with its attributes
|
||||
*/
|
||||
AttributedCharacterIterator getCommittedText(int beginIndex, int endIndex,
|
||||
Attribute[] attributes);
|
||||
|
||||
/**
|
||||
* Gets the length of committed text.
|
||||
*
|
||||
* @return the number of committed characters
|
||||
*/
|
||||
int getCommittedTextLength();
|
||||
|
||||
/**
|
||||
* Gets the latest committed text, and removes it from the component's text
|
||||
* body. This allows an input method to provide an "Undo" command. In
|
||||
* general, this should only be supported immediately after a commit, and
|
||||
* not when other actions intervene; if not supported, simply return null.
|
||||
* The input method may provide a list of attributes it is interested in;
|
||||
* and the iterator need not provide information on the remaining attributes.
|
||||
* If the attribute list is null, the iterator must list all attributes.
|
||||
*
|
||||
* @param attributes a list of attributes interested in, or null
|
||||
* @return the latest committed text, or null
|
||||
*/
|
||||
AttributedCharacterIterator cancelLatestCommittedText
|
||||
(Attribute[] attributes);
|
||||
|
||||
/**
|
||||
* Gets the currently selected text. One use of this is to implement a
|
||||
* "Reconvert" feature in an input method, which modifies the selection
|
||||
* based on the text in the composition window. The input method may
|
||||
* provide a list of attributes it is interested in; and the iterator need
|
||||
* not provide information on the remaining attributes. If the attribute
|
||||
* list is null, the iterator must list all attributes.
|
||||
*
|
||||
* @param attributes a list of attributes interested in, or null
|
||||
* @return the current selection
|
||||
*/
|
||||
AttributedCharacterIterator getSelectedText(Attribute[] attributes);
|
||||
} // interface InputMethodRequests
|
||||
@@ -0,0 +1,129 @@
|
||||
/* InputSubset.java -- subsets of Unicode important in text input
|
||||
Copyright (C) 2002, 2003, 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. */
|
||||
|
||||
package java.awt.im;
|
||||
|
||||
/**
|
||||
* Defines additional Unicode character blocks for use by input methods.
|
||||
* These constants encompass several Unicode blocks, or portions thereof, for
|
||||
* simplification over {@link Character.UnicodeBlock}.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @since 1.2
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public final class InputSubset extends Character.Subset
|
||||
{
|
||||
/**
|
||||
* Constant for all Latin characters, including the characters in the
|
||||
* BASIC_LATIN, LATIN_1_SUPPLEMENT, LATIN_EXTENDED_A, LATIN_EXTENDED_B
|
||||
* Unicode character blocks.
|
||||
*/
|
||||
public static final InputSubset LATIN = new InputSubset("LATIN");
|
||||
|
||||
/**
|
||||
* Constant for the digits included in the BASIC_LATIN Unicode character
|
||||
* block.
|
||||
*/
|
||||
public static final InputSubset LATIN_DIGITS
|
||||
= new InputSubset("LATIN_DIGITS");
|
||||
|
||||
/**
|
||||
* Constant for all Han characters used in writing Traditional Chinese,
|
||||
* including a subset of the CJK unified ideographs as well as Traditional
|
||||
* Chinese Han characters that may be defined as surrogate characters.
|
||||
*/
|
||||
public static final InputSubset TRADITIONAL_HANZI
|
||||
= new InputSubset("TRADITIONAL_HANZI");
|
||||
|
||||
/**
|
||||
* Constant for all Han characters used in writing Simplified Chinese,
|
||||
* including a subset of the CJK unified ideographs as well as Simplified
|
||||
* Chinese Han characters that may be defined as surrogate characters.
|
||||
*/
|
||||
public static final InputSubset SIMPLIFIED_HANZI
|
||||
= new InputSubset("SIMPLIFIED_HANZI");
|
||||
|
||||
/**
|
||||
* Constant for all Han characters used in writing Japanese, including a
|
||||
* subset of the CJK unified ideographs as well as Japanese Han characters
|
||||
* that may be defined as surrogate characters.
|
||||
*/
|
||||
public static final InputSubset KANJI = new InputSubset("KANJI");
|
||||
|
||||
/**
|
||||
* Constant for all Han characters used in writing Korean, including a
|
||||
* subset of the CJK unified ideographs as well as Korean Han characters
|
||||
* that may be defined as surrogate characters.
|
||||
*/
|
||||
public static final InputSubset HANJA = new InputSubset("HANJA");
|
||||
|
||||
/**
|
||||
* Constant for the halfwidth katakana subset of the Unicode halfwidth and
|
||||
* fullwidth forms character block.
|
||||
*/
|
||||
public static final InputSubset HALFWIDTH_KATAKANA
|
||||
= new InputSubset("HALFWIDTH_KATAKANA");
|
||||
|
||||
/**
|
||||
* Constant for the fullwidth ASCII variants subset of the Unicode
|
||||
* halfwidth and fullwidth forms character block.
|
||||
*
|
||||
* @since 1.3
|
||||
*/
|
||||
public static final InputSubset FULLWIDTH_LATIN
|
||||
= new InputSubset("FULLWIDTH_LATIN");
|
||||
|
||||
/**
|
||||
* Constant for the fullwidth digits included in the Unicode halfwidth and
|
||||
* fullwidth forms character block.
|
||||
*
|
||||
* @since 1.3
|
||||
*/
|
||||
public static final InputSubset FULLWIDTH_DIGITS
|
||||
= new InputSubset("FULLWIDTH_DIGITS");
|
||||
|
||||
/**
|
||||
* Construct a subset.
|
||||
*
|
||||
* @param name the subset name
|
||||
*/
|
||||
private InputSubset(String name)
|
||||
{
|
||||
super(name);
|
||||
}
|
||||
} // class InputSubset
|
||||
@@ -0,0 +1,46 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<!-- package.html - describes classes in java.awt.im package.
|
||||
Copyright (C) 2002 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. -->
|
||||
|
||||
<html>
|
||||
<head><title>GNU Classpath - java.awt.im</title></head>
|
||||
|
||||
<body>
|
||||
<p>Support for text input methods.</p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,240 @@
|
||||
/* InputMethod.java -- defines an interface for complex text input
|
||||
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. */
|
||||
|
||||
package java.awt.im.spi;
|
||||
|
||||
import java.awt.AWTEvent;
|
||||
import java.awt.Rectangle;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* This interface supports complex text input, often for situations where
|
||||
* the text is more complex than a keyboard will accomodate. For example,
|
||||
* this can be used for Chinese, Japanese, and Korean, where multiple
|
||||
* keystrokes are necessary to compose text. This could also support things
|
||||
* like phonetic English, or reordering Thai.
|
||||
*
|
||||
* <p>These contexts can be loaded by the input method framework, using
|
||||
* {@link InputContext#selectInputMethod(Locale)}.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @since 1.3
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public interface InputMethod
|
||||
{
|
||||
/**
|
||||
* Set the input method context, which ties the input method to a client
|
||||
* component. This is called once automatically when creating the input
|
||||
* method.
|
||||
*
|
||||
* @param context the context for this input method
|
||||
* @throws NullPointerException if context is null
|
||||
*/
|
||||
void setInputMethodContext(InputMethodContext context);
|
||||
|
||||
/**
|
||||
* Sets the input locale. If the input method supports that locale, it
|
||||
* changes its behavior to be consistent with the locale and returns true.
|
||||
* Otherwise, it returns false. This is called by
|
||||
* {@link InputContext#selectInputMethod(Locale)} when the user specifies
|
||||
* a locale, or when the previously selected input method had a locale.
|
||||
*
|
||||
* @param locale the locale to use for input
|
||||
* @return true if the change is successful
|
||||
* @throws NullPointerException if locale is null
|
||||
*/
|
||||
boolean setLocale(Locale locale);
|
||||
|
||||
/**
|
||||
* Returns the current input locale, or null if none is defined. This is
|
||||
* called by {@link InputContext#getLocale()}, or before switching input
|
||||
* methods.
|
||||
*
|
||||
* @return the current input locale, or null
|
||||
*/
|
||||
Locale getLocale();
|
||||
|
||||
/**
|
||||
* Sets the allowed Unicode subsets that this input method can use. Null
|
||||
* indicates that all characters are allowed. This is called after creation,
|
||||
* or when switching to this input method, by
|
||||
* {@link InputContext#setCharacterSubsets(Character.Subset[])}.
|
||||
*
|
||||
* @param subsets the accepted subsets for this input method, or null for all
|
||||
*/
|
||||
void setCharacterSubsets(Character.Subset[] subsets);
|
||||
|
||||
/**
|
||||
* Changes the enabled status of this input method. An enabled input method
|
||||
* accepts incoming events for composition and control purposes, while a
|
||||
* disabled input method ignores events (except for control purposes). This
|
||||
* is called by {@link InputContext#setCompositionEnabled(boolean)} or when
|
||||
* switching from an input method if the previous input method returned
|
||||
* without exception on {@link #isCompositionEnabled()}.
|
||||
*
|
||||
* @param enable whether to enable this input method
|
||||
* @throws UnsupportedOperationException if enabling/disabling is unsupported
|
||||
* @see #isCompositionEnabled()
|
||||
*/
|
||||
void setCompositionEnabled(boolean enable);
|
||||
|
||||
/**
|
||||
* Find out if this input method is enabled. This is called by
|
||||
* {@link InputContext#isCompositionEnabled()}, or when switching input
|
||||
* methods via {@link InputContext#selectInputMethod(Locale)}.
|
||||
*
|
||||
* @return true if this input method is enabled
|
||||
* @throws UnsupportedOperationException if enabling/disabling is unsupported
|
||||
* @see #setCompositionEnabled(boolean)
|
||||
*/
|
||||
boolean isCompositionEnabled();
|
||||
|
||||
/**
|
||||
* Starts a reconversion operation. The input method gets its text from the
|
||||
* client, using {@link InputMethodRequests#getSelectedText(Attribute[])}.
|
||||
* Then the composed and committed text produced by the operation is sent
|
||||
* back to the client using a sequence of InputMethodEvents. This is called
|
||||
* by {@link InputContext#reconvert()}.
|
||||
*
|
||||
* @throws UnsupportedOperationException if reconversion is unsupported
|
||||
*/
|
||||
void reconvert();
|
||||
|
||||
/**
|
||||
* Dispatch an event to the input method. If input method support is enabled,
|
||||
* certain events are dispatched to the input method before the client
|
||||
* component or event listeners. The input method must either consume the
|
||||
* event or pass it on to the component. Instances of InputEvent, including
|
||||
* KeyEvent and MouseEvent, are given to this input method. This method is
|
||||
* called by {@link InputContext#dispatchEvent(AWTEvent)}.
|
||||
*
|
||||
* @param event the event to dispatch
|
||||
* @throws NullPointerException if event is null
|
||||
*/
|
||||
void dispatchEvent(AWTEvent event);
|
||||
|
||||
/**
|
||||
* Notify this input method of changes in the client window. This is called
|
||||
* when notifications are enabled (see {@link
|
||||
* InputMethodContext#enableClientWindowNotification(InputMethod, boolean)},
|
||||
* if {@link #removeNotify(Component)} has not been called. The following
|
||||
* situations trigger a notification:<ul>
|
||||
* <li>The client window changes in location, size, visibility,
|
||||
* iconification, or is closed.</li>
|
||||
* <li>When enabling client notification (or on the first activation after
|
||||
* enabling if no client existed at the time).</li>
|
||||
* <li>When activating a new client after <code>removeNotify</code> was
|
||||
* called on a previous client.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param bounds the client window's current bounds, or null
|
||||
*/
|
||||
void notifyClientWindowChange(Rectangle bounds);
|
||||
|
||||
/**
|
||||
* Activate this input method for input processing. If the input method
|
||||
* provides its own windows, it should make them open and visible at this
|
||||
* time. This method is called when a client component receives a
|
||||
* FOCUS_GAINED event, or when switching to this input method from another
|
||||
* one. It is only called when the input method is inactive, assuming that
|
||||
* new instances begin in an inactive state.
|
||||
*/
|
||||
void activate();
|
||||
|
||||
/**
|
||||
* Deactivate this input method, either temporarily or permanently for the
|
||||
* given client. If the input method provides its own windows, it should
|
||||
* only close those related to the current composition (such as a lookup
|
||||
* choice panel), while leaving more persistant windows (like a control
|
||||
* panel) open to avoid screen flicker. Before control is given to another
|
||||
* input method, {@link #hideWindows()} will be called on this instance.
|
||||
* This method is called when a client component receives a
|
||||
* FOCUS_LOST event, when switching to another input method, or before
|
||||
* {@link #removeNotify()} when the client is removed.
|
||||
*
|
||||
* @param isTemporary true if the focus change is temporary
|
||||
*/
|
||||
void deactivate(boolean isTemporary);
|
||||
|
||||
/**
|
||||
* Close or hide all windows opened by this input method. This is called
|
||||
* before activating a different input method, and before calling
|
||||
* {@link #dispose()} on this instance. It is only called when the input
|
||||
* method is inactive.
|
||||
*/
|
||||
void hideWindows();
|
||||
|
||||
/**
|
||||
* Notify the input method that a client component has been removed from its
|
||||
* hierarchy, or that input method support has been disabled. This is
|
||||
* called by {@link InputContext#removeNotify()}, and only when the input
|
||||
* method is inactive.
|
||||
*/
|
||||
void removeNotify();
|
||||
|
||||
/**
|
||||
* End any input composition currently taking place. Depending on the
|
||||
* platform and user preferences, this may commit or delete uncommitted text,
|
||||
* using input method events. This may be called for a variety of reasons,
|
||||
* such as when the user moves the insertion point in the client text outside
|
||||
* the range of the composed text, or when text is saved to file. This is
|
||||
* called by {@link InputContext#endComposition()}, when switching to a
|
||||
* new input method, or by {@link InputContext#selectInputMethod(Locale)}.
|
||||
*/
|
||||
void endComposition();
|
||||
|
||||
/**
|
||||
* Disposes the input method and release any resources it is using. In
|
||||
* particular, the input method should dispose windows and close files. This
|
||||
* is called by {@link InputContext#dispose()}, when the input method is
|
||||
* inactive; and nothing will be called on this instance afterwards.
|
||||
*/
|
||||
void dispose();
|
||||
|
||||
/**
|
||||
* Returns a control object from this input method, or null. A control object
|
||||
* provides method to control the behavior of this input method, as well as
|
||||
* query information about it. The object is implementation dependent, so
|
||||
* clients must compare the result against known input method control
|
||||
* object types. This is called by
|
||||
* {@link InputContext#getInputMethodControlObject()}.
|
||||
*
|
||||
* @return the control object, or null
|
||||
*/
|
||||
Object getControlObject();
|
||||
} // interface InputMethod
|
||||
@@ -0,0 +1,123 @@
|
||||
/* InputMethodContext.java -- communication between an input method and client
|
||||
Copyright (C) 2002, 2004 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. */
|
||||
|
||||
|
||||
package java.awt.im.spi;
|
||||
|
||||
import java.awt.Window;
|
||||
import java.awt.font.TextHitInfo;
|
||||
import java.awt.im.InputMethodRequests;
|
||||
import java.text.AttributedCharacterIterator;
|
||||
|
||||
import javax.swing.JFrame;
|
||||
|
||||
/**
|
||||
* Provides methods for the communication context between an input method
|
||||
* and the client component. This should be passed to
|
||||
* {@link InputMethod#setInputMethodContext(InputMethodContext)}.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @since 1.3
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public interface InputMethodContext extends InputMethodRequests
|
||||
{
|
||||
/**
|
||||
* Create an input method event and dispatch it to the client.
|
||||
*
|
||||
* @param id the event type
|
||||
* @param text an iterator over the text to be committed
|
||||
* @param count the count of characters to be committed
|
||||
* @param caret the insertion point of the commit, or null
|
||||
* @param visiblePosition the best location to make visible, or null
|
||||
*/
|
||||
void dispatchInputMethodEvent(int id, AttributedCharacterIterator text,
|
||||
int count, TextHitInfo caret,
|
||||
TextHitInfo visiblePosition);
|
||||
|
||||
/**
|
||||
* Creates a top-level window for use by the input method. This window should
|
||||
* float above all document windows and dialogs, not receive focus, and have
|
||||
* lightweight decorations (such as no title, reduced drag regions). But
|
||||
* this behavior may be modified to meet the platform style. The title may
|
||||
* or may not be displayed, depending on the platform.
|
||||
*
|
||||
* <p>If attachToInputContext is true, the new window will share the input
|
||||
* context of the input method, so that events in the new window are
|
||||
* dispatched to the input method. Also, this supresses deactivate and
|
||||
* activate calls to the input method caused by setVisible.
|
||||
*
|
||||
* @param title the window title, if one is displayed; null becomes ""
|
||||
* @param attachToInputContext true for the window to share context with
|
||||
* the input method
|
||||
* @return the new window for use by the input method
|
||||
* @throws HeadlessException if GraphicsEnvironment.isHeadless is true
|
||||
*/
|
||||
Window createInputMethodWindow(String title, boolean attachToInputContext);
|
||||
|
||||
/**
|
||||
* Creates a top-level Swing JFrame for use by the input method. This frame
|
||||
* should float above all document windows and dialogs, not receive focus,
|
||||
* and have lightweight decorations (such as no title, reduced drag
|
||||
* regions). But this behavior may be modified to meet the platform style.
|
||||
* The title may or may not be displayed, depending on the platform.
|
||||
*
|
||||
* <p>If attachToInputContext is true, the new window will share the input
|
||||
* context of the input method, so that events in the new window are
|
||||
* dispatched to the input method. Also, this supresses deactivate and
|
||||
* activate calls to the input method caused by setVisible.
|
||||
*
|
||||
* @param title the window title, if one is displayed; null becomes ""
|
||||
* @param attachToInputContext true for the window to share context with
|
||||
* the input method
|
||||
* @return the new window for use by the input method
|
||||
* @throws HeadlessException if GraphicsEnvironment.isHeadless is true
|
||||
* @since 1.4
|
||||
*/
|
||||
JFrame createInputMethodJFrame(String title, boolean attachToInputContext);
|
||||
|
||||
/**
|
||||
* Sets whether notification of the client window's location and state should
|
||||
* be enabled for the input method. When enabled, the input method's
|
||||
* {@link #notifyClientWindowChange(Rectangle)} method is called.
|
||||
* Notification is automatically disabled when the input method is disposed.
|
||||
*
|
||||
* @param inputMethod the method to change status of
|
||||
* @param enable true to enable notification
|
||||
*/
|
||||
void enableClientWindowNotification(InputMethod inputMethod, boolean enable);
|
||||
} // interface InputMethodContext
|
||||
@@ -0,0 +1,113 @@
|
||||
/* InputMethodDescriptor.java -- enables loading and use of an input method
|
||||
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. */
|
||||
|
||||
package java.awt.im.spi;
|
||||
|
||||
import java.awt.AWTException;
|
||||
import java.awt.Image;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* This interface provides information about an InputMethod before it is
|
||||
* loaded.
|
||||
*
|
||||
* @author Eric Blake (ebb9@email.byu.edu)
|
||||
* @since 1.3
|
||||
* @status updated to 1.4
|
||||
*/
|
||||
public interface InputMethodDescriptor
|
||||
{
|
||||
/**
|
||||
* Returns the locales supported by the input method this describes. This
|
||||
* allows the selection of input methods by locale (by language only, or
|
||||
* also by country and variant), via
|
||||
* {@link InputContext#selectInputMethod(Locale)}. The returned list should
|
||||
* ignore pass-through locales, so it is usually a subset of locales for
|
||||
* which {@link InputMethod#setContext(Locale)} returns true. If
|
||||
* {@link #hasDynamicLocaleList()} returns true, this is called each time
|
||||
* information is needed, allowing dynamic addition or removal of supported
|
||||
* locales.
|
||||
*
|
||||
* @return the list of supported locales
|
||||
* @throws AWTException if the input method is not available
|
||||
*/
|
||||
Locale[] getAvailableLocales() throws AWTException;
|
||||
|
||||
/**
|
||||
* Test whether the input method this describes has a static or dynamic
|
||||
* locale list. For example, this would return true if the list of supported
|
||||
* locales depends on adapters currently loaded over a network.
|
||||
*
|
||||
* @return true if the locale list is dynamic
|
||||
*/
|
||||
boolean hasDynamicLocaleList();
|
||||
|
||||
/**
|
||||
* Returns a user visible name of the input locale, displayed in the
|
||||
* specified locale. The inputLocale parameter must be one obtained from
|
||||
* the list in {@link #getAvailableLocales()}, or null for a
|
||||
* locale-independent description of the input method. If a translation to
|
||||
* the desired display language is not available, another language may be
|
||||
* used.
|
||||
*
|
||||
* @param inputLocale the locale of the input method, or null
|
||||
* @param displayLanguage the language of the result
|
||||
* @return the name of the input method when using the given inputLocale
|
||||
*/
|
||||
String getInputMethodDisplayName(Locale inputLocale,
|
||||
Locale displayLanguage);
|
||||
|
||||
/**
|
||||
* Returns a 16x16 icon for the input locale. The inputLocale parameter
|
||||
* must be one obtained from the list in {@link #getAvailableLocales()}, or
|
||||
* null for a locale-independent icon for the input method.
|
||||
*
|
||||
* @param inputLocale the locale of the input method, or null
|
||||
* @return a 16x16 icon for the input method when using the given inputLocale
|
||||
*/
|
||||
Image getInputMethodIcon(Locale inputLocale);
|
||||
|
||||
/**
|
||||
* Creates a new instance of the input method.
|
||||
*
|
||||
* @return the newly created input method
|
||||
* @throws Exception if anything goes wrong
|
||||
*/
|
||||
InputMethod createInputMethod() throws Exception;
|
||||
|
||||
} // interface InputMethodDescriptor
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<!-- package.html - describes classes in java.awt.im.spi package.
|
||||
Copyright (C) 2002 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. -->
|
||||
|
||||
<html>
|
||||
<head><title>GNU Classpath - java.awt.im.spi</title></head>
|
||||
|
||||
<body>
|
||||
<p>Interfaces for implementation of text input methods.</p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user