2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "keyboard-focus-manager-impl.h"
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
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>
55 namespace // Unnamed namespace
57 #if defined(DEBUG_ENABLED)
58 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_KEYBOARD_FOCUS_MANAGER");
61 const char* const IS_FOCUS_GROUP_PROPERTY_NAME = "isKeyboardFocusGroup"; // This property will be replaced by a flag in Control.
63 const char* const FOCUS_BORDER_IMAGE_FILE_NAME = "keyboard_focus.9.png";
67 BaseHandle handle = KeyboardFocusManager::Get();
71 SingletonService singletonService(SingletonService::Get());
74 Toolkit::KeyboardFocusManager manager = Toolkit::KeyboardFocusManager(new Internal::KeyboardFocusManager());
75 singletonService.Register(typeid(manager), manager);
83 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::KeyboardFocusManager, Dali::BaseHandle, Create, true)
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)
90 DALI_TYPE_REGISTRATION_END()
92 const unsigned int MAX_HISTORY_AMOUNT = 30; ///< Max length of focus history stack
94 } // unnamed namespace
96 Toolkit::KeyboardFocusManager KeyboardFocusManager::Get()
98 Toolkit::KeyboardFocusManager manager;
100 SingletonService singletonService(SingletonService::Get());
103 // Check whether the keyboard focus manager is already created
104 Dali::BaseHandle handle = singletonService.GetSingleton(typeid(Toolkit::KeyboardFocusManager));
107 // If so, downcast the handle of singleton to keyboard focus manager
108 manager = Toolkit::KeyboardFocusManager(dynamic_cast<KeyboardFocusManager*>(handle.GetObjectPtr()));
115 KeyboardFocusManager::KeyboardFocusManager()
116 : mPreFocusChangeSignal(),
117 mFocusChangedSignal(),
118 mFocusGroupChangedSignal(),
119 mFocusedActorEnterKeySignal(),
120 mCurrentFocusActor(),
121 mFocusIndicatorActor(),
122 mFocusFinderRootActor(),
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)
135 // TODO: Get FocusIndicatorEnable constant from stylesheet to set mIsFocusIndicatorShown.
137 LifecycleController::Get().InitSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnAdaptorInit);
140 void KeyboardFocusManager::OnAdaptorInit()
142 if(Adaptor::IsAvailable())
144 // Retrieve all the existing scene holders
145 Dali::SceneHolderList sceneHolders = Adaptor::Get().GetSceneHolders();
146 for(auto iter = sceneHolders.begin(); iter != sceneHolders.end(); ++iter)
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 Dali::Window window = DevelWindow::DownCast(*iter);
155 window.FocusChangeSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
159 // Get notified when any new scene holder is created afterwards
160 Adaptor::Get().WindowCreatedSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnSceneHolderCreated);
164 void KeyboardFocusManager::OnSceneHolderCreated(Dali::Integration::SceneHolder& sceneHolder)
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 Dali::Window window = DevelWindow::DownCast(sceneHolder);
173 window.FocusChangeSignal().Connect(mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
177 KeyboardFocusManager::~KeyboardFocusManager()
181 void KeyboardFocusManager::GetConfigurationFromStyleManger()
183 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
186 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
187 mAlwaysShowIndicator = config["alwaysShowFocus"].Get<bool>() ? ALWAYS_SHOW : NONE;
188 mIsFocusIndicatorShown = (mAlwaysShowIndicator == ALWAYS_SHOW) ? SHOW : HIDE;
189 mClearFocusOnTouch = (mIsFocusIndicatorShown == SHOW) ? false : true;
193 bool KeyboardFocusManager::SetCurrentFocusActor(Actor actor)
195 DALI_ASSERT_DEBUG(!mIsWaitingKeyboardFocusChangeCommit && "Calling this function in the PreFocusChangeSignal callback?");
197 if(mIsFocusIndicatorShown == UNKNOWN)
199 GetConfigurationFromStyleManger();
202 return DoSetCurrentFocusActor(actor);
205 bool KeyboardFocusManager::DoSetCurrentFocusActor(Actor actor)
207 bool success = false;
209 // Check whether the actor is in the stage and is keyboard focusable.
211 actor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) &&
212 actor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED) &&
213 actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE) &&
214 actor.GetProperty<bool>(Actor::Property::VISIBLE))
216 // If the parent's KEYBOARD_FOCUSABLE_CHILDREN is false, it cannot have focus.
217 Actor parent = actor.GetParent();
220 if(!parent.GetProperty<bool>(DevelActor::Property::KEYBOARD_FOCUSABLE_CHILDREN))
222 DALI_LOG_INFO(gLogFilter, Debug::General, "[%s:%d] Parent Actor has KEYBOARD_FOCUSABLE_CHILDREN false\n", __FUNCTION__, __LINE__);
225 parent = parent.GetParent();
228 // If developer set focus on same actor, doing nothing
229 Actor currentFocusedActor = GetCurrentFocusActor();
230 if(actor == currentFocusedActor)
235 Integration::SceneHolder currentWindow = Integration::SceneHolder::Get(actor);
236 if(currentWindow.GetRootLayer() != mCurrentFocusedWindow.GetHandle())
238 Layer rootLayer = currentWindow.GetRootLayer();
239 mCurrentFocusedWindow = rootLayer;
242 if((mIsFocusIndicatorShown == SHOW) && (mEnableFocusIndicator == ENABLE))
244 actor.Add(GetFocusIndicatorActor());
247 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(currentFocusedActor);
248 if(currentlyFocusedControl)
250 // Do we need it to remember if it was previously DISABLED?
251 currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL);
252 currentlyFocusedControl.ClearKeyInputFocus();
255 // Save the current focused actor
256 mCurrentFocusActor = actor;
258 bool focusedWindowFound = false;
259 for(unsigned int i = 0; i < mCurrentFocusActors.size(); i++)
261 if(mCurrentFocusActors[i].first == mCurrentFocusedWindow)
263 mCurrentFocusActors[i].second = actor;
264 focusedWindowFound = true;
268 if(!focusedWindowFound)
270 // A new window gains the focus, so store the focused actor in that window.
271 mCurrentFocusActors.push_back(std::pair<WeakHandle<Layer>, WeakHandle<Actor> >(mCurrentFocusedWindow, actor));
274 // Send notification for the change of focus actor
275 if(!mFocusChangedSignal.Empty())
277 mFocusChangedSignal.Emit(currentFocusedActor, actor);
280 Toolkit::Control newlyFocusedControl = Toolkit::Control::DownCast(actor);
281 if(newlyFocusedControl)
283 newlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::FOCUSED);
284 newlyFocusedControl.SetKeyInputFocus();
287 // Push Current Focused Actor to FocusHistory
288 mFocusHistory.push_back(actor);
290 // Delete first element before add new element when Stack is full.
291 if(mFocusHistory.size() > MAX_HISTORY_AMOUNT)
293 FocusStackIterator beginPos = mFocusHistory.begin();
294 mFocusHistory.erase(beginPos);
297 DALI_LOG_INFO(gLogFilter, Debug::General, "[%s:%d] SUCCEED\n", __FUNCTION__, __LINE__);
302 DALI_LOG_WARNING("[%s:%d] FAILED\n", __FUNCTION__, __LINE__);
308 Actor KeyboardFocusManager::GetCurrentFocusActor()
310 Actor actor = mCurrentFocusActor.GetHandle();
312 if(actor && !actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
314 // If the actor has been removed from the stage, then it should not be focused
316 mCurrentFocusActor.Reset();
321 Actor KeyboardFocusManager::GetFocusActorFromCurrentWindow()
325 for(index = 0; index < mCurrentFocusActors.size(); index++)
327 if(mCurrentFocusActors[index].first == mCurrentFocusedWindow)
329 actor = mCurrentFocusActors[index].second.GetHandle();
334 if(actor && !actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
336 // If the actor has been removed from the window, then the window doesn't have any focused actor
338 mCurrentFocusActors.erase(mCurrentFocusActors.begin() + index);
344 Actor KeyboardFocusManager::GetCurrentFocusGroup()
346 return GetFocusGroup(GetCurrentFocusActor());
349 void KeyboardFocusManager::MoveFocusBackward()
351 // Find Pre Focused Actor when the list size is more than 1
352 if(mFocusHistory.size() > 1)
354 // Delete current focused actor in history
355 mFocusHistory.pop_back();
357 // If pre-focused actors are not on stage or deleted, remove them in stack
358 while(mFocusHistory.size() > 0)
360 // Get pre focused actor
361 Actor target = mFocusHistory[mFocusHistory.size() - 1].GetHandle();
363 // Impl of Actor is not null
364 if(target && target.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
366 // Delete pre focused actor in history because it will pushed again by SetCurrentFocusActor()
367 mFocusHistory.pop_back();
368 SetCurrentFocusActor(target);
373 // Target is empty handle or off stage. Erase from queue
374 mFocusHistory.pop_back();
378 // if there is no actor which can get focus, then push current focus actor in stack again
379 if(mFocusHistory.size() == 0)
381 Actor currentFocusedActor = GetCurrentFocusActor();
382 mFocusHistory.push_back(currentFocusedActor);
387 bool KeyboardFocusManager::IsLayoutControl(Actor actor) const
389 Toolkit::Control control = Toolkit::Control::DownCast(actor);
390 return control && GetImplementation(control).IsKeyboardNavigationSupported();
393 Toolkit::Control KeyboardFocusManager::GetParentLayoutControl(Actor actor) const
395 // Get the actor's parent layout control that supports two dimensional keyboard navigation
400 Integration::SceneHolder window = Integration::SceneHolder::Get(actor);
403 rootActor = window.GetRootLayer();
406 parent = actor.GetParent();
409 while(parent && !IsLayoutControl(parent) && parent != rootActor)
411 parent = parent.GetParent();
414 return Toolkit::Control::DownCast(parent);
417 bool KeyboardFocusManager::MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction, const std::string& deviceName)
419 Actor currentFocusActor = GetCurrentFocusActor();
421 bool succeed = false;
423 // Go through the actor's hierarchy until we find a layout control that knows how to move the focus
424 Toolkit::Control layoutControl = IsLayoutControl(currentFocusActor) ? Toolkit::Control::DownCast(currentFocusActor) : GetParentLayoutControl(currentFocusActor);
425 while(layoutControl && !succeed)
427 succeed = DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
428 layoutControl = GetParentLayoutControl(layoutControl);
433 Actor nextFocusableActor;
435 Toolkit::Control currentFocusControl = Toolkit::Control::DownCast(currentFocusActor);
437 // If the current focused actor is a control, then find the next focusable actor via the focusable properties.
438 if(currentFocusControl)
441 Property::Index index = Property::INVALID_INDEX;
442 Property::Value value;
444 // Find property index based upon focus direction
447 case Toolkit::Control::KeyboardFocus::LEFT:
449 index = Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID;
452 case Toolkit::Control::KeyboardFocus::RIGHT:
454 index = Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID;
457 case Toolkit::Control::KeyboardFocus::UP:
459 index = Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID;
462 case Toolkit::Control::KeyboardFocus::DOWN:
464 index = Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID;
467 case Toolkit::Control::KeyboardFocus::CLOCKWISE:
469 index = Toolkit::DevelControl::Property::CLOCKWISE_FOCUSABLE_ACTOR_ID;
472 case Toolkit::Control::KeyboardFocus::COUNTER_CLOCKWISE:
474 index = Toolkit::DevelControl::Property::COUNTER_CLOCKWISE_FOCUSABLE_ACTOR_ID;
481 // If the focusable property is set then determine next focusable actor
482 if(index != Property::INVALID_INDEX)
484 value = currentFocusActor.GetProperty(index);
485 actorId = value.Get<int>();
487 // If actor's id is valid then find actor form actor's id. The actor should be on the stage.
490 if(currentFocusActor.GetParent())
492 nextFocusableActor = currentFocusActor.GetParent().FindChildById(actorId);
495 if(!nextFocusableActor)
497 Integration::SceneHolder window = Integration::SceneHolder::Get(currentFocusActor);
500 nextFocusableActor = window.GetRootLayer().FindChildById(actorId);
507 if(!nextFocusableActor)
509 // If the implementation of CustomAlgorithmInterface is provided then the PreFocusChangeSignal is no longer emitted.
510 if(mCustomAlgorithmInterface)
512 mIsWaitingKeyboardFocusChangeCommit = true;
513 nextFocusableActor = mCustomAlgorithmInterface->GetNextFocusableActor(currentFocusActor, Actor(), direction, deviceName);
514 mIsWaitingKeyboardFocusChangeCommit = false;
516 else if(!mPreFocusChangeSignal.Empty())
518 // Don't know how to move the focus further. The application needs to tell us which actor to move the focus to
519 mIsWaitingKeyboardFocusChangeCommit = true;
520 nextFocusableActor = mPreFocusChangeSignal.Emit(currentFocusActor, Actor(), direction);
521 mIsWaitingKeyboardFocusChangeCommit = false;
523 else if (mEnableDefaultAlgorithm)
525 Actor rootActor = mFocusFinderRootActor.GetHandle();
528 if (currentFocusActor)
530 // Find the window of the focused actor.
531 Integration::SceneHolder window = Integration::SceneHolder::Get(currentFocusActor);
534 rootActor = window.GetRootLayer();
539 // Searches from the currently focused window.
540 rootActor = mCurrentFocusedWindow.GetHandle();
545 // We should find it among the actors nearby.
546 nextFocusableActor = Toolkit::FocusFinder::GetNearestFocusableActor(rootActor, currentFocusActor, direction);
551 if(nextFocusableActor && nextFocusableActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && nextFocusableActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED))
553 // Whether the next focusable actor is a layout control
554 if(IsLayoutControl(nextFocusableActor))
556 // If so, move the focus inside it.
557 Toolkit::Control layoutControl = Toolkit::Control::DownCast(nextFocusableActor);
558 succeed = DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
562 // Just set focus to the next focusable actor
563 succeed = SetCurrentFocusActor(nextFocusableActor);
571 bool KeyboardFocusManager::DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction)
573 // Ask the control for the next actor to focus
574 Actor nextFocusableActor = GetImplementation(control).GetNextKeyboardFocusableActor(actor, direction, mFocusGroupLoopEnabled);
575 if(nextFocusableActor)
577 if(!(nextFocusableActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) || nextFocusableActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED)))
579 // If the actor is not focusable, ask the same layout control for the next actor to focus
580 return DoMoveFocusWithinLayoutControl(control, nextFocusableActor, direction);
584 Actor currentFocusActor = GetCurrentFocusActor();
585 Actor committedFocusActor = nextFocusableActor;
587 // We will try to move the focus to the actor. Emit a signal to notify the proposed actor to focus
588 // Signal handler can check the proposed actor and return a different actor if it wishes.
589 if(!mPreFocusChangeSignal.Empty())
591 mIsWaitingKeyboardFocusChangeCommit = true;
592 committedFocusActor = mPreFocusChangeSignal.Emit(currentFocusActor, nextFocusableActor, direction);
593 mIsWaitingKeyboardFocusChangeCommit = false;
596 if(committedFocusActor && committedFocusActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && committedFocusActor.GetProperty<bool>(DevelActor::Property::USER_INTERACTION_ENABLED))
598 // Whether the commited focusable actor is a layout control
599 if(IsLayoutControl(committedFocusActor) && committedFocusActor != control)
601 // If so, move the focus inside it.
602 Toolkit::Control layoutControl = Toolkit::Control::DownCast(committedFocusActor);
603 return DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
607 // Otherwise, just set focus to the next focusable actor
608 if(committedFocusActor == nextFocusableActor)
610 // If the application hasn't changed our proposed actor, we informs the layout control we will
611 // move the focus to what the control returns. The control might wish to perform some actions
612 // before the focus is actually moved.
613 GetImplementation(control).OnKeyboardFocusChangeCommitted(committedFocusActor);
616 return SetCurrentFocusActor(committedFocusActor);
627 // No more actor can be focused in the given direction within the same layout control.
632 bool KeyboardFocusManager::DoMoveFocusToNextFocusGroup(bool forward)
634 bool succeed = false;
636 // Get the parent layout control of the current focus group
637 Toolkit::Control parentLayoutControl = GetParentLayoutControl(GetCurrentFocusGroup());
639 while(parentLayoutControl && !succeed)
641 // If the current focus group has a parent layout control, we can probably automatically
642 // move the focus to the next focus group in the forward or backward direction.
643 Toolkit::Control::KeyboardFocus::Direction direction = forward ? Toolkit::Control::KeyboardFocus::RIGHT : Toolkit::Control::KeyboardFocus::LEFT;
644 succeed = DoMoveFocusWithinLayoutControl(parentLayoutControl, GetCurrentFocusActor(), direction);
645 parentLayoutControl = GetParentLayoutControl(parentLayoutControl);
648 if(!mFocusGroupChangedSignal.Empty())
650 // Emit a focus group changed signal. The applicaton can move the focus to a new focus group
651 mFocusGroupChangedSignal.Emit(GetCurrentFocusActor(), forward);
657 void KeyboardFocusManager::DoKeyboardEnter(Actor actor)
661 Toolkit::Control control = Toolkit::Control::DownCast(actor);
664 // Notify the control that enter has been pressed on it.
665 GetImplementation(control).KeyboardEnter();
668 // Send a notification for the actor.
669 if(!mFocusedActorEnterKeySignal.Empty())
671 mFocusedActorEnterKeySignal.Emit(actor);
676 void KeyboardFocusManager::ClearFocus()
678 ClearFocusIndicator();
679 Actor actor = GetCurrentFocusActor();
682 // Send notification for the change of focus actor
683 if(!mFocusChangedSignal.Empty())
685 mFocusChangedSignal.Emit(actor, Actor());
688 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(actor);
689 if(currentlyFocusedControl)
691 currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL);
692 currentlyFocusedControl.ClearKeyInputFocus();
695 mCurrentFocusActor.Reset();
698 void KeyboardFocusManager::ClearFocusIndicator()
700 Actor actor = GetCurrentFocusActor();
703 if(mFocusIndicatorActor)
705 actor.Remove(mFocusIndicatorActor);
708 mIsFocusIndicatorShown = (mAlwaysShowIndicator == ALWAYS_SHOW) ? SHOW : HIDE;
711 void KeyboardFocusManager::SetFocusGroupLoop(bool enabled)
713 mFocusGroupLoopEnabled = enabled;
716 bool KeyboardFocusManager::GetFocusGroupLoop() const
718 return mFocusGroupLoopEnabled;
721 void KeyboardFocusManager::SetAsFocusGroup(Actor actor, bool isFocusGroup)
725 // Create/Set focus group property.
726 actor.RegisterProperty(IS_FOCUS_GROUP_PROPERTY_NAME, isFocusGroup, Property::READ_WRITE);
730 bool KeyboardFocusManager::IsFocusGroup(Actor actor) const
732 // Check whether the actor is a focus group
733 bool isFocusGroup = false;
737 Property::Index propertyIsFocusGroup = actor.GetPropertyIndex(IS_FOCUS_GROUP_PROPERTY_NAME);
738 if(propertyIsFocusGroup != Property::INVALID_INDEX)
740 isFocusGroup = actor.GetProperty<bool>(propertyIsFocusGroup);
747 Actor KeyboardFocusManager::GetFocusGroup(Actor actor)
749 // Go through the actor's hierarchy to check which focus group the actor belongs to
750 while(actor && !IsFocusGroup(actor))
752 actor = actor.GetParent();
758 void KeyboardFocusManager::SetFocusIndicatorActor(Actor indicator)
760 if(mFocusIndicatorActor != indicator)
762 Actor currentFocusActor = GetCurrentFocusActor();
763 if(currentFocusActor)
765 // The new focus indicator should be added to the current focused actor immediately
766 if(mFocusIndicatorActor)
768 currentFocusActor.Remove(mFocusIndicatorActor);
773 currentFocusActor.Add(indicator);
777 mFocusIndicatorActor = indicator;
781 Actor KeyboardFocusManager::GetFocusIndicatorActor()
783 if(!mFocusIndicatorActor)
785 // Create the default if it hasn't been set and one that's shared by all the keyboard focusable actors
786 const std::string imageDirPath = AssetManager::GetDaliImagePath();
787 mFocusIndicatorActor = Toolkit::ImageView::New(imageDirPath + FOCUS_BORDER_IMAGE_FILE_NAME);
789 // Apply size constraint to the focus indicator
790 mFocusIndicatorActor.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
793 mFocusIndicatorActor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER);
794 mFocusIndicatorActor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER);
795 mFocusIndicatorActor.SetProperty(Actor::Property::POSITION, Vector2(0.0f, 0.0f));
797 return mFocusIndicatorActor;
800 void KeyboardFocusManager::OnKeyEvent(const KeyEvent& event)
802 const std::string& keyName = event.GetKeyName();
803 const std::string& deviceName = event.GetDeviceName();
805 if(mIsFocusIndicatorShown == UNKNOWN)
807 GetConfigurationFromStyleManger();
810 bool isFocusStartableKey = false;
812 if(event.GetState() == KeyEvent::DOWN)
814 if(keyName == "Left")
816 if(mIsFocusIndicatorShown == HIDE)
818 // Show focus indicator
819 mIsFocusIndicatorShown = SHOW;
823 // Move the focus towards left
824 MoveFocus(Toolkit::Control::KeyboardFocus::LEFT, deviceName);
827 isFocusStartableKey = true;
829 else if(keyName == "Right")
831 if(mIsFocusIndicatorShown == HIDE)
833 // Show focus indicator
834 mIsFocusIndicatorShown = SHOW;
838 // Move the focus towards right
839 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT, deviceName);
842 isFocusStartableKey = true;
844 else if(keyName == "Up")
846 if(mIsFocusIndicatorShown == HIDE)
848 // Show focus indicator
849 mIsFocusIndicatorShown = SHOW;
853 // Move the focus towards up
854 MoveFocus(Toolkit::Control::KeyboardFocus::UP, deviceName);
857 isFocusStartableKey = true;
859 else if(keyName == "Down")
861 if(mIsFocusIndicatorShown == HIDE)
863 // Show focus indicator
864 mIsFocusIndicatorShown = SHOW;
868 // Move the focus towards down
869 MoveFocus(Toolkit::Control::KeyboardFocus::DOWN, deviceName);
872 isFocusStartableKey = true;
874 else if(keyName == "Prior")
876 if(mIsFocusIndicatorShown == HIDE)
878 // Show focus indicator
879 mIsFocusIndicatorShown = SHOW;
883 // Move the focus towards the previous page
884 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_UP, deviceName);
887 isFocusStartableKey = true;
889 else if(keyName == "Next")
891 if(mIsFocusIndicatorShown == HIDE)
893 // Show focus indicator
894 mIsFocusIndicatorShown = SHOW;
898 // Move the focus towards the next page
899 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_DOWN, deviceName);
902 isFocusStartableKey = true;
904 else if(keyName == "Tab")
906 if(mIsFocusIndicatorShown == HIDE)
908 // Show focus indicator
909 mIsFocusIndicatorShown = SHOW;
913 // "Tab" key changes the focus group in the forward direction and
914 // "Shift-Tab" key changes it in the backward direction.
915 if(!DoMoveFocusToNextFocusGroup(!event.IsShiftModifier()))
917 // If the focus group is not changed, Move the focus towards forward, "Shift-Tap" key moves the focus towards backward.
918 MoveFocus(event.IsShiftModifier() ? Toolkit::Control::KeyboardFocus::BACKWARD : Toolkit::Control::KeyboardFocus::FORWARD, deviceName);
922 isFocusStartableKey = true;
924 else if(keyName == "space")
926 if(mIsFocusIndicatorShown == HIDE)
928 // Show focus indicator
929 mIsFocusIndicatorShown = SHOW;
932 isFocusStartableKey = true;
934 else if(keyName == "")
936 // Check the fake key event for evas-plugin case
937 if(mIsFocusIndicatorShown == HIDE)
939 // Show focus indicator
940 mIsFocusIndicatorShown = SHOW;
943 isFocusStartableKey = true;
945 else if(keyName == "Backspace")
947 // Emit signal to go back to the previous view???
949 else if(keyName == "Escape")
953 else if(event.GetState() == KeyEvent::UP)
955 if(keyName == "Return")
957 if(mIsFocusIndicatorShown == HIDE)
959 // Show focus indicator
960 mIsFocusIndicatorShown = SHOW;
964 // The focused actor has enter pressed on it
965 Actor actor = GetCurrentFocusActor();
968 DoKeyboardEnter(actor);
972 isFocusStartableKey = true;
976 if(isFocusStartableKey && mIsFocusIndicatorShown == SHOW)
978 Actor actor = GetCurrentFocusActor();
981 if(mEnableFocusIndicator == ENABLE)
983 // Make sure the focused actor is highlighted
984 actor.Add(GetFocusIndicatorActor());
989 // No actor is focused but keyboard focus is activated by the key press
990 // Let's try to move the initial focus
991 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT, deviceName);
996 void KeyboardFocusManager::OnTouch(const TouchEvent& touch)
998 // if mIsFocusIndicatorShown is UNKNOWN, it means Configuration is not loaded.
999 // Try to load configuration.
1000 if(mIsFocusIndicatorShown == UNKNOWN)
1002 GetConfigurationFromStyleManger();
1005 // Clear the focus when user touch the screen.
1006 // We only do this on a Down event, otherwise the clear action may override a manually focused actor.
1007 if(((touch.GetPointCount() < 1) || (touch.GetState(0) == PointState::DOWN)))
1009 // If you touch the currently focused actor again, you don't need to do SetCurrentFocusActor again.
1010 Actor hitActor = touch.GetHitActor(0);
1011 if(hitActor && hitActor == GetCurrentFocusActor())
1015 // If KEYBOARD_FOCUSABLE and TOUCH_FOCUSABLE is true, set focus actor
1016 if(hitActor && hitActor.GetProperty<bool>(Actor::Property::KEYBOARD_FOCUSABLE) && hitActor.GetProperty<bool>(DevelActor::Property::TOUCH_FOCUSABLE))
1018 // If mClearFocusOnTouch is false, do not clear the focus
1019 if(mClearFocusOnTouch)
1023 SetCurrentFocusActor(hitActor);
1027 // If mClearFocusOnTouch is false, do not clear the focus indicator even if user touch the screen.
1028 if(mClearFocusOnTouch)
1030 ClearFocusIndicator();
1036 void KeyboardFocusManager::OnWheelEvent(const WheelEvent& event)
1038 if(event.GetType() == Dali::WheelEvent::CUSTOM_WHEEL)
1040 Toolkit::Control::KeyboardFocus::Direction direction = (event.GetDelta() > 0) ? Toolkit::Control::KeyboardFocus::CLOCKWISE : Toolkit::Control::KeyboardFocus::COUNTER_CLOCKWISE;
1042 MoveFocus(direction);
1046 bool KeyboardFocusManager::OnCustomWheelEvent(const WheelEvent& event)
1048 bool consumed = false;
1049 Actor actor = GetCurrentFocusActor();
1052 // Notify the actor about the wheel event
1053 consumed = EmitCustomWheelSignals(actor, event);
1058 bool KeyboardFocusManager::EmitCustomWheelSignals(Actor actor, const WheelEvent& event)
1060 bool consumed = false;
1064 Dali::Actor oldParent(actor.GetParent());
1066 // Only do the conversion and emit the signal if the actor's wheel signal has connections.
1067 if(!actor.WheelEventSignal().Empty())
1069 // Emit the signal to the parent
1070 consumed = actor.WheelEventSignal().Emit(actor, event);
1072 // if actor doesn't consume WheelEvent, give WheelEvent to its parent.
1075 // The actor may have been removed/reparented during the signal callbacks.
1076 Dali::Actor parent = actor.GetParent();
1079 (parent == oldParent))
1081 consumed = EmitCustomWheelSignals(parent, event);
1089 void KeyboardFocusManager::OnWindowFocusChanged(Window window, bool focusIn)
1091 if(focusIn && mCurrentFocusedWindow.GetHandle() != window.GetRootLayer())
1093 // Change Current Focused Window
1094 Layer rootLayer = window.GetRootLayer();
1095 mCurrentFocusedWindow = rootLayer;
1097 // Get Current Focused Actor from window
1098 Actor currentFocusedActor = GetFocusActorFromCurrentWindow();
1099 SetCurrentFocusActor(currentFocusedActor);
1101 if(currentFocusedActor && (mEnableFocusIndicator == ENABLE))
1103 // Make sure the focused actor is highlighted
1104 currentFocusedActor.Add(GetFocusIndicatorActor());
1105 mIsFocusIndicatorShown = SHOW;
1110 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& KeyboardFocusManager::PreFocusChangeSignal()
1112 return mPreFocusChangeSignal;
1115 Toolkit::KeyboardFocusManager::FocusChangedSignalType& KeyboardFocusManager::FocusChangedSignal()
1117 return mFocusChangedSignal;
1120 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& KeyboardFocusManager::FocusGroupChangedSignal()
1122 return mFocusGroupChangedSignal;
1125 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& KeyboardFocusManager::FocusedActorEnterKeySignal()
1127 return mFocusedActorEnterKeySignal;
1130 bool KeyboardFocusManager::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
1132 Dali::BaseHandle handle(object);
1134 bool connected(true);
1135 KeyboardFocusManager* manager = static_cast<KeyboardFocusManager*>(object); // TypeRegistry guarantees that this is the correct type.
1137 if(0 == strcmp(signalName.c_str(), SIGNAL_PRE_FOCUS_CHANGE))
1139 manager->PreFocusChangeSignal().Connect(tracker, functor);
1141 else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUS_CHANGED))
1143 manager->FocusChangedSignal().Connect(tracker, functor);
1145 else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUS_GROUP_CHANGED))
1147 manager->FocusGroupChangedSignal().Connect(tracker, functor);
1149 else if(0 == strcmp(signalName.c_str(), SIGNAL_FOCUSED_ACTOR_ENTER_KEY))
1151 manager->FocusedActorEnterKeySignal().Connect(tracker, functor);
1155 // signalName does not match any signal
1162 void KeyboardFocusManager::SetCustomAlgorithm(CustomAlgorithmInterface& interface)
1164 mCustomAlgorithmInterface = &interface;
1167 void KeyboardFocusManager::EnableFocusIndicator(bool enable)
1169 if(!enable && mFocusIndicatorActor)
1171 mFocusIndicatorActor.Unparent();
1174 mEnableFocusIndicator = enable ? ENABLE : DISABLE;
1177 bool KeyboardFocusManager::IsFocusIndicatorEnabled() const
1179 return (mEnableFocusIndicator == ENABLE);
1182 void KeyboardFocusManager::EnableDefaultAlgorithm(bool enable)
1184 mEnableDefaultAlgorithm = enable;
1187 bool KeyboardFocusManager::IsDefaultAlgorithmEnabled() const
1189 return mEnableDefaultAlgorithm;
1192 void KeyboardFocusManager::SetFocusFinderRootActor(Actor actor)
1194 mFocusFinderRootActor = actor;
1197 void KeyboardFocusManager::ResetFocusFinderRootActor()
1199 mFocusFinderRootActor.Reset();
1202 } // namespace Internal
1204 } // namespace Toolkit