9 * Initial Contributors:

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    10 * Nokia Corporation - initial contribution.

    11 *

    11 *

    12 * Contributors:

    12 * Contributors:

    13 *

    13 *

    15 *

    15 *

    16 */

    16 */

    17 package javax.microedition.lcdui;

    17 package javax.microedition.lcdui;

    18 

    18 

    19 import java.util.Timer;

    19 import java.util.Timer;

    22 import org.eclipse.swt.SWT;

    22 import org.eclipse.swt.SWT;

    23 

    23 

    24 /**

    24 /**

    25  * Responsible for implementing interaction in DefaultFormLayoutPolicy.

    25  * Responsible for implementing interaction in DefaultFormLayoutPolicy.

    26  */

    26  */

    28 

    29 

    29     private static final int NO_DIRECTION = -1;

    30     private static final int NO_DIRECTION = -1;

    30 

    31 

    31     private Item currentSelectedItem;

    32     private Item currentSelectedItem;

    32 

    33 

    39     /**

    40     /**

    40      * Constructor.

    41      * Constructor.

    41      *

    42      *

    42      * @param form where DFLP is applied.

    43      * @param form where DFLP is applied.

    43      */

    44      */

    45         super(form);

    47         super(form);

    46     }

    48     }

    47 

    49 

    49         super.handleShowCurrentEvent();

    52         super.handleShowCurrentEvent();

    50         eswtApplyCurrentFocus();

    53         eswtApplyCurrentFocus();

    51     }

    54     }

    52 

    55 

    54         super.handleHideCurrentEvent();

    58         super.handleHideCurrentEvent();

    55         direction = NO_DIRECTION;

    59         direction = NO_DIRECTION;

    56     }

    60     }

    57 

    61 

    58     /* (non-Javadoc)

    62     /* (non-Javadoc)

    59      * @see DefaultFormLayoutPolicy#eswtLayoutForm(int)

    63      * @see DefaultFormLayoutPolicy#eswtLayoutForm(int)

    60      */

    64      */

    62         super.eswtLayoutForm(startIndex);

    67         super.eswtLayoutForm(startIndex);

    63 

    68 

    64         // clear invalid selected item

    69         // clear invalid selected item

    65         eswtCheckCurrentSelectedItem();

    70         eswtCheckCurrentSelectedItem();

    66 

    71 

    69             eswtApplyCurrentFocus();

    75             eswtApplyCurrentFocus();

    70         }

    76         }

    72             // If there's no item currently selected try to find first

    79             // If there's no item currently selected try to find first

    73             // focusable item and set it current (if found):

    80             // focusable item and set it current (if found):

    74             Item found = eswtGetNextFocusableItem(

    81             Item found = eswtGetNextFocusableItem(

    77                 eswtSetCurrentSelectedItem(found, NO_DIRECTION);

    85                 eswtSetCurrentSelectedItem(found, NO_DIRECTION);

    78             }

    86             }

    80                 eswtApplyCurrentFocus();

    89                 eswtApplyCurrentFocus();

    81             }

    90             }

    82         }

    91         }

    83     }

    92     }

    84 

    93 

    85     /* (non-Javadoc)

    94     /* (non-Javadoc)

    86      * @see DefaultFormLayoutPolicy#eswtSetCurrentItem(Item)

    95      * @see DefaultFormLayoutPolicy#eswtSetCurrentItem(Item)

    87      */

    96      */

    89         boolean ret = super.eswtSetCurrentItem(item);

    99         boolean ret = super.eswtSetCurrentItem(item);

    91             eswtSetCurrentSelectedItem(item, NO_DIRECTION);

   102             eswtSetCurrentSelectedItem(item, NO_DIRECTION);

    92             Logger.info("eswtSetCurrentItem" + item);

   103             Logger.info("eswtSetCurrentItem" + item);

    93         }

   104         }

    94         return ret;

   105         return ret;

    95     }

   106     }

   101      * needed. The method is called by the Form.

   112      * needed. The method is called by the Form.

   102      *

   113      *

   103      * @param keyCode eSWT key code.

   114      * @param keyCode eSWT key code.

   104      * @param keyType eSWT key type.

   115      * @param keyType eSWT key type.

   105      */

   116      */

   107         Logger.method(this, "handleKeyEvent", currentSelectedItem,

   119         Logger.method(this, "handleKeyEvent", currentSelectedItem,

   109 

   121 

   110         boolean isDirectionalKey = isDirectionKey(keyCode);

   122         boolean isDirectionalKey = isDirectionKey(keyCode);

   112             eswtCheckCurrentSelectedItem();

   125             eswtCheckCurrentSelectedItem();

   113         }

   126         }

   114 

   127 

   118                 // if the key has been consumed

   133                 // if the key has been consumed

   119                 return;

   134                 return;

   120             }

   135             }

   121         }

   136         }

   122 

   137 

   123         // scrolling/focus traverse only happens on directional key's down event

   138         // scrolling/focus traverse only happens on directional key's down event

   125             // try to find next focusable item

   141             // try to find next focusable item

   126             Item next = eswtGetNextFocusableItem(currentSelectedItem, keyCode);

   142             Item next = eswtGetNextFocusableItem(currentSelectedItem, keyCode);

   127 

   143 

   128             // if no visible & focusable item was found to transfer focus

   144             // if no visible & focusable item was found to transfer focus

   130                 // try to scroll a bit

   147                 // try to scroll a bit

   131                 eswtSetScrollingPosition(getNextScrollingPosition(keyCode),

   148                 eswtSetScrollingPosition(getNextScrollingPosition(keyCode),

   133                 // find next focusable after scrolling

   150                 // find next focusable after scrolling

   134                 next = eswtGetNextFocusableItem(currentSelectedItem, keyCode);

   151                 next = eswtGetNextFocusableItem(currentSelectedItem, keyCode);

   135             }

   152             }

   136 

   153 

   138                 //textfield always have to be fully visible when focused.

   156                 //textfield always have to be fully visible when focused.

   140                     eswtScrollToItem(next);

   159                     eswtScrollToItem(next);

   141                 }

   160                 }

   142                 eswtSetCurrentSelectedItem(next, keyCode);

   161                 eswtSetCurrentSelectedItem(next, keyCode);

   143             }

   162             }

   144         }

   163         }

   147     /**

   166     /**

   148      * Returns if the parameter is a eSWT directional key code.

   167      * Returns if the parameter is a eSWT directional key code.

   149      *

   168      *

   150      * @param keyCode key code

   169      * @param keyCode key code

   151      */

   170      */

   153         return (keyCode == SWT.ARROW_DOWN || keyCode == SWT.ARROW_UP

   173         return (keyCode == SWT.ARROW_DOWN || keyCode == SWT.ARROW_UP

   155     }

   175     }

   156 

   176 

   157     /**

   177     /**

   158      * DefaultFormInteraction handler for pointer events.<br>

   178      * DefaultFormInteraction handler for pointer events.<br>

   159      * The method is called by the Form.

   179      * The method is called by the Form.

   160      *

   180      *

   161      * @param x coordinate relative to scrolledComposite

   181      * @param x coordinate relative to scrolledComposite

   162      * @param y coordinate relative to scrolledComposite

   182      * @param y coordinate relative to scrolledComposite

   163      * @param type event type: SWT.MouseDown, SWT.MouseMove, SWT.MouseUp

   183      * @param type event type: SWT.MouseDown, SWT.MouseMove, SWT.MouseUp

   164      */

   184      */

   166         Logger.method(this, "handlePointerEvent", String.valueOf(x),

   187         Logger.method(this, "handlePointerEvent", String.valueOf(x),

   168 

   189 

   169         // TODO: change when DirectUI style arrives.

   190         // TODO: change when DirectUI style arrives.

   170         /*

   191         /*

   171         Item item;

   192         Item item;

   172         if (type == SWT.MouseMove) {

   193         if (type == SWT.MouseMove) {

   242      *

   263      *

   243      * @param x coordinate.

   264      * @param x coordinate.

   244      * @param y coordinate.

   265      * @param y coordinate.

   245      * @return Item.

   266      * @return Item.

   246      */

   267      */

   248         Row itemRow;

   270         Row itemRow;

   250             itemRow = getRow(i);

   273             itemRow = getRow(i);

   252                 LayoutObject lo;

   276                 LayoutObject lo;

   254                     lo = itemRow.getLayoutObject(j);

   279                     lo = itemRow.getLayoutObject(j);

   256                         Logger.info("Item under mouse: "

   282                         Logger.info("Item under mouse: "

   258                         currentlyUnderMouse = lo;

   284                         currentlyUnderMouse = lo;

   259                         return lo.getOwningItem();

   285                         return lo.getOwningItem();

   260                     }

   286                     }

   261                 }

   287                 }

   262                 break;

   288                 break;

   266     }

   292     }

   267 

   293 

   268     /* (non-Javadoc)

   294     /* (non-Javadoc)

   269      * @see DefaultFormLayoutPolicy#eswtHandleVisibilityChanges()

   295      * @see DefaultFormLayoutPolicy#eswtHandleVisibilityChanges()

   270      */

   296      */

   272         super.eswtHandleVisibilityChanges();

   299         super.eswtHandleVisibilityChanges();

   273         eswtCheckCurrentSelectedItem();

   300         eswtCheckCurrentSelectedItem();

   274     }

   301     }

   275 

   302 

   276     /**

   303     /**

   280      * @param dir Search direction, one of the arrow key constants defined

   307      * @param dir Search direction, one of the arrow key constants defined

   281      *      in class SWT.

   308      *      in class SWT.

   282      *

   309      *

   283      * @return Nearest focusable item or null if no item found.

   310      * @return Nearest focusable item or null if no item found.

   284      */

   311      */

   286         Item nextItem = fromItem;

   314         Item nextItem = fromItem;

   287 

   315 

   296                         nextItem = owner;

   368                         nextItem = owner;

   298                     }

   369                     }

   299                 }

   370                 }

   310                         nextItem = owner;

   391                         nextItem = owner;

   312                     }

   392                     }

   313                 }

   393                 }

   356         }

   399         }

   357 

   400 

   358         return nextItem;

   401         return nextItem;

   359     }

   402     }

   360 

   403 

   361     /**

   404     /**

   362      * Check if the currentSelectedItem is valid and visible. If not then it

   405      * Check if the currentSelectedItem is valid and visible. If not then it

   363      * sets it to null.

   406      * sets it to null.

   364      */

   407      */

   369                 // we need to find another

   415                 // we need to find another

   370                 Logger.method(this, "eswtCheckCurrentSelectedItem");

   416                 Logger.method(this, "eswtCheckCurrentSelectedItem");

   371                 eswtSetCurrentSelectedItem(null, NO_DIRECTION);

   417                 eswtSetCurrentSelectedItem(null, NO_DIRECTION);

   372             }

   418             }

   373         }

   419         }

   379      * removes focus from old item and then moves focus to new one.

   425      * removes focus from old item and then moves focus to new one.

   380      *

   426      *

   381      * @param item Item to set as current selected. If null, nothing happens.

   427      * @param item Item to set as current selected. If null, nothing happens.

   382      * @param dir Direction which is delivered to layouter.

   428      * @param dir Direction which is delivered to layouter.

   383      */

   429      */

   386             Logger.info(this + "::SelectedItem: "

   434             Logger.info(this + "::SelectedItem: "

   388 

   436 

   389             // Save direction

   437             // Save direction

   390             direction = dir;

   438             direction = dir;

   391             // Remove focus from currentSelectedItem and notify its Layouter.

   439             // Remove focus from currentSelectedItem and notify its Layouter.

   393                 getLayouter(currentSelectedItem).eswtFocusLost(

   442                 getLayouter(currentSelectedItem).eswtFocusLost(

   395             }

   444             }

   396 

   445 

   397             // Set new currentSelectedItem, must be focusable or null

   446             // Set new currentSelectedItem, must be focusable or null

   398             currentSelectedItem = item;

   447             currentSelectedItem = item;

   399 

   448 

   400             // Set focus to currentSelectedItem and notify its Layouter.

   449             // Set focus to currentSelectedItem and notify its Layouter.

   402                 getLayouter(currentSelectedItem).eswtFocusGained(

   452                 getLayouter(currentSelectedItem).eswtFocusGained(

   404             }

   454             }

   405 

   455 

   406             // Apply eSWT focus to currentSelectedItem's control

   456             // Apply eSWT focus to currentSelectedItem's control

   407             eswtApplyCurrentFocus();

   457             eswtApplyCurrentFocus();

   408         }

   458         }

   414      * removes focus from old item and then moves focus to new one.

   464      * removes focus from old item and then moves focus to new one.

   415      *

   465      *

   416      * @param item Item to set as current selected. If null, nothing happens.

   466      * @param item Item to set as current selected. If null, nothing happens.

   417      * @param dir Direction which is delivered to layouter.

   467      * @param dir Direction which is delivered to layouter.

   418      */

   468      */

   421             Logger.info(this + "::SelectedItem: "

   473             Logger.info(this + "::SelectedItem: "

   423 

   475 

   424             // Remove focus from currentSelectedItem and notify its Layouter.

   476             // Remove focus from currentSelectedItem and notify its Layouter.

   426                 getLayouter(currentSelectedItem).eswtFocusLost(

   479                 getLayouter(currentSelectedItem).eswtFocusLost(

   428             }

   481             }

   429 

   482 

   430             // Set new currentSelectedItem, must be focusable or null

   483             // Set new currentSelectedItem, must be focusable or null

   431             currentSelectedItem = item;

   484             currentSelectedItem = item;

   432 

   485 

   433             // Set focus to currentSelectedItem and notify its Layouter.

   486             // Set focus to currentSelectedItem and notify its Layouter.

   435                 getLayouter(currentSelectedItem).eswtFocusGained(

   489                 getLayouter(currentSelectedItem).eswtFocusGained(

   437             }

   491             }

   438 

   492 

   439             // Apply eSWT focus to currentSelectedItem's control

   493             // Apply eSWT focus to currentSelectedItem's control

   440             //eswtApplyCurrentFocus();

   494             //eswtApplyCurrentFocus();

   441         }

   495         }

   449      * update and layouter notifications are handled in method

   503      * update and layouter notifications are handled in method

   450      * <code>eswtSetCurrentSelectedItem()</code>.<br>

   504      * <code>eswtSetCurrentSelectedItem()</code>.<br>

   451      * If currentSelectedItem is null or form is not shown, this method has no

   505      * If currentSelectedItem is null or form is not shown, this method has no

   452      * effect.

   506      * effect.

   453      */

   507      */

   456             // if any of the Item's LayoutObjects is visible

   512             // if any of the Item's LayoutObjects is visible

   458                 Logger.method(this, "ApplyFocus", currentSelectedItem);

   515                 Logger.method(this, "ApplyFocus", currentSelectedItem);

   459                 eswtSetFocusToFirstControl(currentSelectedItem);

   516                 eswtSetFocusToFirstControl(currentSelectedItem);

   460             }

   517             }

   462                 Logger.method(this, "ApplyFocus", "dummy");

   520                 Logger.method(this, "ApplyFocus", "dummy");

   463                 formComposite.forceFocus();

   521                 formComposite.forceFocus();

   464             }

   522             }

   465         }

   523         }

   466     }

   524     }

   469      * If the Item is valid and it is layouted, then sets the Item's first

   527      * If the Item is valid and it is layouted, then sets the Item's first

   470      * LayoutObject focused.

   528      * LayoutObject focused.

   471      *

   529      *

   472      * @param item an item which first LayoutObject is set focused.

   530      * @param item an item which first LayoutObject is set focused.

   473      */

   531      */

   476             LayoutObject lo = getFirstLayoutObjectOfItem(item);

   536             LayoutObject lo = getFirstLayoutObjectOfItem(item);

   478                 lo.getControl().forceFocus();

   539                 lo.getControl().forceFocus();

   479             }

   540             }

   480         }

   541         }

   481     }

   542     }

   482 

   543 

   483     /**

   544     /**

   484      * Gets Current selected item.

   545      * Gets Current selected item.

   485      *

   546      *

   486      * @return Current selected item. May also return null.

   547      * @return Current selected item. May also return null.

   487      */

   548      */

   489         return currentSelectedItem;

   551         return currentSelectedItem;

   490     }

   552     }

   491 

   553 

   492     /**

   554     /**

   493      * Get the direction of scrolling.

   555      * Get the direction of scrolling.

   494      *

   556      *

   495      * @return direction of scrolling.

   557      * @return direction of scrolling.

   496      */

   558      */

   498         return direction;

   561         return direction;

   499     }

   562     }

   500 

   563 

   501     /* (non-Javadoc)

   564     /* (non-Javadoc)

   502      * @see DefaultFormLayoutPolicy#eswtResizeItemAndShift(Item)

   565      * @see DefaultFormLayoutPolicy#eswtResizeItemAndShift(Item)

   503      */

   566      */

   505         // save the state of the last row before resizing and Shifting.

   569         // save the state of the last row before resizing and Shifting.

   506         boolean itemWasVisible = isItemPartiallyVisible(item);

   570         boolean itemWasVisible = isItemPartiallyVisible(item);

   507 

   571 

   508         int newVPosition = super.eswtResizeItemAndShift(item);

   572         int newVPosition = super.eswtResizeItemAndShift(item);

   509 

   573 

   512                 int itemTop = getItemTopPosition(item);

   578                 int itemTop = getItemTopPosition(item);

   513                 int itemBottom = getItemBottomPosition(item);

   579                 int itemBottom = getItemBottomPosition(item);

   514                 // currentSelectedItem has to be focused if it was focused

   580                 // currentSelectedItem has to be focused if it was focused

   515                 // before resizing e.g TextField when it is resized by adding a

   581                 // before resizing e.g TextField when it is resized by adding a

   516                 // new row and it was in the bottom of the Screen.

   582                 // new row and it was in the bottom of the Screen.

   519                     // do not change vPosition;

   586                     // do not change vPosition;

   520                 }

   587                 }

   522                     newVPosition = itemTop;

   590                     newVPosition = itemTop;

   523                 }

   591                 }

   525                     newVPosition = itemBottom - getFormHeight();

   594                     newVPosition = itemBottom - getFormHeight();

   526                 }

   595                 }

   527             }

   596             }

   528         }

   597         }

   529         return newVPosition;

   598         return newVPosition;

   533     private EventGeneratorTask eventTask;

   602     private EventGeneratorTask eventTask;

   534 

   603 

   535     /**

   604     /**

   536      * Reset timer for do layout with a given start index.

   605      * Reset timer for do layout with a given start index.

   537      */

   606      */

   541                 eventTask.cancel();

   613                 eventTask.cancel();

   542                 eventTask = null;

   614                 eventTask = null;

   543             }

   615             }

   544             // schedule new timer

   616             // schedule new timer

   545             eventTask = new EventGeneratorTask(directionUp, y);

   617             eventTask = new EventGeneratorTask(directionUp, y);

   548     }

   620     }

   549 

   621 

   550     /**

   622     /**

   551      * Form Timer task. Triggers the formComposite to Layout.

   623      * Form Timer task. Triggers the formComposite to Layout.

   552      */

   624      */

   554 

   627 

   555         private boolean isUpDirection;

   628         private boolean isUpDirection;

   556         private int localY;

   629         private int localY;

   557 

   630 

   559             isUpDirection = direction;

   633             isUpDirection = direction;

   560             localY = y;

   634             localY = y;

   561             Logger.info("y is " + localY);

   635             Logger.info("y is " + localY);

   562         }

   636         }

   563 

   637 

   566                 localY -= Config.DFI_EVENT_MOVE_DELTA;

   642                 localY -= Config.DFI_EVENT_MOVE_DELTA;

   567             }

   643             }

   569                 localY += Config.DFI_EVENT_MOVE_DELTA;

   646                 localY += Config.DFI_EVENT_MOVE_DELTA;

   570             }

   647             }

   571             handlePointerEvent(0, localY, SWT.MouseMove);

   648             handlePointerEvent(0, localY, SWT.MouseMove);

   572         }

   649         }

   573     }

   650     }