2 * Copyright (c) 2020 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 <cstring> // for strcmp
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/devel-api/adaptor-framework/accessibility-adaptor.h>
25 #include <dali/devel-api/common/singleton-service.h>
26 #include <dali/devel-api/adaptor-framework/lifecycle-controller.h>
27 #include <dali/public-api/animation/constraints.h>
28 #include <dali/public-api/common/stage.h>
29 #include <dali/public-api/events/key-event.h>
30 #include <dali/public-api/events/touch-data.h>
31 #include <dali/public-api/object/type-registry.h>
32 #include <dali/public-api/object/type-registry-helper.h>
33 #include <dali/public-api/object/property-map.h>
34 #include <dali/integration-api/debug.h>
35 #include <dali/integration-api/adaptor-framework/adaptor.h>
36 #include <dali/integration-api/adaptor-framework/scene-holder.h>
39 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
40 #include <dali-toolkit/public-api/controls/control.h>
41 #include <dali-toolkit/public-api/controls/control-impl.h>
42 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
43 #include <dali-toolkit/devel-api/accessibility-manager/accessibility-manager.h>
44 #include <dali-toolkit/devel-api/controls/control-devel.h>
45 #include <dali-toolkit/public-api/styling/style-manager.h>
46 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
57 namespace // Unnamed namespace
60 #if defined(DEBUG_ENABLED)
61 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_KEYBOARD_FOCUS_MANAGER");
64 const char* const IS_FOCUS_GROUP_PROPERTY_NAME = "isKeyboardFocusGroup"; // This property will be replaced by a flag in Control.
66 const char* const FOCUS_BORDER_IMAGE_FILE_NAME = "keyboard_focus.9.png";
70 BaseHandle handle = KeyboardFocusManager::Get();
74 SingletonService singletonService( SingletonService::Get() );
75 if ( singletonService )
77 Toolkit::KeyboardFocusManager manager = Toolkit::KeyboardFocusManager( new Internal::KeyboardFocusManager() );
78 singletonService.Register( typeid( manager ), manager );
86 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::KeyboardFocusManager, Dali::BaseHandle, Create, true )
88 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardPreFocusChange", SIGNAL_PRE_FOCUS_CHANGE )
89 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusChanged", SIGNAL_FOCUS_CHANGED )
90 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusGroupChanged", SIGNAL_FOCUS_GROUP_CHANGED )
91 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusedActorEnterKey", SIGNAL_FOCUSED_ACTOR_ENTER_KEY )
93 DALI_TYPE_REGISTRATION_END()
95 const unsigned int MAX_HISTORY_AMOUNT = 30; ///< Max length of focus history stack
97 } // unnamed namespace
99 Toolkit::KeyboardFocusManager KeyboardFocusManager::Get()
101 Toolkit::KeyboardFocusManager manager;
103 SingletonService singletonService( SingletonService::Get() );
104 if ( singletonService )
106 // Check whether the keyboard focus manager is already created
107 Dali::BaseHandle handle = singletonService.GetSingleton( typeid( Toolkit::KeyboardFocusManager ) );
110 // If so, downcast the handle of singleton to keyboard focus manager
111 manager = Toolkit::KeyboardFocusManager( dynamic_cast< KeyboardFocusManager* >( handle.GetObjectPtr() ) );
118 KeyboardFocusManager::KeyboardFocusManager()
119 : mPreFocusChangeSignal(),
120 mFocusChangedSignal(),
121 mFocusGroupChangedSignal(),
122 mFocusedActorEnterKeySignal(),
123 mCurrentFocusActor(),
124 mFocusIndicatorActor(),
126 mSlotDelegate( this ),
127 mCustomAlgorithmInterface(NULL),
128 mCurrentFocusedWindow(),
129 mIsFocusIndicatorShown( UNKNOWN ),
130 mEnableFocusIndicator( ENABLE ),
131 mAlwaysShowIndicator( ALWAYS_SHOW ),
132 mFocusGroupLoopEnabled( false ),
133 mIsWaitingKeyboardFocusChangeCommit( false ),
134 mClearFocusOnTouch( true )
136 // TODO: Get FocusIndicatorEnable constant from stylesheet to set mIsFocusIndicatorShown.
138 LifecycleController::Get().InitSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnAdaptorInit );
141 void KeyboardFocusManager::OnAdaptorInit()
143 if( Adaptor::IsAvailable() )
145 // Retrieve all the existing scene holders
146 Dali::SceneHolderList sceneHolders = Adaptor::Get().GetSceneHolders();
147 for( auto iter = sceneHolders.begin(); iter != sceneHolders.end(); ++iter )
149 ( *iter ).KeyEventSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnKeyEvent );
150 ( *iter ).TouchSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnTouch );
151 Dali::Window window = DevelWindow::DownCast( *iter );
154 window.FocusChangeSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
158 // Get notified when any new scene holder is created afterwards
159 Adaptor::Get().WindowCreatedSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnSceneHolderCreated );
163 void KeyboardFocusManager::OnSceneHolderCreated( Dali::Integration::SceneHolder& sceneHolder )
165 sceneHolder.KeyEventSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnKeyEvent );
166 sceneHolder.TouchSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnTouch );
167 Dali::Window window = DevelWindow::DownCast( sceneHolder );
170 window.FocusChangeSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
174 KeyboardFocusManager::~KeyboardFocusManager()
178 void KeyboardFocusManager::GetConfigurationFromStyleManger()
180 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
183 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
184 mAlwaysShowIndicator = config["alwaysShowFocus"].Get<bool>() ? ALWAYS_SHOW : NONE;
185 mIsFocusIndicatorShown = ( mAlwaysShowIndicator == ALWAYS_SHOW )? SHOW : HIDE;
186 mClearFocusOnTouch = ( mIsFocusIndicatorShown == SHOW ) ? false : true;
190 bool KeyboardFocusManager::SetCurrentFocusActor( Actor actor )
192 DALI_ASSERT_DEBUG( !mIsWaitingKeyboardFocusChangeCommit && "Calling this function in the PreFocusChangeSignal callback?" );
194 if( mIsFocusIndicatorShown == UNKNOWN )
196 GetConfigurationFromStyleManger();
199 return DoSetCurrentFocusActor( actor );
202 bool KeyboardFocusManager::DoSetCurrentFocusActor( Actor actor )
204 bool success = false;
205 if( actor && actor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) && actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
207 Integration::SceneHolder currentWindow = Integration::SceneHolder::Get( actor );
209 if( currentWindow.GetRootLayer() != mCurrentFocusedWindow.GetHandle())
211 Layer rootLayer = currentWindow.GetRootLayer();
212 mCurrentFocusedWindow = rootLayer;
216 Actor currentFocusedActor = GetCurrentFocusActor();
218 // If developer set focus on same actor, doing nothing
219 if( actor == currentFocusedActor )
228 // Check whether the actor is in the stage and is keyboard focusable.
229 if( actor && actor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) && actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
231 if( ( mIsFocusIndicatorShown == SHOW ) && ( mEnableFocusIndicator == ENABLE ) )
233 actor.Add( GetFocusIndicatorActor() );
236 // Send notification for the change of focus actor
237 if( !mFocusChangedSignal.Empty() )
239 mFocusChangedSignal.Emit(currentFocusedActor, actor);
242 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(currentFocusedActor);
243 if( currentlyFocusedControl )
245 // Do we need it to remember if it was previously DISABLED?
246 currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL );
247 currentlyFocusedControl.ClearKeyInputFocus();
250 DALI_LOG_INFO( gLogFilter, Debug::General, "[%s:%d] Focus Changed\n", __FUNCTION__, __LINE__);
252 // Save the current focused actor
253 mCurrentFocusActor = actor;
255 bool focusedWindowFound = false;
256 for( unsigned int i = 0; i < mCurrentFocusActors.size(); i++ )
258 if( mCurrentFocusActors[i].first == mCurrentFocusedWindow )
260 mCurrentFocusActors[i].second = actor;
261 focusedWindowFound = true;
265 if( !focusedWindowFound)
267 // A new window gains the focus, so store the focused actor in that window.
268 mCurrentFocusActors.push_back( std::pair< WeakHandle< Layer>, WeakHandle< Actor > >( mCurrentFocusedWindow , actor ));
271 Toolkit::Control newlyFocusedControl = Toolkit::Control::DownCast(actor);
272 if( newlyFocusedControl )
274 newlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::FOCUSED );
275 newlyFocusedControl.SetKeyInputFocus();
278 // Push Current Focused Actor to FocusHistory
279 mFocusHistory.push_back( actor );
281 // Delete first element before add new element when Stack is full.
282 if( mFocusHistory.size() > MAX_HISTORY_AMOUNT )
284 FocusStackIterator beginPos = mFocusHistory.begin();
285 mFocusHistory.erase( beginPos );
288 DALI_LOG_INFO( gLogFilter, Debug::General, "[%s:%d] SUCCEED\n", __FUNCTION__, __LINE__);
293 DALI_LOG_WARNING("[%s:%d] FAILED\n", __FUNCTION__, __LINE__);
299 Actor KeyboardFocusManager::GetCurrentFocusActor()
301 Actor actor = mCurrentFocusActor.GetHandle();
303 if( actor && ! actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
305 // If the actor has been removed from the stage, then it should not be focused
307 mCurrentFocusActor.Reset();
312 Actor KeyboardFocusManager::GetFocusActorFromCurrentWindow()
316 for( index = 0; index < mCurrentFocusActors.size(); index++ )
318 if( mCurrentFocusActors[index].first == mCurrentFocusedWindow )
320 actor = mCurrentFocusActors[index].second.GetHandle();
325 if( actor && ! actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
327 // If the actor has been removed from the window, then the window doesn't have any focused actor
329 mCurrentFocusActors.erase( mCurrentFocusActors.begin() + index );
335 Actor KeyboardFocusManager::GetCurrentFocusGroup()
337 return GetFocusGroup(GetCurrentFocusActor());
340 void KeyboardFocusManager::MoveFocusBackward()
342 // Find Pre Focused Actor when the list size is more than 1
343 if( mFocusHistory.size() > 1 )
345 // Delete current focused actor in history
346 mFocusHistory.pop_back();
348 // If pre-focused actors are not on stage or deleted, remove them in stack
349 while( mFocusHistory.size() > 0 )
351 // Get pre focused actor
352 Actor target = mFocusHistory[ mFocusHistory.size() -1 ].GetHandle();
354 // Impl of Actor is not null
355 if( target && target.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
357 // Delete pre focused actor in history because it will pushed again by SetCurrentFocusActor()
358 mFocusHistory.pop_back();
359 SetCurrentFocusActor( target );
364 // Target is empty handle or off stage. Erase from queue
365 mFocusHistory.pop_back();
369 // if there is no actor which can get focus, then push current focus actor in stack again
370 if( mFocusHistory.size() == 0 )
372 Actor currentFocusedActor = GetCurrentFocusActor();
373 mFocusHistory.push_back( currentFocusedActor );
378 bool KeyboardFocusManager::IsLayoutControl(Actor actor) const
380 Toolkit::Control control = Toolkit::Control::DownCast(actor);
381 return control && GetImplementation( control ).IsKeyboardNavigationSupported();
384 Toolkit::Control KeyboardFocusManager::GetParentLayoutControl(Actor actor) const
386 // Get the actor's parent layout control that supports two dimensional keyboard navigation
391 Integration::SceneHolder window = Integration::SceneHolder::Get( actor );
394 rootActor = window.GetRootLayer();
397 parent = actor.GetParent();
400 while( parent && !IsLayoutControl(parent) && parent != rootActor )
402 parent = parent.GetParent();
405 return Toolkit::Control::DownCast(parent);
408 bool KeyboardFocusManager::MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction)
410 Actor currentFocusActor = GetCurrentFocusActor();
412 bool succeed = false;
414 // Go through the actor's hierarchy until we find a layout control that knows how to move the focus
415 Toolkit::Control parentLayoutControl = GetParentLayoutControl( currentFocusActor );
416 while( parentLayoutControl && !succeed )
418 succeed = DoMoveFocusWithinLayoutControl( parentLayoutControl, currentFocusActor, direction );
419 parentLayoutControl = GetParentLayoutControl( parentLayoutControl );
424 Actor nextFocusableActor;
426 Toolkit::Control currentFocusControl = Toolkit::Control::DownCast(currentFocusActor);
428 // If the current focused actor is a control, then find the next focusable actor via the focusable properties.
429 if( currentFocusControl )
432 Property::Index index = Property::INVALID_INDEX;
433 Property::Value value;
435 // Find property index based upon focus direction
438 case Toolkit::Control::KeyboardFocus::LEFT:
440 index = Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID;
443 case Toolkit::Control::KeyboardFocus::RIGHT:
445 index = Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID;
448 case Toolkit::Control::KeyboardFocus::UP:
450 index = Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID;
453 case Toolkit::Control::KeyboardFocus::DOWN:
455 index = Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID;
462 // If the focusable property is set then determine next focusable actor
463 if( index != Property::INVALID_INDEX)
465 value = currentFocusActor.GetProperty( index );
466 actorId = value.Get<int>();
468 // If actor's id is valid then find actor form actor's id. The actor should be on the stage.
471 if( currentFocusActor.GetParent() )
473 nextFocusableActor = currentFocusActor.GetParent().FindChildById( actorId );
476 if( !nextFocusableActor )
478 Integration::SceneHolder window = Integration::SceneHolder::Get( currentFocusActor );
481 nextFocusableActor = window.GetRootLayer().FindChildById( actorId );
488 if( !nextFocusableActor )
490 // If the implementation of CustomAlgorithmInterface is provided then the PreFocusChangeSignal is no longer emitted.
491 if( mCustomAlgorithmInterface )
493 mIsWaitingKeyboardFocusChangeCommit = true;
494 nextFocusableActor = mCustomAlgorithmInterface->GetNextFocusableActor( currentFocusActor, Actor(), direction );
495 mIsWaitingKeyboardFocusChangeCommit = false;
497 else if( !mPreFocusChangeSignal.Empty() )
499 // Don't know how to move the focus further. The application needs to tell us which actor to move the focus to
500 mIsWaitingKeyboardFocusChangeCommit = true;
501 nextFocusableActor = mPreFocusChangeSignal.Emit( currentFocusActor, Actor(), direction );
502 mIsWaitingKeyboardFocusChangeCommit = false;
506 if( nextFocusableActor && nextFocusableActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
508 // Whether the next focusable actor is a layout control
509 if( IsLayoutControl( nextFocusableActor ) )
511 // If so, move the focus inside it.
512 Toolkit::Control layoutControl = Toolkit::Control::DownCast( nextFocusableActor) ;
513 succeed = DoMoveFocusWithinLayoutControl( layoutControl, currentFocusActor, direction );
517 // Otherwise, just set focus to the next focusable actor
518 succeed = SetCurrentFocusActor( nextFocusableActor );
526 bool KeyboardFocusManager::DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction)
528 // Ask the control for the next actor to focus
529 Actor nextFocusableActor = GetImplementation( control ).GetNextKeyboardFocusableActor(actor, direction, mFocusGroupLoopEnabled);
530 if(nextFocusableActor)
532 if(!nextFocusableActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ))
534 // If the actor is not focusable, ask the same layout control for the next actor to focus
535 return DoMoveFocusWithinLayoutControl(control, nextFocusableActor, direction);
539 Actor currentFocusActor = GetCurrentFocusActor();
540 Actor committedFocusActor = nextFocusableActor;
542 // We will try to move the focus to the actor. Emit a signal to notify the proposed actor to focus
543 // Signal handler can check the proposed actor and return a different actor if it wishes.
544 if( !mPreFocusChangeSignal.Empty() )
546 mIsWaitingKeyboardFocusChangeCommit = true;
547 committedFocusActor = mPreFocusChangeSignal.Emit(currentFocusActor, nextFocusableActor, direction);
548 mIsWaitingKeyboardFocusChangeCommit = false;
551 if (committedFocusActor && committedFocusActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ))
553 // Whether the commited focusable actor is a layout control
554 if(IsLayoutControl(committedFocusActor))
556 // If so, move the focus inside it.
557 Toolkit::Control layoutControl = Toolkit::Control::DownCast(committedFocusActor);
558 return DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
562 // Otherwise, just set focus to the next focusable actor
563 if(committedFocusActor == nextFocusableActor)
565 // If the application hasn't changed our proposed actor, we informs the layout control we will
566 // move the focus to what the control returns. The control might wish to perform some actions
567 // before the focus is actually moved.
568 GetImplementation( control ).OnKeyboardFocusChangeCommitted( committedFocusActor );
571 return SetCurrentFocusActor(committedFocusActor);
582 // No more actor can be focused in the given direction within the same layout control.
587 bool KeyboardFocusManager::DoMoveFocusToNextFocusGroup(bool forward)
589 bool succeed = false;
591 // Get the parent layout control of the current focus group
592 Toolkit::Control parentLayoutControl = GetParentLayoutControl(GetCurrentFocusGroup());
594 while(parentLayoutControl && !succeed)
596 // If the current focus group has a parent layout control, we can probably automatically
597 // move the focus to the next focus group in the forward or backward direction.
598 Toolkit::Control::KeyboardFocus::Direction direction = forward ? Toolkit::Control::KeyboardFocus::RIGHT : Toolkit::Control::KeyboardFocus::LEFT;
599 succeed = DoMoveFocusWithinLayoutControl(parentLayoutControl, GetCurrentFocusActor(), direction);
600 parentLayoutControl = GetParentLayoutControl(parentLayoutControl);
603 if(!mFocusGroupChangedSignal.Empty())
605 // Emit a focus group changed signal. The applicaton can move the focus to a new focus group
606 mFocusGroupChangedSignal.Emit(GetCurrentFocusActor(), forward);
612 void KeyboardFocusManager::DoKeyboardEnter(Actor actor)
616 Toolkit::Control control = Toolkit::Control::DownCast( actor );
619 // Notify the control that enter has been pressed on it.
620 GetImplementation( control ).KeyboardEnter();
623 // Send a notification for the actor.
624 if( !mFocusedActorEnterKeySignal.Empty() )
626 mFocusedActorEnterKeySignal.Emit( actor );
631 void KeyboardFocusManager::ClearFocus()
633 Actor actor = GetCurrentFocusActor();
636 if( mFocusIndicatorActor )
638 actor.Remove( mFocusIndicatorActor );
641 // Send notification for the change of focus actor
642 if( !mFocusChangedSignal.Empty() )
644 mFocusChangedSignal.Emit( actor, Actor() );
647 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast( actor );
648 if( currentlyFocusedControl )
650 currentlyFocusedControl.SetProperty( DevelControl::Property::STATE, DevelControl::NORMAL );
651 currentlyFocusedControl.ClearKeyInputFocus();
655 mCurrentFocusActor.Reset();
656 mIsFocusIndicatorShown = ( mAlwaysShowIndicator == ALWAYS_SHOW ) ? SHOW : HIDE;
659 void KeyboardFocusManager::SetFocusGroupLoop(bool enabled)
661 mFocusGroupLoopEnabled = enabled;
664 bool KeyboardFocusManager::GetFocusGroupLoop() const
666 return mFocusGroupLoopEnabled;
669 void KeyboardFocusManager::SetAsFocusGroup(Actor actor, bool isFocusGroup)
673 // Create/Set focus group property.
674 actor.RegisterProperty( IS_FOCUS_GROUP_PROPERTY_NAME, isFocusGroup, Property::READ_WRITE );
678 bool KeyboardFocusManager::IsFocusGroup(Actor actor) const
680 // Check whether the actor is a focus group
681 bool isFocusGroup = false;
685 Property::Index propertyIsFocusGroup = actor.GetPropertyIndex(IS_FOCUS_GROUP_PROPERTY_NAME);
686 if(propertyIsFocusGroup != Property::INVALID_INDEX)
688 isFocusGroup = actor.GetProperty<bool>(propertyIsFocusGroup);
695 Actor KeyboardFocusManager::GetFocusGroup(Actor actor)
697 // Go through the actor's hierarchy to check which focus group the actor belongs to
698 while (actor && !IsFocusGroup(actor))
700 actor = actor.GetParent();
706 void KeyboardFocusManager::SetFocusIndicatorActor(Actor indicator)
708 if(mFocusIndicatorActor != indicator)
710 Actor currentFocusActor = GetCurrentFocusActor();
711 if(currentFocusActor)
713 // The new focus indicator should be added to the current focused actor immediately
714 if(mFocusIndicatorActor)
716 currentFocusActor.Remove(mFocusIndicatorActor);
721 currentFocusActor.Add(indicator);
725 mFocusIndicatorActor = indicator;
729 Actor KeyboardFocusManager::GetFocusIndicatorActor()
731 if( ! mFocusIndicatorActor )
733 // Create the default if it hasn't been set and one that's shared by all the keyboard focusable actors
734 const std::string imageDirPath = AssetManager::GetDaliImagePath();
735 mFocusIndicatorActor = Toolkit::ImageView::New( imageDirPath + FOCUS_BORDER_IMAGE_FILE_NAME );
737 // Apply size constraint to the focus indicator
738 mFocusIndicatorActor.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
741 mFocusIndicatorActor.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
742 mFocusIndicatorActor.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
743 mFocusIndicatorActor.SetProperty( Actor::Property::POSITION, Vector2(0.0f, 0.0f));
745 return mFocusIndicatorActor;
748 void KeyboardFocusManager::OnKeyEvent(const KeyEvent& event)
750 AccessibilityAdaptor accessibilityAdaptor = AccessibilityAdaptor::Get();
751 bool isAccessibilityEnabled = accessibilityAdaptor.IsEnabled();
753 Toolkit::AccessibilityManager accessibilityManager = Toolkit::AccessibilityManager::Get();
755 std::string keyName = event.keyPressedName;
757 if( mIsFocusIndicatorShown == UNKNOWN )
759 GetConfigurationFromStyleManger();
762 bool isFocusStartableKey = false;
764 if(event.state == KeyEvent::Down)
766 if (keyName == "Left")
768 if(!isAccessibilityEnabled)
770 if(mIsFocusIndicatorShown == HIDE)
772 // Show focus indicator
773 mIsFocusIndicatorShown = SHOW;
777 // Move the focus towards left
778 MoveFocus(Toolkit::Control::KeyboardFocus::LEFT);
781 isFocusStartableKey = true;
785 // Move the accessibility focus backward
786 accessibilityManager.MoveFocusBackward();
789 else if (keyName == "Right")
791 if(!isAccessibilityEnabled)
793 if( mIsFocusIndicatorShown == HIDE )
795 // Show focus indicator
796 mIsFocusIndicatorShown = SHOW;
800 // Move the focus towards right
801 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT);
806 // Move the accessibility focus forward
807 accessibilityManager.MoveFocusForward();
810 isFocusStartableKey = true;
812 else if (keyName == "Up" && !isAccessibilityEnabled)
814 if( mIsFocusIndicatorShown == HIDE )
816 // Show focus indicator
817 mIsFocusIndicatorShown = SHOW;
821 // Move the focus towards up
822 MoveFocus(Toolkit::Control::KeyboardFocus::UP);
825 isFocusStartableKey = true;
827 else if (keyName == "Down" && !isAccessibilityEnabled)
829 if( mIsFocusIndicatorShown == HIDE )
831 // Show focus indicator
832 mIsFocusIndicatorShown = SHOW;
836 // Move the focus towards down
837 MoveFocus(Toolkit::Control::KeyboardFocus::DOWN);
840 isFocusStartableKey = true;
842 else if (keyName == "Prior" && !isAccessibilityEnabled)
844 if( mIsFocusIndicatorShown == HIDE )
846 // Show focus indicator
847 mIsFocusIndicatorShown = SHOW;
851 // Move the focus towards the previous page
852 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_UP);
855 isFocusStartableKey = true;
857 else if (keyName == "Next" && !isAccessibilityEnabled)
859 if( mIsFocusIndicatorShown == HIDE )
861 // Show focus indicator
862 mIsFocusIndicatorShown = SHOW;
866 // Move the focus towards the next page
867 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_DOWN);
870 isFocusStartableKey = true;
872 else if (keyName == "Tab" && !isAccessibilityEnabled)
874 if( mIsFocusIndicatorShown == HIDE )
876 // Show focus indicator
877 mIsFocusIndicatorShown = SHOW;
881 // "Tab" key changes the focus group in the forward direction and
882 // "Shift-Tab" key changes it in the backward direction.
883 DoMoveFocusToNextFocusGroup(!event.IsShiftModifier());
886 isFocusStartableKey = true;
888 else if (keyName == "space" && !isAccessibilityEnabled)
890 if( mIsFocusIndicatorShown == HIDE )
892 // Show focus indicator
893 mIsFocusIndicatorShown = SHOW;
896 isFocusStartableKey = true;
898 else if (keyName == "" && !isAccessibilityEnabled)
900 // Check the fake key event for evas-plugin case
901 if( mIsFocusIndicatorShown == HIDE )
903 // Show focus indicator
904 mIsFocusIndicatorShown = SHOW;
907 isFocusStartableKey = true;
909 else if (keyName == "Backspace" && !isAccessibilityEnabled)
911 // Emit signal to go back to the previous view???
913 else if (keyName == "Escape" && !isAccessibilityEnabled)
917 else if(event.state == KeyEvent::Up)
919 if (keyName == "Return")
921 if((mIsFocusIndicatorShown == HIDE) && !isAccessibilityEnabled)
923 // Show focus indicator
924 mIsFocusIndicatorShown = SHOW;
928 // The focused actor has enter pressed on it
930 if( !isAccessibilityEnabled )
932 actor = GetCurrentFocusActor();
936 actor = accessibilityManager.GetCurrentFocusActor();
941 DoKeyboardEnter( actor );
945 isFocusStartableKey = true;
949 if(isFocusStartableKey && ( mIsFocusIndicatorShown == SHOW ) && !isAccessibilityEnabled)
951 Actor actor = GetCurrentFocusActor();
954 if( mEnableFocusIndicator == ENABLE )
956 // Make sure the focused actor is highlighted
957 actor.Add( GetFocusIndicatorActor() );
962 // No actor is focused but keyboard focus is activated by the key press
963 // Let's try to move the initial focus
964 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT);
969 void KeyboardFocusManager::OnTouch(const TouchData& touch)
971 // if mIsFocusIndicatorShown is UNKNOWN, it means Configuration is not loaded.
972 // Try to load configuration.
973 if( mIsFocusIndicatorShown == UNKNOWN )
975 GetConfigurationFromStyleManger();
978 // Clear the focus when user touch the screen.
979 // We only do this on a Down event, otherwise the clear action may override a manually focused actor.
980 // If mClearFocusOnTouch is false, do not clear the focus even if user touch the screen.
981 if( (( touch.GetPointCount() < 1 ) || ( touch.GetState( 0 ) == PointState::DOWN )) && mClearFocusOnTouch )
987 void KeyboardFocusManager::OnWindowFocusChanged(Window window, bool focusIn )
989 if( focusIn && mCurrentFocusedWindow.GetHandle() != window.GetRootLayer() )
991 // Change Current Focused Window
992 Layer rootLayer = window.GetRootLayer();
993 mCurrentFocusedWindow = rootLayer;
995 // Get Current Focused Actor from window
996 Actor currentFocusedActor = GetFocusActorFromCurrentWindow();
997 SetCurrentFocusActor( currentFocusedActor );
999 if( currentFocusedActor && ( mEnableFocusIndicator == ENABLE ) )
1001 // Make sure the focused actor is highlighted
1002 currentFocusedActor.Add( GetFocusIndicatorActor() );
1003 mIsFocusIndicatorShown = SHOW;
1008 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& KeyboardFocusManager::PreFocusChangeSignal()
1010 return mPreFocusChangeSignal;
1013 Toolkit::KeyboardFocusManager::FocusChangedSignalType& KeyboardFocusManager::FocusChangedSignal()
1015 return mFocusChangedSignal;
1018 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& KeyboardFocusManager::FocusGroupChangedSignal()
1020 return mFocusGroupChangedSignal;
1023 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& KeyboardFocusManager::FocusedActorEnterKeySignal()
1025 return mFocusedActorEnterKeySignal;
1028 bool KeyboardFocusManager::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
1030 Dali::BaseHandle handle( object );
1032 bool connected( true );
1033 KeyboardFocusManager* manager = static_cast< KeyboardFocusManager* >( object ); // TypeRegistry guarantees that this is the correct type.
1035 if( 0 == strcmp( signalName.c_str(), SIGNAL_PRE_FOCUS_CHANGE ) )
1037 manager->PreFocusChangeSignal().Connect( tracker, functor );
1039 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUS_CHANGED ) )
1041 manager->FocusChangedSignal().Connect( tracker, functor );
1043 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUS_GROUP_CHANGED ) )
1045 manager->FocusGroupChangedSignal().Connect( tracker, functor );
1047 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUSED_ACTOR_ENTER_KEY ) )
1049 manager->FocusedActorEnterKeySignal().Connect( tracker, functor );
1053 // signalName does not match any signal
1060 void KeyboardFocusManager::SetCustomAlgorithm(CustomAlgorithmInterface& interface)
1062 mCustomAlgorithmInterface = &interface;
1065 void KeyboardFocusManager::EnableFocusIndicator(bool enable)
1067 if( !enable && mFocusIndicatorActor )
1069 mFocusIndicatorActor.Unparent();
1072 mEnableFocusIndicator = enable? ENABLE : DISABLE;
1076 bool KeyboardFocusManager::IsFocusIndicatorEnabled() const
1078 return ( mEnableFocusIndicator == ENABLE );
1081 } // namespace Internal
1083 } // namespace Toolkit