< prev index next >
src/java.desktop/share/classes/java/awt/im/spi/InputMethod.java
Print this page
*** 57,67 ****
* <p>
* This method is called once immediately after instantiating this input
* method.
*
* @param context the input method context for this input method
! * @exception NullPointerException if <code>context</code> is null
*/
public void setInputMethodContext(InputMethodContext context);
/**
* Attempts to set the input locale. If the input method supports the
--- 57,67 ----
* <p>
* This method is called once immediately after instantiating this input
* method.
*
* @param context the input method context for this input method
! * @exception NullPointerException if {@code context} is null
*/
public void setInputMethodContext(InputMethodContext context);
/**
* Attempts to set the input locale. If the input method supports the
*** 78,88 ****
* returns a non-null value.
* </ul>
*
* @param locale locale to input
* @return whether the specified locale is supported
! * @exception NullPointerException if <code>locale</code> is null
*/
public boolean setLocale(Locale locale);
/**
* Returns the current input locale. Might return null in exceptional cases.
--- 78,88 ----
* returns a non-null value.
* </ul>
*
* @param locale locale to input
* @return whether the specified locale is supported
! * @exception NullPointerException if {@code locale} is null
*/
public boolean setLocale(Locale locale);
/**
* Returns the current input locale. Might return null in exceptional cases.
*** 115,125 ****
*/
public void setCharacterSubsets(Subset[] subsets);
/**
* Enables or disables this input method for composition,
! * depending on the value of the parameter <code>enable</code>.
* <p>
* An input method that is enabled for composition interprets incoming
* events for both composition and control purposes, while a
* disabled input method does not interpret events for composition.
* Note however that events are passed on to the input method regardless
--- 115,125 ----
*/
public void setCharacterSubsets(Subset[] subsets);
/**
* Enables or disables this input method for composition,
! * depending on the value of the parameter {@code enable}.
* <p>
* An input method that is enabled for composition interprets incoming
* events for both composition and control purposes, while a
* disabled input method does not interpret events for composition.
* Note however that events are passed on to the input method regardless
*** 164,190 ****
* <li>when switching from this input method to a different one using the
* user interface or
* {@link java.awt.im.InputContext#selectInputMethod InputContext.selectInputMethod}.
* </ul>
*
! * @return <code>true</code> if this input method is enabled for
! * composition; <code>false</code> otherwise.
* @throws UnsupportedOperationException if this input method does not
* support checking whether it is enabled for composition
* @see #setCompositionEnabled
*/
public boolean isCompositionEnabled();
/**
* Starts the reconversion operation. The input method obtains the
* text to be reconverted from the current client component using the
* {@link java.awt.im.InputMethodRequests#getSelectedText InputMethodRequests.getSelectedText}
! * method. It can use other <code>InputMethodRequests</code>
* methods to request additional information required for the
* reconversion operation. The composed and committed text
* produced by the operation is sent to the client component as a
! * sequence of <code>InputMethodEvent</code>s. If the given text
* cannot be reconverted, the same text should be sent to the
* client component as committed text.
* <p>
* This method is called by
* {@link java.awt.im.InputContext#reconvert() InputContext.reconvert}.
--- 164,190 ----
* <li>when switching from this input method to a different one using the
* user interface or
* {@link java.awt.im.InputContext#selectInputMethod InputContext.selectInputMethod}.
* </ul>
*
! * @return {@code true} if this input method is enabled for
! * composition; {@code false} otherwise.
* @throws UnsupportedOperationException if this input method does not
* support checking whether it is enabled for composition
* @see #setCompositionEnabled
*/
public boolean isCompositionEnabled();
/**
* Starts the reconversion operation. The input method obtains the
* text to be reconverted from the current client component using the
* {@link java.awt.im.InputMethodRequests#getSelectedText InputMethodRequests.getSelectedText}
! * method. It can use other {@code InputMethodRequests}
* methods to request additional information required for the
* reconversion operation. The composed and committed text
* produced by the operation is sent to the client component as a
! * sequence of {@code InputMethodEvent}s. If the given text
* cannot be reconverted, the same text should be sent to the
* client component as committed text.
* <p>
* This method is called by
* {@link java.awt.im.InputContext#reconvert() InputContext.reconvert}.
*** 198,219 ****
* Dispatches the event to the input method. If input method support is
* enabled for the focused component, incoming events of certain types
* are dispatched to the current input method for this component before
* they are dispatched to the component's methods or event listeners.
* The input method decides whether it needs to handle the event. If it
! * does, it also calls the event's <code>consume</code> method; this
* causes the event to not get dispatched to the component's event
* processing methods or event listeners.
* <p>
* Events are dispatched if they are instances of InputEvent or its
* subclasses.
* This includes instances of the AWT classes KeyEvent and MouseEvent.
* <p>
* This method is called by {@link java.awt.im.InputContext#dispatchEvent InputContext.dispatchEvent}.
*
* @param event the event being dispatched to the input method
! * @exception NullPointerException if <code>event</code> is null
*/
public void dispatchEvent(AWTEvent event);
/**
* Notifies this input method of changes in the client window
--- 198,219 ----
* Dispatches the event to the input method. If input method support is
* enabled for the focused component, incoming events of certain types
* are dispatched to the current input method for this component before
* they are dispatched to the component's methods or event listeners.
* The input method decides whether it needs to handle the event. If it
! * does, it also calls the event's {@code consume} method; this
* causes the event to not get dispatched to the component's event
* processing methods or event listeners.
* <p>
* Events are dispatched if they are instances of InputEvent or its
* subclasses.
* This includes instances of the AWT classes KeyEvent and MouseEvent.
* <p>
* This method is called by {@link java.awt.im.InputContext#dispatchEvent InputContext.dispatchEvent}.
*
* @param event the event being dispatched to the input method
! * @exception NullPointerException if {@code event} is null
*/
public void dispatchEvent(AWTEvent event);
/**
* Notifies this input method of changes in the client window
*** 231,247 ****
* <li>
* when the window containing the current client component changes
* in location, size, visibility, iconification state, or when the
* window is closed.</li>
* <li>
! * from <code> enableClientWindowNotification(inputMethod,
! * true)</code> if the current client component exists,</li>
* <li>
* when activating the input method for the first time after it
* called
! * <code>enableClientWindowNotification(inputMethod,
! * true)</code> if during the call no current client component was
* available,</li>
* <li>
* when activating the input method for a new client component
* after the input context's removeNotify method has been
* called.</li>
--- 231,247 ----
* <li>
* when the window containing the current client component changes
* in location, size, visibility, iconification state, or when the
* window is closed.</li>
* <li>
! * from {@code enableClientWindowNotification(inputMethod, true)}
! * if the current client component exists,</li>
* <li>
* when activating the input method for the first time after it
* called
! * {@code enableClientWindowNotification(inputMethod, true)}
! * if during the call no current client component was
* available,</li>
* <li>
* when activating the input method for a new client component
* after the input context's removeNotify method has been
* called.</li>
< prev index next >