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/common/singleton-service.h>
25 #include <dali/devel-api/adaptor-framework/lifecycle-controller.h>
26 #include <dali/public-api/animation/constraints.h>
27 #include <dali/public-api/events/key-event.h>
28 #include <dali/public-api/events/touch-event.h>
29 #include <dali/public-api/object/type-registry.h>
30 #include <dali/public-api/object/type-registry-helper.h>
31 #include <dali/public-api/object/property-map.h>
32 #include <dali/integration-api/debug.h>
33 #include <dali/integration-api/adaptor-framework/adaptor.h>
34 #include <dali/integration-api/adaptor-framework/scene-holder.h>
37 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
38 #include <dali-toolkit/public-api/controls/control.h>
39 #include <dali-toolkit/public-api/controls/control-impl.h>
40 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
41 #include <dali-toolkit/devel-api/controls/control-devel.h>
42 #include <dali-toolkit/public-api/styling/style-manager.h>
43 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
44 #include <dali/devel-api/adaptor-framework/accessibility.h>
55 namespace // Unnamed namespace
58 #if defined(DEBUG_ENABLED)
59 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_KEYBOARD_FOCUS_MANAGER");
62 const char* const IS_FOCUS_GROUP_PROPERTY_NAME = "isKeyboardFocusGroup"; // This property will be replaced by a flag in Control.
64 const char* const FOCUS_BORDER_IMAGE_FILE_NAME = "keyboard_focus.9.png";
68 BaseHandle handle = KeyboardFocusManager::Get();
72 SingletonService singletonService( SingletonService::Get() );
73 if ( singletonService )
75 Toolkit::KeyboardFocusManager manager = Toolkit::KeyboardFocusManager( new Internal::KeyboardFocusManager() );
76 singletonService.Register( typeid( manager ), manager );
84 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::KeyboardFocusManager, Dali::BaseHandle, Create, true )
86 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardPreFocusChange", SIGNAL_PRE_FOCUS_CHANGE )
87 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusChanged", SIGNAL_FOCUS_CHANGED )
88 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusGroupChanged", SIGNAL_FOCUS_GROUP_CHANGED )
89 DALI_SIGNAL_REGISTRATION( Toolkit, KeyboardFocusManager, "keyboardFocusedActorEnterKey", SIGNAL_FOCUSED_ACTOR_ENTER_KEY )
91 DALI_TYPE_REGISTRATION_END()
93 const unsigned int MAX_HISTORY_AMOUNT = 30; ///< Max length of focus history stack
95 } // unnamed namespace
97 Toolkit::KeyboardFocusManager KeyboardFocusManager::Get()
99 Toolkit::KeyboardFocusManager manager;
101 SingletonService singletonService( SingletonService::Get() );
102 if ( singletonService )
104 // Check whether the keyboard focus manager is already created
105 Dali::BaseHandle handle = singletonService.GetSingleton( typeid( Toolkit::KeyboardFocusManager ) );
108 // If so, downcast the handle of singleton to keyboard focus manager
109 manager = Toolkit::KeyboardFocusManager( dynamic_cast< KeyboardFocusManager* >( handle.GetObjectPtr() ) );
116 KeyboardFocusManager::KeyboardFocusManager()
117 : mPreFocusChangeSignal(),
118 mFocusChangedSignal(),
119 mFocusGroupChangedSignal(),
120 mFocusedActorEnterKeySignal(),
121 mCurrentFocusActor(),
122 mFocusIndicatorActor(),
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 )
134 // TODO: Get FocusIndicatorEnable constant from stylesheet to set mIsFocusIndicatorShown.
136 LifecycleController::Get().InitSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnAdaptorInit );
139 void KeyboardFocusManager::OnAdaptorInit()
141 if( Adaptor::IsAvailable() )
143 // Retrieve all the existing scene holders
144 Dali::SceneHolderList sceneHolders = Adaptor::Get().GetSceneHolders();
145 for( auto iter = sceneHolders.begin(); iter != sceneHolders.end(); ++iter )
147 ( *iter ).KeyEventSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnKeyEvent );
148 ( *iter ).TouchedSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnTouch );
149 Dali::Window window = DevelWindow::DownCast( *iter );
152 window.FocusChangeSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
156 // Get notified when any new scene holder is created afterwards
157 Adaptor::Get().WindowCreatedSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnSceneHolderCreated );
161 void KeyboardFocusManager::OnSceneHolderCreated( Dali::Integration::SceneHolder& sceneHolder )
163 sceneHolder.KeyEventSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnKeyEvent );
164 sceneHolder.TouchedSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnTouch );
165 Dali::Window window = DevelWindow::DownCast( sceneHolder );
168 window.FocusChangeSignal().Connect( mSlotDelegate, &KeyboardFocusManager::OnWindowFocusChanged);
172 KeyboardFocusManager::~KeyboardFocusManager()
176 void KeyboardFocusManager::GetConfigurationFromStyleManger()
178 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
181 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
182 mAlwaysShowIndicator = config["alwaysShowFocus"].Get<bool>() ? ALWAYS_SHOW : NONE;
183 mIsFocusIndicatorShown = ( mAlwaysShowIndicator == ALWAYS_SHOW )? SHOW : HIDE;
184 mClearFocusOnTouch = ( mIsFocusIndicatorShown == SHOW ) ? false : true;
188 bool KeyboardFocusManager::SetCurrentFocusActor( Actor actor )
190 DALI_ASSERT_DEBUG( !mIsWaitingKeyboardFocusChangeCommit && "Calling this function in the PreFocusChangeSignal callback?" );
192 if( mIsFocusIndicatorShown == UNKNOWN )
194 GetConfigurationFromStyleManger();
197 return DoSetCurrentFocusActor( actor );
200 bool KeyboardFocusManager::DoSetCurrentFocusActor( Actor actor )
202 bool success = false;
203 if( actor && actor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) && actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
205 Integration::SceneHolder currentWindow = Integration::SceneHolder::Get( actor );
207 if( currentWindow.GetRootLayer() != mCurrentFocusedWindow.GetHandle())
209 Layer rootLayer = currentWindow.GetRootLayer();
210 mCurrentFocusedWindow = rootLayer;
214 Actor currentFocusedActor = GetCurrentFocusActor();
216 // If developer set focus on same actor, doing nothing
217 if( actor == currentFocusedActor )
226 // Check whether the actor is in the stage and is keyboard focusable.
227 if( actor && actor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) && actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
229 if( ( mIsFocusIndicatorShown == SHOW ) && ( mEnableFocusIndicator == ENABLE ) )
231 actor.Add( GetFocusIndicatorActor() );
234 // Send notification for the change of focus actor
235 if( !mFocusChangedSignal.Empty() )
237 mFocusChangedSignal.Emit(currentFocusedActor, actor);
240 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast(currentFocusedActor);
241 if( currentlyFocusedControl )
243 // Do we need it to remember if it was previously DISABLED?
244 currentlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::NORMAL );
245 currentlyFocusedControl.ClearKeyInputFocus();
248 DALI_LOG_INFO( gLogFilter, Debug::General, "[%s:%d] Focus Changed\n", __FUNCTION__, __LINE__);
250 // Save the current focused actor
251 mCurrentFocusActor = actor;
253 bool focusedWindowFound = false;
254 for( unsigned int i = 0; i < mCurrentFocusActors.size(); i++ )
256 if( mCurrentFocusActors[i].first == mCurrentFocusedWindow )
258 mCurrentFocusActors[i].second = actor;
259 focusedWindowFound = true;
263 if( !focusedWindowFound)
265 // A new window gains the focus, so store the focused actor in that window.
266 mCurrentFocusActors.push_back( std::pair< WeakHandle< Layer>, WeakHandle< Actor > >( mCurrentFocusedWindow , actor ));
269 Toolkit::Control newlyFocusedControl = Toolkit::Control::DownCast(actor);
270 if( newlyFocusedControl )
272 newlyFocusedControl.SetProperty(DevelControl::Property::STATE, DevelControl::FOCUSED );
273 newlyFocusedControl.SetKeyInputFocus();
276 // Push Current Focused Actor to FocusHistory
277 mFocusHistory.push_back( actor );
279 // Delete first element before add new element when Stack is full.
280 if( mFocusHistory.size() > MAX_HISTORY_AMOUNT )
282 FocusStackIterator beginPos = mFocusHistory.begin();
283 mFocusHistory.erase( beginPos );
286 DALI_LOG_INFO( gLogFilter, Debug::General, "[%s:%d] SUCCEED\n", __FUNCTION__, __LINE__);
291 DALI_LOG_WARNING("[%s:%d] FAILED\n", __FUNCTION__, __LINE__);
297 Actor KeyboardFocusManager::GetCurrentFocusActor()
299 Actor actor = mCurrentFocusActor.GetHandle();
301 if( actor && ! actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
303 // If the actor has been removed from the stage, then it should not be focused
305 mCurrentFocusActor.Reset();
310 Actor KeyboardFocusManager::GetFocusActorFromCurrentWindow()
314 for( index = 0; index < mCurrentFocusActors.size(); index++ )
316 if( mCurrentFocusActors[index].first == mCurrentFocusedWindow )
318 actor = mCurrentFocusActors[index].second.GetHandle();
323 if( actor && ! actor.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
325 // If the actor has been removed from the window, then the window doesn't have any focused actor
327 mCurrentFocusActors.erase( mCurrentFocusActors.begin() + index );
333 Actor KeyboardFocusManager::GetCurrentFocusGroup()
335 return GetFocusGroup(GetCurrentFocusActor());
338 void KeyboardFocusManager::MoveFocusBackward()
340 // Find Pre Focused Actor when the list size is more than 1
341 if( mFocusHistory.size() > 1 )
343 // Delete current focused actor in history
344 mFocusHistory.pop_back();
346 // If pre-focused actors are not on stage or deleted, remove them in stack
347 while( mFocusHistory.size() > 0 )
349 // Get pre focused actor
350 Actor target = mFocusHistory[ mFocusHistory.size() -1 ].GetHandle();
352 // Impl of Actor is not null
353 if( target && target.GetProperty< bool >( Actor::Property::CONNECTED_TO_SCENE ) )
355 // Delete pre focused actor in history because it will pushed again by SetCurrentFocusActor()
356 mFocusHistory.pop_back();
357 SetCurrentFocusActor( target );
362 // Target is empty handle or off stage. Erase from queue
363 mFocusHistory.pop_back();
367 // if there is no actor which can get focus, then push current focus actor in stack again
368 if( mFocusHistory.size() == 0 )
370 Actor currentFocusedActor = GetCurrentFocusActor();
371 mFocusHistory.push_back( currentFocusedActor );
376 bool KeyboardFocusManager::IsLayoutControl(Actor actor) const
378 Toolkit::Control control = Toolkit::Control::DownCast(actor);
379 return control && GetImplementation( control ).IsKeyboardNavigationSupported();
382 Toolkit::Control KeyboardFocusManager::GetParentLayoutControl(Actor actor) const
384 // Get the actor's parent layout control that supports two dimensional keyboard navigation
389 Integration::SceneHolder window = Integration::SceneHolder::Get( actor );
392 rootActor = window.GetRootLayer();
395 parent = actor.GetParent();
398 while( parent && !IsLayoutControl(parent) && parent != rootActor )
400 parent = parent.GetParent();
403 return Toolkit::Control::DownCast(parent);
406 bool KeyboardFocusManager::MoveFocus(Toolkit::Control::KeyboardFocus::Direction direction)
408 Actor currentFocusActor = GetCurrentFocusActor();
410 bool succeed = false;
412 // Go through the actor's hierarchy until we find a layout control that knows how to move the focus
413 Toolkit::Control parentLayoutControl = GetParentLayoutControl( currentFocusActor );
414 while( parentLayoutControl && !succeed )
416 succeed = DoMoveFocusWithinLayoutControl( parentLayoutControl, currentFocusActor, direction );
417 parentLayoutControl = GetParentLayoutControl( parentLayoutControl );
422 Actor nextFocusableActor;
424 Toolkit::Control currentFocusControl = Toolkit::Control::DownCast(currentFocusActor);
426 // If the current focused actor is a control, then find the next focusable actor via the focusable properties.
427 if( currentFocusControl )
430 Property::Index index = Property::INVALID_INDEX;
431 Property::Value value;
433 // Find property index based upon focus direction
436 case Toolkit::Control::KeyboardFocus::LEFT:
438 index = Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID;
441 case Toolkit::Control::KeyboardFocus::RIGHT:
443 index = Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID;
446 case Toolkit::Control::KeyboardFocus::UP:
448 index = Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID;
451 case Toolkit::Control::KeyboardFocus::DOWN:
453 index = Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID;
460 // If the focusable property is set then determine next focusable actor
461 if( index != Property::INVALID_INDEX)
463 value = currentFocusActor.GetProperty( index );
464 actorId = value.Get<int>();
466 // If actor's id is valid then find actor form actor's id. The actor should be on the stage.
469 if( currentFocusActor.GetParent() )
471 nextFocusableActor = currentFocusActor.GetParent().FindChildById( actorId );
474 if( !nextFocusableActor )
476 Integration::SceneHolder window = Integration::SceneHolder::Get( currentFocusActor );
479 nextFocusableActor = window.GetRootLayer().FindChildById( actorId );
486 if( !nextFocusableActor )
488 // If the implementation of CustomAlgorithmInterface is provided then the PreFocusChangeSignal is no longer emitted.
489 if( mCustomAlgorithmInterface )
491 mIsWaitingKeyboardFocusChangeCommit = true;
492 nextFocusableActor = mCustomAlgorithmInterface->GetNextFocusableActor( currentFocusActor, Actor(), direction );
493 mIsWaitingKeyboardFocusChangeCommit = false;
495 else if( !mPreFocusChangeSignal.Empty() )
497 // Don't know how to move the focus further. The application needs to tell us which actor to move the focus to
498 mIsWaitingKeyboardFocusChangeCommit = true;
499 nextFocusableActor = mPreFocusChangeSignal.Emit( currentFocusActor, Actor(), direction );
500 mIsWaitingKeyboardFocusChangeCommit = false;
504 if( nextFocusableActor && nextFocusableActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ) )
506 // Whether the next focusable actor is a layout control
507 if( IsLayoutControl( nextFocusableActor ) )
509 // If so, move the focus inside it.
510 Toolkit::Control layoutControl = Toolkit::Control::DownCast( nextFocusableActor) ;
511 succeed = DoMoveFocusWithinLayoutControl( layoutControl, currentFocusActor, direction );
515 // Otherwise, just set focus to the next focusable actor
516 succeed = SetCurrentFocusActor( nextFocusableActor );
524 bool KeyboardFocusManager::DoMoveFocusWithinLayoutControl(Toolkit::Control control, Actor actor, Toolkit::Control::KeyboardFocus::Direction direction)
526 // Ask the control for the next actor to focus
527 Actor nextFocusableActor = GetImplementation( control ).GetNextKeyboardFocusableActor(actor, direction, mFocusGroupLoopEnabled);
528 if(nextFocusableActor)
530 if(!nextFocusableActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ))
532 // If the actor is not focusable, ask the same layout control for the next actor to focus
533 return DoMoveFocusWithinLayoutControl(control, nextFocusableActor, direction);
537 Actor currentFocusActor = GetCurrentFocusActor();
538 Actor committedFocusActor = nextFocusableActor;
540 // We will try to move the focus to the actor. Emit a signal to notify the proposed actor to focus
541 // Signal handler can check the proposed actor and return a different actor if it wishes.
542 if( !mPreFocusChangeSignal.Empty() )
544 mIsWaitingKeyboardFocusChangeCommit = true;
545 committedFocusActor = mPreFocusChangeSignal.Emit(currentFocusActor, nextFocusableActor, direction);
546 mIsWaitingKeyboardFocusChangeCommit = false;
549 if (committedFocusActor && committedFocusActor.GetProperty< bool >( Actor::Property::KEYBOARD_FOCUSABLE ))
551 // Whether the commited focusable actor is a layout control
552 if(IsLayoutControl(committedFocusActor))
554 // If so, move the focus inside it.
555 Toolkit::Control layoutControl = Toolkit::Control::DownCast(committedFocusActor);
556 return DoMoveFocusWithinLayoutControl(layoutControl, currentFocusActor, direction);
560 // Otherwise, just set focus to the next focusable actor
561 if(committedFocusActor == nextFocusableActor)
563 // If the application hasn't changed our proposed actor, we informs the layout control we will
564 // move the focus to what the control returns. The control might wish to perform some actions
565 // before the focus is actually moved.
566 GetImplementation( control ).OnKeyboardFocusChangeCommitted( committedFocusActor );
569 return SetCurrentFocusActor(committedFocusActor);
580 // No more actor can be focused in the given direction within the same layout control.
585 bool KeyboardFocusManager::DoMoveFocusToNextFocusGroup(bool forward)
587 bool succeed = false;
589 // Get the parent layout control of the current focus group
590 Toolkit::Control parentLayoutControl = GetParentLayoutControl(GetCurrentFocusGroup());
592 while(parentLayoutControl && !succeed)
594 // If the current focus group has a parent layout control, we can probably automatically
595 // move the focus to the next focus group in the forward or backward direction.
596 Toolkit::Control::KeyboardFocus::Direction direction = forward ? Toolkit::Control::KeyboardFocus::RIGHT : Toolkit::Control::KeyboardFocus::LEFT;
597 succeed = DoMoveFocusWithinLayoutControl(parentLayoutControl, GetCurrentFocusActor(), direction);
598 parentLayoutControl = GetParentLayoutControl(parentLayoutControl);
601 if(!mFocusGroupChangedSignal.Empty())
603 // Emit a focus group changed signal. The applicaton can move the focus to a new focus group
604 mFocusGroupChangedSignal.Emit(GetCurrentFocusActor(), forward);
610 void KeyboardFocusManager::DoKeyboardEnter(Actor actor)
614 Toolkit::Control control = Toolkit::Control::DownCast( actor );
617 // Notify the control that enter has been pressed on it.
618 GetImplementation( control ).KeyboardEnter();
621 // Send a notification for the actor.
622 if( !mFocusedActorEnterKeySignal.Empty() )
624 mFocusedActorEnterKeySignal.Emit( actor );
629 void KeyboardFocusManager::ClearFocus()
631 Actor actor = GetCurrentFocusActor();
634 if( mFocusIndicatorActor )
636 actor.Remove( mFocusIndicatorActor );
639 // Send notification for the change of focus actor
640 if( !mFocusChangedSignal.Empty() )
642 mFocusChangedSignal.Emit( actor, Actor() );
645 Toolkit::Control currentlyFocusedControl = Toolkit::Control::DownCast( actor );
646 if( currentlyFocusedControl )
648 currentlyFocusedControl.SetProperty( DevelControl::Property::STATE, DevelControl::NORMAL );
649 currentlyFocusedControl.ClearKeyInputFocus();
653 mCurrentFocusActor.Reset();
654 mIsFocusIndicatorShown = ( mAlwaysShowIndicator == ALWAYS_SHOW ) ? SHOW : HIDE;
657 void KeyboardFocusManager::SetFocusGroupLoop(bool enabled)
659 mFocusGroupLoopEnabled = enabled;
662 bool KeyboardFocusManager::GetFocusGroupLoop() const
664 return mFocusGroupLoopEnabled;
667 void KeyboardFocusManager::SetAsFocusGroup(Actor actor, bool isFocusGroup)
671 // Create/Set focus group property.
672 actor.RegisterProperty( IS_FOCUS_GROUP_PROPERTY_NAME, isFocusGroup, Property::READ_WRITE );
676 bool KeyboardFocusManager::IsFocusGroup(Actor actor) const
678 // Check whether the actor is a focus group
679 bool isFocusGroup = false;
683 Property::Index propertyIsFocusGroup = actor.GetPropertyIndex(IS_FOCUS_GROUP_PROPERTY_NAME);
684 if(propertyIsFocusGroup != Property::INVALID_INDEX)
686 isFocusGroup = actor.GetProperty<bool>(propertyIsFocusGroup);
693 Actor KeyboardFocusManager::GetFocusGroup(Actor actor)
695 // Go through the actor's hierarchy to check which focus group the actor belongs to
696 while (actor && !IsFocusGroup(actor))
698 actor = actor.GetParent();
704 void KeyboardFocusManager::SetFocusIndicatorActor(Actor indicator)
706 if(mFocusIndicatorActor != indicator)
708 Actor currentFocusActor = GetCurrentFocusActor();
709 if(currentFocusActor)
711 // The new focus indicator should be added to the current focused actor immediately
712 if(mFocusIndicatorActor)
714 currentFocusActor.Remove(mFocusIndicatorActor);
719 currentFocusActor.Add(indicator);
723 mFocusIndicatorActor = indicator;
727 Actor KeyboardFocusManager::GetFocusIndicatorActor()
729 if( ! mFocusIndicatorActor )
731 // Create the default if it hasn't been set and one that's shared by all the keyboard focusable actors
732 const std::string imageDirPath = AssetManager::GetDaliImagePath();
733 mFocusIndicatorActor = Toolkit::ImageView::New( imageDirPath + FOCUS_BORDER_IMAGE_FILE_NAME );
735 // Apply size constraint to the focus indicator
736 mFocusIndicatorActor.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
739 mFocusIndicatorActor.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
740 mFocusIndicatorActor.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
741 mFocusIndicatorActor.SetProperty( Actor::Property::POSITION, Vector2(0.0f, 0.0f));
743 return mFocusIndicatorActor;
746 void KeyboardFocusManager::OnKeyEvent(const KeyEvent& event)
748 std::string keyName = event.GetKeyName();
750 if( mIsFocusIndicatorShown == UNKNOWN )
752 GetConfigurationFromStyleManger();
755 bool isFocusStartableKey = false;
757 if(event.GetState() == KeyEvent::DOWN)
759 if (keyName == "Left")
761 if(!mIsFocusIndicatorShown)
763 if(mIsFocusIndicatorShown == HIDE)
765 // Show focus indicator
766 mIsFocusIndicatorShown = SHOW;
770 // Move the focus towards left
771 MoveFocus(Toolkit::Control::KeyboardFocus::LEFT);
774 isFocusStartableKey = true;
778 // Move the focus towards left
779 MoveFocus(Toolkit::Control::KeyboardFocus::LEFT);
782 isFocusStartableKey = true;
784 else if (keyName == "Right")
786 if(!mIsFocusIndicatorShown)
788 if( mIsFocusIndicatorShown == HIDE )
790 // Show focus indicator
791 mIsFocusIndicatorShown = SHOW;
795 // Move the focus towards right
796 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT);
801 // Move the focus towards right
802 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT);
805 isFocusStartableKey = true;
807 else if (keyName == "Up")
809 if( mIsFocusIndicatorShown == HIDE )
811 // Show focus indicator
812 mIsFocusIndicatorShown = SHOW;
816 // Move the focus towards up
817 MoveFocus(Toolkit::Control::KeyboardFocus::UP);
820 isFocusStartableKey = true;
822 else if (keyName == "Down")
824 if( mIsFocusIndicatorShown == HIDE )
826 // Show focus indicator
827 mIsFocusIndicatorShown = SHOW;
831 // Move the focus towards down
832 MoveFocus(Toolkit::Control::KeyboardFocus::DOWN);
835 isFocusStartableKey = true;
837 else if (keyName == "Prior")
839 if( mIsFocusIndicatorShown == HIDE )
841 // Show focus indicator
842 mIsFocusIndicatorShown = SHOW;
846 // Move the focus towards the previous page
847 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_UP);
850 isFocusStartableKey = true;
852 else if (keyName == "Next")
854 if( mIsFocusIndicatorShown == HIDE )
856 // Show focus indicator
857 mIsFocusIndicatorShown = SHOW;
861 // Move the focus towards the next page
862 MoveFocus(Toolkit::Control::KeyboardFocus::PAGE_DOWN);
865 isFocusStartableKey = true;
867 else if (keyName == "Tab")
869 if( mIsFocusIndicatorShown == HIDE )
871 // Show focus indicator
872 mIsFocusIndicatorShown = SHOW;
876 // "Tab" key changes the focus group in the forward direction and
877 // "Shift-Tab" key changes it in the backward direction.
878 DoMoveFocusToNextFocusGroup(!event.IsShiftModifier());
881 isFocusStartableKey = true;
883 else if (keyName == "space")
885 if( mIsFocusIndicatorShown == HIDE )
887 // Show focus indicator
888 mIsFocusIndicatorShown = SHOW;
891 isFocusStartableKey = true;
893 else if (keyName == "")
895 // Check the fake key event for evas-plugin case
896 if( mIsFocusIndicatorShown == HIDE )
898 // Show focus indicator
899 mIsFocusIndicatorShown = SHOW;
902 isFocusStartableKey = true;
904 else if (keyName == "Backspace")
906 // Emit signal to go back to the previous view???
908 else if (keyName == "Escape")
912 else if(event.GetState() == KeyEvent::UP)
914 if (keyName == "Return")
916 if( mIsFocusIndicatorShown == HIDE )
918 // Show focus indicator
919 mIsFocusIndicatorShown = SHOW;
923 // The focused actor has enter pressed on it
924 Actor actor = GetCurrentFocusActor();
927 DoKeyboardEnter( actor );
931 isFocusStartableKey = true;
935 if( isFocusStartableKey && mIsFocusIndicatorShown == SHOW )
937 Actor actor = GetCurrentFocusActor();
940 if( mEnableFocusIndicator == ENABLE )
942 // Make sure the focused actor is highlighted
943 actor.Add( GetFocusIndicatorActor() );
948 // No actor is focused but keyboard focus is activated by the key press
949 // Let's try to move the initial focus
950 MoveFocus(Toolkit::Control::KeyboardFocus::RIGHT);
956 void KeyboardFocusManager::OnTouch(const TouchEvent& touch)
958 // if mIsFocusIndicatorShown is UNKNOWN, it means Configuration is not loaded.
959 // Try to load configuration.
960 if( mIsFocusIndicatorShown == UNKNOWN )
962 GetConfigurationFromStyleManger();
965 // Clear the focus when user touch the screen.
966 // We only do this on a Down event, otherwise the clear action may override a manually focused actor.
967 // If mClearFocusOnTouch is false, do not clear the focus even if user touch the screen.
968 if( (( touch.GetPointCount() < 1 ) || ( touch.GetState( 0 ) == PointState::DOWN )) && mClearFocusOnTouch )
974 void KeyboardFocusManager::OnWindowFocusChanged(Window window, bool focusIn )
976 if( focusIn && mCurrentFocusedWindow.GetHandle() != window.GetRootLayer() )
978 // Change Current Focused Window
979 Layer rootLayer = window.GetRootLayer();
980 mCurrentFocusedWindow = rootLayer;
982 // Get Current Focused Actor from window
983 Actor currentFocusedActor = GetFocusActorFromCurrentWindow();
984 SetCurrentFocusActor( currentFocusedActor );
986 if( currentFocusedActor && ( mEnableFocusIndicator == ENABLE ) )
988 // Make sure the focused actor is highlighted
989 currentFocusedActor.Add( GetFocusIndicatorActor() );
990 mIsFocusIndicatorShown = SHOW;
995 Toolkit::KeyboardFocusManager::PreFocusChangeSignalType& KeyboardFocusManager::PreFocusChangeSignal()
997 return mPreFocusChangeSignal;
1000 Toolkit::KeyboardFocusManager::FocusChangedSignalType& KeyboardFocusManager::FocusChangedSignal()
1002 return mFocusChangedSignal;
1005 Toolkit::KeyboardFocusManager::FocusGroupChangedSignalType& KeyboardFocusManager::FocusGroupChangedSignal()
1007 return mFocusGroupChangedSignal;
1010 Toolkit::KeyboardFocusManager::FocusedActorEnterKeySignalType& KeyboardFocusManager::FocusedActorEnterKeySignal()
1012 return mFocusedActorEnterKeySignal;
1015 bool KeyboardFocusManager::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
1017 Dali::BaseHandle handle( object );
1019 bool connected( true );
1020 KeyboardFocusManager* manager = static_cast< KeyboardFocusManager* >( object ); // TypeRegistry guarantees that this is the correct type.
1022 if( 0 == strcmp( signalName.c_str(), SIGNAL_PRE_FOCUS_CHANGE ) )
1024 manager->PreFocusChangeSignal().Connect( tracker, functor );
1026 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUS_CHANGED ) )
1028 manager->FocusChangedSignal().Connect( tracker, functor );
1030 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUS_GROUP_CHANGED ) )
1032 manager->FocusGroupChangedSignal().Connect( tracker, functor );
1034 else if( 0 == strcmp( signalName.c_str(), SIGNAL_FOCUSED_ACTOR_ENTER_KEY ) )
1036 manager->FocusedActorEnterKeySignal().Connect( tracker, functor );
1040 // signalName does not match any signal
1047 void KeyboardFocusManager::SetCustomAlgorithm(CustomAlgorithmInterface& interface)
1049 mCustomAlgorithmInterface = &interface;
1052 void KeyboardFocusManager::EnableFocusIndicator(bool enable)
1054 if( !enable && mFocusIndicatorActor )
1056 mFocusIndicatorActor.Unparent();
1059 mEnableFocusIndicator = enable? ENABLE : DISABLE;
1063 bool KeyboardFocusManager::IsFocusIndicatorEnabled() const
1065 return ( mEnableFocusIndicator == ENABLE );
1068 } // namespace Internal
1070 } // namespace Toolkit