javauis/lcdui_akn/javalcdui/javasrc.nokialcdui/com/nokia/mid/ui/S60TextEditor.java
branchRCL_3
changeset 23 e5618cc85d74
parent 21 4376525cdefb
equal deleted inserted replaced
21:4376525cdefb 23:e5618cc85d74
    67  * virtual keyboard is opened. The keyboard takes part of the screen space, so
    67  * virtual keyboard is opened. The keyboard takes part of the screen space, so
    68  * canvas is smaller when virtual keyboard is visible.
    68  * canvas is smaller when virtual keyboard is visible.
    69  * Application is notified about this by events, so it can react on this
    69  * Application is notified about this by events, so it can react on this
    70  * change and resize, move TextEditor to the visible area and adjust the
    70  * change and resize, move TextEditor to the visible area and adjust the
    71  * whole Canvas.
    71  * whole Canvas.
       
    72  * </p>
       
    73  * 
       
    74  * <h3>Touch settings</h3>
       
    75  * <p>
       
    76  * The TextEditor receives touch events in touch devices. This can be 
       
    77  * disabled/enabled by {@link com.nokia.mid.ui.S60TextEditor#setTouchEnabled(boolean)}
       
    78  * An editor with touch-event disabled won't be able to perform any
       
    79  * touch-related functionality.
    72  * </p>
    80  * </p>
    73  * @see TextEditor
    81  * @see TextEditor
    74  * @since 1.4
    82  * @since 1.4
    75  */
    83  */
    76 public abstract interface S60TextEditor
    84 public abstract interface S60TextEditor
   312      *
   320      *
   313      * @param y
   321      * @param y
   314      *      The y coordinate of the wanted caret position.
   322      *      The y coordinate of the wanted caret position.
   315      */
   323      */
   316     public void setCaretXY(int x, int y);
   324     public void setCaretXY(int x, int y);
   317 
   325     
       
   326     /**
       
   327      * Specifies whether or not the editor will receive touch-events.
       
   328      * <p>
       
   329      * This is enabled by default.
       
   330      * An editor with touch-event disabled won't be able to perform any
       
   331      * touch-related functionality such as scrolling or positioning the
       
   332      * cursor. It may however still be controlled via the
       
   333      * virtual keypad/control-panel if that is enabled, or receive other +
       
   334      * input e.g. via physical keys
       
   335      * <p>
       
   336      * @param enabled
       
   337      *              true to enabled touch-event, false to disable
       
   338      */
       
   339     public void setTouchEnabled(boolean enabled);
       
   340 
       
   341     /**
       
   342      * Gets the current touch-enabled state
       
   343      * <p>
       
   344      * @return true if the editor is touch-enabled, false otherwise
       
   345      */
       
   346     public boolean isTouchEnabled();
   318 }
   347 }
   319 
   348 
   320 // End of file
   349 // End of file