dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "keyboard-focus-manager-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/actors/actor-devel.h>
  23 #include <dali/devel-api/adaptor-framework/lifecycle-controller.h>
  24 #include <dali/devel-api/common/singleton-service.h>
  25 #include <dali/integration-api/adaptor-framework/adaptor.h>
  26 #include <dali/integration-api/adaptor-framework/scene-holder.h>
  27 #include <dali/integration-api/debug.h>
  28 #include <dali/public-api/actors/layer.h>
  29 #include <dali/public-api/animation/constraints.h>
  30 #include <dali/public-api/events/key-event.h>
  31 #include <dali/public-api/events/touch-event.h>
  32 #include <dali/public-api/events/wheel-event.h>
  33 #include <dali/public-api/object/property-map.h>
  34 #include <dali/public-api/object/type-registry-helper.h>
  35 #include <dali/public-api/object/type-registry.h>
  36 #include <cstring> // for strcmp
  37
  38 // INTERNAL INCLUDES
  39 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  40 #include <dali-toolkit/devel-api/controls/control-devel.h>
  41 #include <dali-toolkit/devel-api/focus-manager/focus-finder.h>
  42 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  43 #include <dali-toolkit/public-api/controls/control-impl.h>
  44 #include <dali-toolkit/public-api/controls/control.h>
  45 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  46 #include <dali-toolkit/public-api/styling/style-manager.h>
  47 #include <dali/devel-api/adaptor-framework/accessibility.h>
  48
  49 namespace Dali
  50 {
  51 namespace Toolkit
  52 {
  53 namespace Internal
  54 {
  55 namespace // Unnamed namespace
  56 {
  57 #if defined(DEBUG_ENABLED)
  58 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_KEYBOARD_FOCUS_MANAGER");
  59 #endif
  60
  61 const char* const IS_FOCUS_GROUP_PROPERTY_NAME = "isKeyboardFocusGroup"; // This property will be replaced by a flag in Control.
  62
  63 const char* const FOCUS_BORDER_IMAGE_FILE_NAME = "keyboard_focus.9.png";
  64
  65 BaseHandle Create()
  66 {
  67   BaseHandle handle = KeyboardFocusManager::Get();
  68
  69   if(!handle)
  70   {
  71     SingletonService singletonService(SingletonService::Get());
  72     if(singletonService)
  73     {
  74       Toolkit::KeyboardFocusManager manager = Toolkit::KeyboardFocusManager(new Internal::KeyboardFocusManager());
  75       singletonService.Register(typeid(manager), manager);
  76       handle = manager;
  77     }
  78   }
  79
  80   return handle;
  81 }
  82
  83 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::KeyboardFocusManager, Dali::BaseHandle, Create, true)
  84
  85 DALI_SIGNAL_REGISTRATION(Toolkit, KeyboardFocusManager, "keyboardPreFocusChange", SIGNAL_PRE_FOCUS_CHANGE)
  86 DALI_SIGNAL_REGISTRATION(Toolkit, KeyboardFocusManager, "keyboardFocusChanged", SIGNAL_FOCUS_CHANGED)
  87 DALI_SIGNAL_REGISTRATION(Toolkit, KeyboardFocusManager, "keyboardFocusGroupChanged", SIGNAL_FOCUS_GROUP_CHANGED)
  88 DALI_SIGNAL_REGISTRATION(Toolkit, KeyboardFocusManager, "keyboardFocusedActorEnterKey", SIGNAL_FOCUSED_ACTOR_ENTER_KEY)
  89
  90 DALI_TYPE_REGISTRATION_END()
  91
  92 const unsigned int MAX_HISTORY_AMOUNT = 30; ///< Max length of focus history stack
  93
  94 } // unnamed namespace
  95
  96 Toolkit::KeyboardFocusManager KeyboardFocusManager::Get()
  97 {
  98   Toolkit::KeyboardFocusManager manager;
  99
 100   SingletonService singletonService(SingletonService::Get());
 101   if(singletonService)
 102   {
 103     // Check whether the keyboard focus manager is already created
 104     Dali::BaseHandle handle = singletonService.GetSingleton(typeid(Toolkit::KeyboardFocusManager));
 105     if(handle)
 106     {
 107       // If so, downcast the handle of singleton to keyboard focus manager
 108       manager = Toolkit::KeyboardFocusManager(dynamic_cast<KeyboardFocusManager*>(handle.GetObjectPtr()));
 109     }
 110   }
 111
 112   return manager;
 113 }
 114
 115 KeyboardFocusManager::KeyboardFocusManager()
 116 : mPreFocusChangeSignal(),
 117   mFocusChangedSignal(),
 118   mFocusGroupChangedSignal(),
 119   mFocusedActorEnterKeySignal(),
 120   mCurrentFocusActor(),
 121   mFocusIndicatorActor(),
 122   mFocusFinderRootActor(),
 123   mFocusHistory(),
 124   mSlotDelegate(this),
 125   mCustomAlgorithmInterface(NULL),
 126   mCurrentFocusedWindow(),
 127   mIsFocusIndicatorShown(UNKNOWN),
 128   mEnableFocusIndicator(ENABLE),
 129   mAlwaysShowIndicator(ALWAYS_SHOW),
 130   mFocusGroupLoopEnabled(false),
 131   mIsWaitingKeyboardFocusChangeCommit(false),
 132   mClearFocusOnTouch(true),
 133   mEnableDefaultAlgorithm(false)
 134 {
 135   // TODO: Get FocusIndicatorEnable constant from stylesheet to set mIsFocusIndicatorShown.
 136
 137   LifecycleController::Get().InitSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnAdaptorInit);
 138 }
 139
 140 void KeyboardFocusManager::OnAdaptorInit()
 141 {
 142   if(Adaptor::IsAvailable())
 143   {
 144     // Retrieve all the existing scene holders
 145     Dali::SceneHolderList sceneHolders = Adaptor::Get().GetSceneHolders();
 146     for(auto iter = sceneHolders.begin(); iter != sceneHolders.end(); ++iter)
 147     {
 148       (*iter).KeyEventSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnKeyEvent);
 149       (*iter).TouchedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnTouch);
 150       (*iter).WheelEventGeneratedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnCustomWheelEvent);
 151       (*iter).WheelEventSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWheelEvent);
 152       Window window = Window::DownCast(*iter);
 153       if(window)
 154       {
 155         window.FocusChangeSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
 156       }
 157     }
 158
 159     // Get notified when any new scene holder is created afterwards
 160     Adaptor::Get().WindowCreatedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnSceneHolderCreated);
 161   }
 162 }
 163
 164 void KeyboardFocusManager::OnSceneHolderCreated(Dali::Integration::SceneHolder& sceneHolder)
 165 {
 166   sceneHolder.KeyEventSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnKeyEvent);
 167   sceneHolder.TouchedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnTouch);
 168   sceneHolder.WheelEventGeneratedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnCustomWheelEvent);
 169   sceneHolder.WheelEventSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWheelEvent);
 170   Window window = Window::DownCast(sceneHolder);
 171   if(window)
 172   {
 173     window.FocusChangeSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
 174   }
 175 }
 176
 177 KeyboardFocusManager::~KeyboardFocusManager()
 178 {
 179 }
 180
 181 void KeyboardFocusManager::GetConfigurationFromStyleManger()
 182 {
 183   Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 184   if(styleManager)
 185   {
 186     const auto alwaysShowFocusValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("alwaysShowFocus", Property::Type::BOOLEAN);
 187
 188     mAlwaysShowIndicator   = (alwaysShowFocusValue && alwaysShowFocusValue->Get<bool>()) ? ALWAYS_SHOW : NONE;
 189     mIsFocusIndicatorShown = (mAlwaysShowIndicator == ALWAYS_SHOW) ? SHOW : HIDE;
 190     mClearFocusOnTouch     = (mIsFocusIndicatorShown == SHOW) ? false : true;
 191   }
 192 }
 193
 194 bool KeyboardFocusManager::SetCurrentFocusActor(Actor actor)
 195 {
 196   DALI_ASSERT_DEBUG(!mIsWaitingKeyboardFocusChangeCommit && "Calling this function in the PreFocusChangeSignal callback?");
 197
 198   if(mIsFocusIndicatorShown == UNKNOWN)
 199   {
 200     GetConfigurationFromStyleManger();
 201   }
 202
 203   return DoSetCurrentFocusActor(actor);
 204 }
 205
 206 bool KeyboardFocusManager::DoSetCurrentFocusActor(Actor actor)
 207 {
 208   bool success = false;
 209
 210   // Check whether the actor is in the stage and is keyboard focusable.
 211   if(actor &&
 212      actor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) &&
 213      actor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED) &&
 214      actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
 215   {
 216     // If the parent's KEYBOARD_FOCUSABLE_CHILDREN is false, it cannot have focus.
 217     Actor parent = actor.GetParent();
 218     while(parent)
 219     {
 220       if(!parent.GetProperty<bool>(DevelActor::Property::KEYBOARD_FOCUSABLE_CHILDREN))
 221       {
 222         DALI_LOG_DEBUG_INFO("Parent Actor has KEYBOARD_FOCUSABLE_CHILDREN false\n");
 223         return false;
 224       }
 225       parent = parent.GetParent();
 226     }
 227
 228     // If developer set focus on same actor, doing nothing
 229     Actor currentFocusedActor = GetCurrentFocusActor();
 230     DALI_LOG_DEBUG_INFO("current focused actor : [%p] new focused actor : [%p]\n", currentFocusedActor.GetObjectPtr(), actor.GetObjectPtr());
 231     if(actor == currentFocusedActor)
 232     {
 233       return true;
 234     }
 235
 236     Integration::SceneHolder currentWindow = Integration::SceneHolder::Get(actor);
 237     if(currentWindow.GetRootLayer() != mCurrentFocusedWindow.GetHandle())
 238     {
 239       Layer rootLayer       = currentWindow.GetRootLayer();
 240       mCurrentFocusedWindow = rootLayer;
 241     }
 242
 243     if((mIsFocusIndicatorShown == SHOW) && (mEnableFocusIndicator == ENABLE))
 244     {
 245       actor.Add(GetFocusIndicatorActor());
 246     }
 247
 248     // Save the current focused actor
 249     mCurrentFocusActor = actor;
 250
 251     bool focusedWindowFound = false;
 252     for(unsigned int i = 0; i < mCurrentFocusActors.size(); i++)
 253     {
 254       if(mCurrentFocusActors[i].first == mCurrentFocusedWindow)
 255       {
 256         mCurrentFocusActors[i].second = actor;
 257         focusedWindowFound            = true;
 258         break;
 259       }
 260     }
 261     if(!focusedWindowFound)
 262     {
 263       // A new window gains the focus, so store the focused actor in that window.
 264       mCurrentFocusActors.push_back(std::pair<WeakHandle<Layer>, WeakHandle<Actor> >(mCurrentFocusedWindow, actor));
 265     }
 266
 267     // Send notification for the change of focus actor
 268     if(!mFocusChangedSignal.Empty())
 269     {
 270       mFocusChangedSignal.Emit(currentFocusedActor, actor);
 271     }
 272
 273     Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(currentFocusedActor);
 274     if(currentlyFocusedControl)
 275     {
 276       // Do we need it to remember if it was previously DISABLED?
 277       currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL);
 278       currentlyFocusedControl.ClearKeyInputFocus();
 279     }
 280
 281     Toolkit::Control newlyFocusedControl = Toolkit::Control::DownCast(actor);
 282     if(newlyFocusedControl)
 283     {
 284       newlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::FOCUSED);
 285       newlyFocusedControl.SetKeyInputFocus();
 286     }
 287
 288     // Push Current Focused Actor to FocusHistory
 289     mFocusHistory.push_back(actor);
 290
 291     // Delete first element before add new element when Stack is full.
 292     if(mFocusHistory.size() > MAX_HISTORY_AMOUNT)
 293     {
 294       FocusStackIterator beginPos = mFocusHistory.begin();
 295       mFocusHistory.erase(beginPos);
 296     }
 297
 298     DALI_LOG_INFO(gLogFilter, Debug::General, "[%s:%d] SUCCEED\n", __FUNCTION__, __LINE__);
 299     success = true;
 300   }
 301   else
 302   {
 303     DALI_LOG_WARNING("[%s:%d] FAILED\n", __FUNCTION__, __LINE__);
 304   }
 305
 306   return success;
 307 }
 308
 309 Actor KeyboardFocusManager::GetCurrentFocusActor()
 310 {
 311   Actor actor = mCurrentFocusActor.GetHandle();
 312
 313   if(actor && !actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
 314   {
 315     // If the actor has been removed from the stage, then it should not be focused
 316     actor.Reset();
 317     mCurrentFocusActor.Reset();
 318   }
 319   return actor;
 320 }
 321
 322 Actor KeyboardFocusManager::GetFocusActorFromCurrentWindow()
 323 {
 324   Actor        actor;
 325   unsigned int index;
 326   for(index = 0; index < mCurrentFocusActors.size(); index++)
 327   {
 328     if(mCurrentFocusActors[index].first == mCurrentFocusedWindow)
 329     {
 330       actor = mCurrentFocusActors[index].second.GetHandle();
 331       break;
 332     }
 333   }
 334
 335   if(actor && !actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
 336   {
 337     // If the actor has been removed from the window, then the window doesn't have any focused actor
 338     actor.Reset();
 339     mCurrentFocusActors.erase(mCurrentFocusActors.begin() + index);
 340   }
 341
 342   return actor;
 343 }
 344
 345 Actor KeyboardFocusManager::GetCurrentFocusGroup()
 346 {
 347   return GetFocusGroup(GetCurrentFocusActor());
 348 }
 349
 350 void KeyboardFocusManager::MoveFocusBackward()
 351 {
 352   // Find Pre Focused Actor when the list size is more than 1
 353   if(mFocusHistory.size() > 1)
 354   {
 355     // Delete current focused actor in history
 356     mFocusHistory.pop_back();
 357
 358     // If pre-focused actors are not on stage or deleted, remove them in stack
 359     while(mFocusHistory.size() > 0)
 360     {
 361       // Get pre focused actor
 362       Actor target = mFocusHistory[mFocusHistory.size() - 1].GetHandle();
 363
 364       // Impl of Actor is not null
 365       if(target && target.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
 366       {
 367         // Delete pre focused actor in history because it will pushed again by SetCurrentFocusActor()
 368         mFocusHistory.pop_back();
 369         SetCurrentFocusActor(target);
 370         break;
 371       }
 372       else
 373       {
 374         // Target is empty handle or off stage. Erase from queue
 375         mFocusHistory.pop_back();
 376       }
 377     }
 378
 379     // if there is no actor which can get focus, then push current focus actor in stack again
 380     if(mFocusHistory.size() == 0)
 381     {
 382       Actor currentFocusedActor = GetCurrentFocusActor();
 383       mFocusHistory.push_back(currentFocusedActor);
 384     }
 385   }
 386 }
 387
 388 bool KeyboardFocusManager::IsLayoutControl(Actor actor) const
 389 {
 390   Toolkit::Control control = Toolkit::Control::DownCast(actor);
 391   return control && GetImplementation(control).IsKeyboardNavigationSupported();
 392 }
 393
 394 Toolkit::Control KeyboardFocusManager::GetParentLayoutControl(Actor actor) const
 395 {
 396   // Get the actor's parent layout control that supports two dimensional keyboard navigation
 397   Actor rootActor;
 398   Actor parent;
 399   if(actor)
 400   {
 401     Integration::SceneHolder window = Integration::SceneHolder::Get(actor);
 402     if(window)
 403     {
 404       rootActor = window.GetRootLayer();
 405     }
 406
 407     parent = actor.GetParent();
 408   }
 409
 410   while(parent && !IsLayoutControl(parent) && parent != rootActor)
 411   {
 412     parent = parent.GetParent();
 413   }
 414
 415   return Toolkit::Control::DownCast(parent);
 416 }
 417
 418 bool KeyboardFocusManager::MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction, const std::string& deviceName)
 419 {
 420   Actor currentFocusActor = GetCurrentFocusActor();
 421
 422   bool succeed = false;
 423
 424   // Go through the actor's hierarchy until we find a layout control that knows how to move the focus
 425   Toolkit::Control layoutControl = IsLayoutControl(currentFocusActor) ? Toolkit::Control::DownCast(currentFocusActor) : GetParentLayoutControl(currentFocusActor);
 426   while(layoutControl && !succeed)
 427   {
 428     succeed       = DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
 429     layoutControl = GetParentLayoutControl(layoutControl);
 430   }
 431
 432   if(!succeed)
 433   {
 434     Actor nextFocusableActor;
 435
 436     Toolkit::Control currentFocusControl = Toolkit::Control::DownCast(currentFocusActor);
 437
 438     // If the current focused actor is a control, then find the next focusable actor via the focusable properties.
 439     if(currentFocusControl)
 440     {
 441       int             actorId = -1;
 442       Property::Index index   = Property::INVALID_INDEX;
 443       Property::Value value;
 444
 445       // Find property index based upon focus direction
 446       switch(direction)
 447       {
 448         case Toolkit::Control::KeyboardFocus::LEFT:
 449         {
 450           index = Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID;
 451           break;
 452         }
 453         case Toolkit::Control::KeyboardFocus::RIGHT:
 454         {
 455           index = Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID;
 456           break;
 457         }
 458         case Toolkit::Control::KeyboardFocus::UP:
 459         {
 460           index = Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID;
 461           break;
 462         }
 463         case Toolkit::Control::KeyboardFocus::DOWN:
 464         {
 465           index = Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID;
 466           break;
 467         }
 468         case Toolkit::Control::KeyboardFocus::CLOCKWISE:
 469         {
 470           index = Toolkit::DevelControl::Property::CLOCKWISE_FOCUSABLE_ACTOR_ID;
 471           break;
 472         }
 473         case Toolkit::Control::KeyboardFocus::COUNTER_CLOCKWISE:
 474         {
 475           index = Toolkit::DevelControl::Property::COUNTER_CLOCKWISE_FOCUSABLE_ACTOR_ID;
 476           break;
 477         }
 478         default:
 479           break;
 480       }
 481
 482       // If the focusable property is set then determine next focusable actor
 483       if(index != Property::INVALID_INDEX)
 484       {
 485         value   = currentFocusActor.GetProperty(index);
 486         actorId = value.Get<int>();
 487
 488         // If actor's id is valid then find actor form actor's id. The actor should be on the stage.
 489         if(actorId != -1)
 490         {
 491           if(currentFocusActor.GetParent())
 492           {
 493             nextFocusableActor = currentFocusActor.GetParent().FindChildById(actorId);
 494           }
 495
 496           if(!nextFocusableActor)
 497           {
 498             Integration::SceneHolder window = Integration::SceneHolder::Get(currentFocusActor);
 499             if(window)
 500             {
 501               nextFocusableActor = window.GetRootLayer().FindChildById(actorId);
 502             }
 503           }
 504         }
 505       }
 506     }
 507
 508     if(!nextFocusableActor)
 509     {
 510       // If the implementation of CustomAlgorithmInterface is provided then the PreFocusChangeSignal is no longer emitted.
 511       if(mCustomAlgorithmInterface)
 512       {
 513         mIsWaitingKeyboardFocusChangeCommit = true;
 514         nextFocusableActor                  = mCustomAlgorithmInterface->GetNextFocusableActor(currentFocusActor, Actor(), direction, deviceName);
 515         mIsWaitingKeyboardFocusChangeCommit = false;
 516       }
 517       else if(!mPreFocusChangeSignal.Empty())
 518       {
 519         // Don't know how to move the focus further. The application needs to tell us which actor to move the focus to
 520         mIsWaitingKeyboardFocusChangeCommit = true;
 521         nextFocusableActor                  = mPreFocusChangeSignal.Emit(currentFocusActor, Actor(), direction);
 522         mIsWaitingKeyboardFocusChangeCommit = false;
 523       }
 524       else if(mEnableDefaultAlgorithm)
 525       {
 526         Actor rootActor = mFocusFinderRootActor.GetHandle();
 527         if(!rootActor)
 528         {
 529           if(currentFocusActor)
 530           {
 531             // Find the window of the focused actor.
 532             Integration::SceneHolder window = Integration::SceneHolder::Get(currentFocusActor);
 533             if(window)
 534             {
 535               rootActor = window.GetRootLayer();
 536             }
 537           }
 538           else
 539           {
 540             // Searches from the currently focused window.
 541             rootActor = mCurrentFocusedWindow.GetHandle();
 542           }
 543         }
 544         if(rootActor)
 545         {
 546           // We should find it among the actors nearby.
 547           nextFocusableActor = Toolkit::FocusFinder::GetNearestFocusableActor(rootActor, currentFocusActor, direction);
 548         }
 549       }
 550     }
 551
 552     if(nextFocusableActor && nextFocusableActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && nextFocusableActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED))
 553     {
 554       // Whether the next focusable actor is a layout control
 555       if(IsLayoutControl(nextFocusableActor))
 556       {
 557         // If so, move the focus inside it.
 558         Toolkit::Control layoutControl = Toolkit::Control::DownCast(nextFocusableActor);
 559         succeed                        = DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
 560       }
 561       if(!succeed)
 562       {
 563         // Just set focus to the next focusable actor
 564         succeed = SetCurrentFocusActor(nextFocusableActor);
 565       }
 566     }
 567   }
 568
 569   return succeed;
 570 }
 571
 572 bool KeyboardFocusManager::DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction)
 573 {
 574   // Ask the control for the next actor to focus
 575   Actor nextFocusableActor = GetImplementation(control).GetNextKeyboardFocusableActor(actor, direction, mFocusGroupLoopEnabled);
 576   if(nextFocusableActor)
 577   {
 578     if(!(nextFocusableActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) || nextFocusableActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED)))
 579     {
 580       // If the actor is not focusable, ask the same layout control for the next actor to focus
 581       return DoMoveFocusWithinLayoutControl(control, nextFocusableActor, direction);
 582     }
 583     else
 584     {
 585       Actor currentFocusActor   = GetCurrentFocusActor();
 586       Actor committedFocusActor = nextFocusableActor;
 587
 588       // We will try to move the focus to the actor. Emit a signal to notify the proposed actor to focus
 589       // Signal handler can check the proposed actor and return a different actor if it wishes.
 590       if(!mPreFocusChangeSignal.Empty())
 591       {
 592         mIsWaitingKeyboardFocusChangeCommit = true;
 593         committedFocusActor                 = mPreFocusChangeSignal.Emit(currentFocusActor, nextFocusableActor, direction);
 594         mIsWaitingKeyboardFocusChangeCommit = false;
 595       }
 596
 597       if(committedFocusActor && committedFocusActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && committedFocusActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED))
 598       {
 599         // Whether the commited focusable actor is a layout control
 600         if(IsLayoutControl(committedFocusActor) && committedFocusActor != control)
 601         {
 602           // If so, move the focus inside it.
 603           Toolkit::Control layoutControl = Toolkit::Control::DownCast(committedFocusActor);
 604           return DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
 605         }
 606         else
 607         {
 608           // Otherwise, just set focus to the next focusable actor
 609           if(committedFocusActor == nextFocusableActor)
 610           {
 611             // If the application hasn't changed our proposed actor, we informs the layout control we will
 612             // move the focus to what the control returns. The control might wish to perform some actions
 613             // before the focus is actually moved.
 614             GetImplementation(control).OnKeyboardFocusChangeCommitted(committedFocusActor);
 615           }
 616
 617           return SetCurrentFocusActor(committedFocusActor);
 618         }
 619       }
 620       else
 621       {
 622         return false;
 623       }
 624     }
 625   }
 626   else
 627   {
 628     // No more actor can be focused in the given direction within the same layout control.
 629     return false;
 630   }
 631 }
 632
 633 bool KeyboardFocusManager::DoMoveFocusToNextFocusGroup(bool forward)
 634 {
 635   bool succeed = false;
 636
 637   // Get the parent layout control of the current focus group
 638   Toolkit::Control parentLayoutControl = GetParentLayoutControl(GetCurrentFocusGroup());
 639
 640   while(parentLayoutControl && !succeed)
 641   {
 642     // If the current focus group has a parent layout control, we can probably automatically
 643     // move the focus to the next focus group in the forward or backward direction.
 644     Toolkit::Control::KeyboardFocus::Direction direction = forward ? Toolkit::Control::KeyboardFocus::RIGHT : Toolkit::Control::KeyboardFocus::LEFT;
 645     succeed                                              = DoMoveFocusWithinLayoutControl(parentLayoutControl, GetCurrentFocusActor(), direction);
 646     parentLayoutControl                                  = GetParentLayoutControl(parentLayoutControl);
 647   }
 648
 649   if(!mFocusGroupChangedSignal.Empty())
 650   {
 651     // Emit a focus group changed signal. The applicaton can move the focus to a new focus group
 652     mFocusGroupChangedSignal.Emit(GetCurrentFocusActor(), forward);
 653   }
 654
 655   return succeed;
 656 }
 657
 658 void KeyboardFocusManager::DoKeyboardEnter(Actor actor)
 659 {
 660   if(actor)
 661   {
 662     Toolkit::Control control = Toolkit::Control::DownCast(actor);
 663     if(control)
 664     {
 665       // Notify the control that enter has been pressed on it.
 666       GetImplementation(control).KeyboardEnter();
 667     }
 668
 669     // Send a notification for the actor.
 670     if(!mFocusedActorEnterKeySignal.Empty())
 671     {
 672       mFocusedActorEnterKeySignal.Emit(actor);
 673     }
 674   }
 675 }
 676
 677 void KeyboardFocusManager::ClearFocus()
 678 {
 679   ClearFocusIndicator();
 680   Actor actor = GetCurrentFocusActor();
 681   if(actor)
 682   {
 683     DALI_LOG_RELEASE_INFO("ClearFocus id:(%d)\n",  actor.GetProperty<int32_t>(Dali::Actor::Property::ID));
 684     // Send notification for the change of focus actor
 685     if(!mFocusChangedSignal.Empty())
 686     {
 687       mFocusChangedSignal.Emit(actor, Actor());
 688     }
 689
 690     Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(actor);
 691     if(currentlyFocusedControl)
 692     {
 693       currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL);
 694       currentlyFocusedControl.ClearKeyInputFocus();
 695     }
 696   }
 697   mCurrentFocusActor.Reset();
 698 }
 699
 700 void KeyboardFocusManager::ClearFocusIndicator()
 701 {
 702   Actor actor = GetCurrentFocusActor();
 703   if(actor)
 704   {
 705     if(mFocusIndicatorActor)
 706     {
 707       actor.Remove(mFocusIndicatorActor);
 708     }
 709   }
 710   mIsFocusIndicatorShown = (mAlwaysShowIndicator == ALWAYS_SHOW) ? SHOW : HIDE;
 711 }
 712
 713 void KeyboardFocusManager::SetFocusGroupLoop(bool enabled)
 714 {
 715   mFocusGroupLoopEnabled = enabled;
 716 }
 717
 718 bool KeyboardFocusManager::GetFocusGroupLoop() const
 719 {
 720   return mFocusGroupLoopEnabled;
 721 }
 722
 723 void KeyboardFocusManager::SetAsFocusGroup(Actor actor, bool isFocusGroup)
 724 {
 725   if(actor)
 726   {
 727     // Create/Set focus group property.
 728     actor.RegisterProperty(IS_FOCUS_GROUP_PROPERTY_NAME, isFocusGroup, Property::READ_WRITE);
 729   }
 730 }
 731
 732 bool KeyboardFocusManager::IsFocusGroup(Actor actor) const
 733 {
 734   // Check whether the actor is a focus group
 735   bool isFocusGroup = false;
 736
 737   if(actor)
 738   {
 739     Property::Index propertyIsFocusGroup = actor.GetPropertyIndex(IS_FOCUS_GROUP_PROPERTY_NAME);
 740     if(propertyIsFocusGroup != Property::INVALID_INDEX)
 741     {
 742       isFocusGroup = actor.GetProperty<bool>(propertyIsFocusGroup);
 743     }
 744   }
 745
 746   return isFocusGroup;
 747 }
 748
 749 Actor KeyboardFocusManager::GetFocusGroup(Actor actor)
 750 {
 751   // Go through the actor's hierarchy to check which focus group the actor belongs to
 752   while(actor && !IsFocusGroup(actor))
 753   {
 754     actor = actor.GetParent();
 755   }
 756
 757   return actor;
 758 }
 759
 760 void KeyboardFocusManager::SetFocusIndicatorActor(Actor indicator)
 761 {
 762   if(mFocusIndicatorActor != indicator)
 763   {
 764     Actor currentFocusActor = GetCurrentFocusActor();
 765     if(currentFocusActor)
 766     {
 767       // The new focus indicator should be added to the current focused actor immediately
 768       if(mFocusIndicatorActor)
 769       {
 770         currentFocusActor.Remove(mFocusIndicatorActor);
 771       }
 772
 773       if(indicator)
 774       {
 775         currentFocusActor.Add(indicator);
 776       }
 777     }
 778
 779     mFocusIndicatorActor = indicator;
 780   }
 781 }
 782
 783 Actor KeyboardFocusManager::GetFocusIndicatorActor()
 784 {
 785   if(!mFocusIndicatorActor)
 786   {
 787     // Create the default if it hasn't been set and one that's shared by all the keyboard focusable actors
 788     const std::string imageDirPath = AssetManager::GetDaliImagePath();
 789     mFocusIndicatorActor           = Toolkit::ImageView::New(imageDirPath + FOCUS_BORDER_IMAGE_FILE_NAME);
 790
 791     // Apply size constraint to the focus indicator
 792     mFocusIndicatorActor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
 793   }
 794
 795   mFocusIndicatorActor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
 796   mFocusIndicatorActor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
 797   mFocusIndicatorActor.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
 798
 799   return mFocusIndicatorActor;
 800 }
 801
 802 void KeyboardFocusManager::OnKeyEvent(const KeyEvent& event)
 803 {
 804   const std::string& keyName    = event.GetKeyName();
 805   const std::string& deviceName = event.GetDeviceName();
 806
 807   if(mIsFocusIndicatorShown == UNKNOWN)
 808   {
 809     GetConfigurationFromStyleManger();
 810   }
 811
 812   bool isFocusStartableKey = false;
 813
 814   if(event.GetState() == KeyEvent::DOWN)
 815   {
 816     if(keyName == "Left")
 817     {
 818       if(mIsFocusIndicatorShown == HIDE)
 819       {
 820         // Show focus indicator
 821         mIsFocusIndicatorShown = SHOW;
 822       }
 823       else
 824       {
 825         // Move the focus towards left
 826         MoveFocus(Toolkit::Control::KeyboardFocus::LEFT, deviceName);
 827       }
 828
 829       isFocusStartableKey = true;
 830     }
 831     else if(keyName == "Right")
 832     {
 833       if(mIsFocusIndicatorShown == HIDE)
 834       {
 835         // Show focus indicator
 836         mIsFocusIndicatorShown = SHOW;
 837       }
 838       else
 839       {
 840         // Move the focus towards right
 841         MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT, deviceName);
 842       }
 843
 844       isFocusStartableKey = true;
 845     }
 846     else if(keyName == "Up")
 847     {
 848       if(mIsFocusIndicatorShown == HIDE)
 849       {
 850         // Show focus indicator
 851         mIsFocusIndicatorShown = SHOW;
 852       }
 853       else
 854       {
 855         // Move the focus towards up
 856         MoveFocus(Toolkit::Control::KeyboardFocus::UP, deviceName);
 857       }
 858
 859       isFocusStartableKey = true;
 860     }
 861     else if(keyName == "Down")
 862     {
 863       if(mIsFocusIndicatorShown == HIDE)
 864       {
 865         // Show focus indicator
 866         mIsFocusIndicatorShown = SHOW;
 867       }
 868       else
 869       {
 870         // Move the focus towards down
 871         MoveFocus(Toolkit::Control::KeyboardFocus::DOWN, deviceName);
 872       }
 873
 874       isFocusStartableKey = true;
 875     }
 876     else if(keyName == "Prior")
 877     {
 878       if(mIsFocusIndicatorShown == HIDE)
 879       {
 880         // Show focus indicator
 881         mIsFocusIndicatorShown = SHOW;
 882       }
 883       else
 884       {
 885         // Move the focus towards the previous page
 886         MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_UP, deviceName);
 887       }
 888
 889       isFocusStartableKey = true;
 890     }
 891     else if(keyName == "Next")
 892     {
 893       if(mIsFocusIndicatorShown == HIDE)
 894       {
 895         // Show focus indicator
 896         mIsFocusIndicatorShown = SHOW;
 897       }
 898       else
 899       {
 900         // Move the focus towards the next page
 901         MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_DOWN, deviceName);
 902       }
 903
 904       isFocusStartableKey = true;
 905     }
 906     else if(keyName == "Tab")
 907     {
 908       if(mIsFocusIndicatorShown == HIDE)
 909       {
 910         // Show focus indicator
 911         mIsFocusIndicatorShown = SHOW;
 912       }
 913       else
 914       {
 915         // "Tab" key changes the focus group in the forward direction and
 916         // "Shift-Tab" key changes it in the backward direction.
 917         if(!DoMoveFocusToNextFocusGroup(!event.IsShiftModifier()))
 918         {
 919           // If the focus group is not changed, Move the focus towards forward, "Shift-Tap" key moves the focus towards backward.
 920           MoveFocus(event.IsShiftModifier() ? Toolkit::Control::KeyboardFocus::BACKWARD : Toolkit::Control::KeyboardFocus::FORWARD, deviceName);
 921         }
 922       }
 923
 924       isFocusStartableKey = true;
 925     }
 926     else if(keyName == "space")
 927     {
 928       if(mIsFocusIndicatorShown == HIDE)
 929       {
 930         // Show focus indicator
 931         mIsFocusIndicatorShown = SHOW;
 932       }
 933
 934       isFocusStartableKey = true;
 935     }
 936     else if(keyName == "")
 937     {
 938       // Check the fake key event for evas-plugin case
 939       if(mIsFocusIndicatorShown == HIDE)
 940       {
 941         // Show focus indicator
 942         mIsFocusIndicatorShown = SHOW;
 943       }
 944
 945       isFocusStartableKey = true;
 946     }
 947     else if(keyName == "Backspace")
 948     {
 949       // Emit signal to go back to the previous view???
 950     }
 951     else if(keyName == "Escape")
 952     {
 953     }
 954   }
 955   else if(event.GetState() == KeyEvent::UP)
 956   {
 957     if(keyName == "Return")
 958     {
 959       if(mIsFocusIndicatorShown == HIDE)
 960       {
 961         // Show focus indicator
 962         mIsFocusIndicatorShown = SHOW;
 963       }
 964       else
 965       {
 966         // The focused actor has enter pressed on it
 967         Actor actor = GetCurrentFocusActor();
 968         if(actor)
 969         {
 970           DoKeyboardEnter(actor);
 971         }
 972       }
 973
 974       isFocusStartableKey = true;
 975     }
 976   }
 977
 978   if(isFocusStartableKey && mIsFocusIndicatorShown == SHOW)
 979   {
 980     Actor actor = GetCurrentFocusActor();
 981     if(actor)
 982     {
 983       if(mEnableFocusIndicator == ENABLE)
 984       {
 985         // Make sure the focused actor is highlighted
 986         actor.Add(GetFocusIndicatorActor());
 987       }
 988     }
 989     else if(!mEnableDefaultAlgorithm)
 990     {
 991       // No actor is focused but keyboard focus is activated by the key press
 992       // Let's try to move the initial focus
 993       MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT, deviceName);
 994     }
 995   }
 996 }
 997
 998 void KeyboardFocusManager::OnTouch(const TouchEvent& touch)
 999 {
1000   // if mIsFocusIndicatorShown is UNKNOWN, it means Configuration is not loaded.
1001   // Try to load configuration.
1002   if(mIsFocusIndicatorShown == UNKNOWN)
1003   {
1004     GetConfigurationFromStyleManger();
1005   }
1006
1007   // Clear the focus when user touch the screen.
1008   // We only do this on a Down event, otherwise the clear action may override a manually focused actor.
1009   if(((touch.GetPointCount() < 1) || (touch.GetState(0) == PointState::DOWN)))
1010   {
1011     // If you touch the currently focused actor again, you don't need to do SetCurrentFocusActor again.
1012     Actor hitActor = touch.GetHitActor(0);
1013     if(hitActor && hitActor == GetCurrentFocusActor())
1014     {
1015       return;
1016     }
1017     // If mClearFocusOnTouch is false, do not clear the focus indicator even if user touch the screen.
1018     if(mClearFocusOnTouch)
1019     {
1020       ClearFocusIndicator();
1021     }
1022
1023     // If KEYBOARD_FOCUSABLE and TOUCH_FOCUSABLE is true, set focus actor
1024     if(hitActor && hitActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && hitActor.GetProperty<bool>(DevelActor::Property::TOUCH_FOCUSABLE))
1025     {
1026       SetCurrentFocusActor(hitActor);
1027     }
1028   }
1029 }
1030
1031 void KeyboardFocusManager::OnWheelEvent(const WheelEvent& event)
1032 {
1033   if(event.GetType() == Dali::WheelEvent::CUSTOM_WHEEL)
1034   {
1035     Toolkit::Control::KeyboardFocus::Direction direction = (event.GetDelta() > 0) ? Toolkit::Control::KeyboardFocus::CLOCKWISE : Toolkit::Control::KeyboardFocus::COUNTER_CLOCKWISE;
1036     // Move the focus
1037     MoveFocus(direction);
1038   }
1039 }
1040
1041 bool KeyboardFocusManager::OnCustomWheelEvent(const WheelEvent& event)
1042 {
1043   bool  consumed = false;
1044   Actor actor    = GetCurrentFocusActor();
1045   if(actor)
1046   {
1047     // Notify the actor about the wheel event
1048     consumed = EmitCustomWheelSignals(actor, event);
1049   }
1050   return consumed;
1051 }
1052
1053 bool KeyboardFocusManager::EmitCustomWheelSignals(Actor actor, const WheelEvent& event)
1054 {
1055   bool consumed = false;
1056
1057   if(actor)
1058   {
1059     Dali::Actor oldParent(actor.GetParent());
1060
1061     // Only do the conversion and emit the signal if the actor's wheel signal has connections.
1062     if(!actor.WheelEventSignal().Empty())
1063     {
1064       // Emit the signal to the parent
1065       consumed = actor.WheelEventSignal().Emit(actor, event);
1066     }
1067     // if actor doesn't consume WheelEvent, give WheelEvent to its parent.
1068     if(!consumed)
1069     {
1070       // The actor may have been removed/reparented during the signal callbacks.
1071       Dali::Actor parent = actor.GetParent();
1072
1073       if(parent &&
1074          (parent == oldParent))
1075       {
1076         consumed = EmitCustomWheelSignals(parent, event);
1077       }
1078     }
1079   }
1080
1081   return consumed;
1082 }
1083
1084 void KeyboardFocusManager::OnWindowFocusChanged(Window window, bool focusIn)
1085 {
1086   if(focusIn && mCurrentFocusedWindow.GetHandle() != window.GetRootLayer())
1087   {
1088     // Change Current Focused Window
1089     Layer rootLayer       = window.GetRootLayer();
1090     mCurrentFocusedWindow = rootLayer;
1091
1092     // Get Current Focused Actor from window
1093     Actor currentFocusedActor = GetFocusActorFromCurrentWindow();
1094     if(currentFocusedActor)
1095     {
1096       SetCurrentFocusActor(currentFocusedActor);
1097
1098       if(mEnableFocusIndicator == ENABLE)
1099       {
1100         // Make sure the focused actor is highlighted
1101         currentFocusedActor.Add(GetFocusIndicatorActor());
1102         mIsFocusIndicatorShown = SHOW;
1103       }
1104     }
1105   }
1106 }
1107
1108 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& KeyboardFocusManager::PreFocusChangeSignal()
1109 {
1110   return mPreFocusChangeSignal;
1111 }
1112
1113 Toolkit::KeyboardFocusManager::FocusChangedSignalType& KeyboardFocusManager::FocusChangedSignal()
1114 {
1115   return mFocusChangedSignal;
1116 }
1117
1118 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& KeyboardFocusManager::FocusGroupChangedSignal()
1119 {
1120   return mFocusGroupChangedSignal;
1121 }
1122
1123 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& KeyboardFocusManager::FocusedActorEnterKeySignal()
1124 {
1125   return mFocusedActorEnterKeySignal;
1126 }
1127
1128 bool KeyboardFocusManager::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
1129 {
1130   Dali::BaseHandle handle(object);
1131
1132   bool                  connected(true);
1133   KeyboardFocusManager* manager = static_cast<KeyboardFocusManager*>(object); // TypeRegistry guarantees that this is the correct type.
1134
1135   if(0 == strcmp(signalName.c_str(), SIGNAL_PRE_FOCUS_CHANGE))
1136   {
1137     manager->PreFocusChangeSignal().Connect(tracker, functor);
1138   }
1139   else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUS_CHANGED))
1140   {
1141     manager->FocusChangedSignal().Connect(tracker, functor);
1142   }
1143   else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUS_GROUP_CHANGED))
1144   {
1145     manager->FocusGroupChangedSignal().Connect(tracker, functor);
1146   }
1147   else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUSED_ACTOR_ENTER_KEY))
1148   {
1149     manager->FocusedActorEnterKeySignal().Connect(tracker, functor);
1150   }
1151   else
1152   {
1153     // signalName does not match any signal
1154     connected = false;
1155   }
1156
1157   return connected;
1158 }
1159
1160 void KeyboardFocusManager::SetCustomAlgorithm(CustomAlgorithmInterface& interface)
1161 {
1162   mCustomAlgorithmInterface = &interface;
1163 }
1164
1165 void KeyboardFocusManager::EnableFocusIndicator(bool enable)
1166 {
1167   if(!enable && mFocusIndicatorActor)
1168   {
1169     mFocusIndicatorActor.Unparent();
1170   }
1171
1172   mEnableFocusIndicator = enable ? ENABLE : DISABLE;
1173 }
1174
1175 bool KeyboardFocusManager::IsFocusIndicatorEnabled() const
1176 {
1177   return (mEnableFocusIndicator == ENABLE);
1178 }
1179
1180 void KeyboardFocusManager::EnableDefaultAlgorithm(bool enable)
1181 {
1182   mEnableDefaultAlgorithm = enable;
1183 }
1184
1185 bool KeyboardFocusManager::IsDefaultAlgorithmEnabled() const
1186 {
1187   return mEnableDefaultAlgorithm;
1188 }
1189
1190 void KeyboardFocusManager::SetFocusFinderRootActor(Actor actor)
1191 {
1192   mFocusFinderRootActor = actor;
1193 }
1194
1195 void KeyboardFocusManager::ResetFocusFinderRootActor()
1196 {
1197   mFocusFinderRootActor.Reset();
1198 }
1199
1200 } // namespace Internal
1201
1202 } // namespace Toolkit
1203
1204 } // namespace Dali