dali-toolkit/internal/controls/control/control-data-impl.cpp

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "control-data-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/devel-api/object/handle-devel.h>
  25 #include <dali/devel-api/scripting/enum-helper.h>
  26 #include <dali/devel-api/scripting/scripting.h>
  27 #include <dali/integration-api/debug.h>
  28 #include <dali/public-api/object/type-registry-helper.h>
  29 #include <cstring>
  30 #include <limits>
  31
  32 // INTERNAL INCLUDES
  33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  34 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  36 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  37 #include <dali-toolkit/devel-api/controls/control-devel.h>
  38 #include <dali-toolkit/devel-api/controls/control-wrapper-impl.h>
  39 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  40 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  41
  42 namespace Dali
  43 {
  44
  45 namespace Toolkit
  46 {
  47
  48 namespace Internal
  49 {
  50
  51 extern const Dali::Scripting::StringEnum ControlStateTable[];
  52 extern const unsigned int ControlStateTableCount;
  53
  54
  55 // Not static or anonymous - shared with other translation units
  56 const Scripting::StringEnum ControlStateTable[] = {
  57   { "NORMAL",   Toolkit::DevelControl::NORMAL   },
  58   { "FOCUSED",  Toolkit::DevelControl::FOCUSED  },
  59   { "DISABLED", Toolkit::DevelControl::DISABLED },
  60 };
  61 const unsigned int ControlStateTableCount = sizeof( ControlStateTable ) / sizeof( ControlStateTable[0] );
  62
  63
  64
  65 namespace
  66 {
  67
  68 #if defined(DEBUG_ENABLED)
  69 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
  70 #endif
  71
  72
  73 template<typename T>
  74 void Remove( Dictionary<T>& keyValues, const std::string& name )
  75 {
  76   keyValues.Remove(name);
  77 }
  78
  79 void Remove( DictionaryKeys& keys, const std::string& name )
  80 {
  81   DictionaryKeys::iterator iter = std::find( keys.begin(), keys.end(), name );
  82   if( iter != keys.end())
  83   {
  84     keys.erase(iter);
  85   }
  86 }
  87
  88 Toolkit::Visual::Type GetVisualTypeFromMap( const Property::Map& map )
  89 {
  90   Property::Value* typeValue = map.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE  );
  91   Toolkit::Visual::Type type = Toolkit::Visual::IMAGE;
  92   if( typeValue )
  93   {
  94     Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, type );
  95   }
  96   return type;
  97 }
  98
  99 /**
 100  *  Finds visual in given array, returning true if found along with the iterator for that visual as a out parameter
 101  */
 102 bool FindVisual( Property::Index targetIndex, const RegisteredVisualContainer& visuals, RegisteredVisualContainer::Iterator& iter )
 103 {
 104   for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
 105   {
 106     if ( (*iter)->index ==  targetIndex )
 107     {
 108       return true;
 109     }
 110   }
 111   return false;
 112 }
 113
 114 void FindChangableVisuals( Dictionary<Property::Map>& stateVisualsToAdd,
 115                            Dictionary<Property::Map>& stateVisualsToChange,
 116                            DictionaryKeys& stateVisualsToRemove)
 117 {
 118   DictionaryKeys copyOfStateVisualsToRemove = stateVisualsToRemove;
 119
 120   for( DictionaryKeys::iterator iter = copyOfStateVisualsToRemove.begin();
 121        iter != copyOfStateVisualsToRemove.end(); ++iter )
 122   {
 123     const std::string& visualName = (*iter);
 124     Property::Map* toMap = stateVisualsToAdd.Find( visualName );
 125     if( toMap )
 126     {
 127       stateVisualsToChange.Add( visualName, *toMap );
 128       stateVisualsToAdd.Remove( visualName );
 129       Remove( stateVisualsToRemove, visualName );
 130     }
 131   }
 132 }
 133
 134 Toolkit::Visual::Base GetVisualByName(
 135   const RegisteredVisualContainer& visuals,
 136   const std::string& visualName )
 137 {
 138   Toolkit::Visual::Base visualHandle;
 139
 140   RegisteredVisualContainer::Iterator iter;
 141   for ( iter = visuals.Begin(); iter != visuals.End(); iter++ )
 142   {
 143     Toolkit::Visual::Base visual = (*iter)->visual;
 144     if( visual && visual.GetName() == visualName )
 145     {
 146       visualHandle = visual;
 147       break;
 148     }
 149   }
 150   return visualHandle;
 151 }
 152
 153 /**
 154  * Move visual from source to destination container
 155  */
 156 void MoveVisual( RegisteredVisualContainer::Iterator sourceIter, RegisteredVisualContainer& source, RegisteredVisualContainer& destination )
 157 {
 158    Toolkit::Visual::Base visual = (*sourceIter)->visual;
 159    if( visual )
 160    {
 161      RegisteredVisual* rv = source.Release( sourceIter );
 162      destination.PushBack( rv );
 163    }
 164 }
 165
 166 /**
 167  * Performs actions as requested using the action name.
 168  * @param[in] object The object on which to perform the action.
 169  * @param[in] actionName The action to perform.
 170  * @param[in] attributes The attributes with which to perfrom this action.
 171  * @return true if action has been accepted by this control
 172  */
 173 const char* ACTION_ACCESSIBILITY_ACTIVATED = "accessibilityActivated";
 174 static bool DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
 175 {
 176   bool ret = false;
 177
 178   if( object && ( 0 == strcmp( actionName.c_str(), ACTION_ACCESSIBILITY_ACTIVATED ) ) )
 179   {
 180     Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 181     if( control )
 182     {
 183       // if cast succeeds there is an implementation so no need to check
 184       ret = Internal::GetImplementation( control ).OnAccessibilityActivated();
 185     }
 186   }
 187
 188   return ret;
 189 }
 190
 191 /**
 192  * Connects a callback function with the object's signals.
 193  * @param[in] object The object providing the signal.
 194  * @param[in] tracker Used to disconnect the signal.
 195  * @param[in] signalName The signal to connect to.
 196  * @param[in] functor A newly allocated FunctorDelegate.
 197  * @return True if the signal was connected.
 198  * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 199  */
 200 const char* SIGNAL_KEY_EVENT = "keyEvent";
 201 const char* SIGNAL_KEY_INPUT_FOCUS_GAINED = "keyInputFocusGained";
 202 const char* SIGNAL_KEY_INPUT_FOCUS_LOST = "keyInputFocusLost";
 203 const char* SIGNAL_TAPPED = "tapped";
 204 const char* SIGNAL_PANNED = "panned";
 205 const char* SIGNAL_PINCHED = "pinched";
 206 const char* SIGNAL_LONG_PRESSED = "longPressed";
 207 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 208 {
 209   Dali::BaseHandle handle( object );
 210
 211   bool connected( false );
 212   Toolkit::Control control = Toolkit::Control::DownCast( handle );
 213   if ( control )
 214   {
 215     Internal::Control& controlImpl( Internal::GetImplementation( control ) );
 216     connected = true;
 217
 218     if ( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
 219     {
 220       controlImpl.KeyEventSignal().Connect( tracker, functor );
 221     }
 222     else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_GAINED ) )
 223     {
 224       controlImpl.KeyInputFocusGainedSignal().Connect( tracker, functor );
 225     }
 226     else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_INPUT_FOCUS_LOST ) )
 227     {
 228       controlImpl.KeyInputFocusLostSignal().Connect( tracker, functor );
 229     }
 230     else if( 0 == strcmp( signalName.c_str(), SIGNAL_TAPPED ) )
 231     {
 232       controlImpl.EnableGestureDetection( Gesture::Tap );
 233       controlImpl.GetTapGestureDetector().DetectedSignal().Connect( tracker, functor );
 234     }
 235     else if( 0 == strcmp( signalName.c_str(), SIGNAL_PANNED ) )
 236     {
 237       controlImpl.EnableGestureDetection( Gesture::Pan );
 238       controlImpl.GetPanGestureDetector().DetectedSignal().Connect( tracker, functor );
 239     }
 240     else if( 0 == strcmp( signalName.c_str(), SIGNAL_PINCHED ) )
 241     {
 242       controlImpl.EnableGestureDetection( Gesture::Pinch );
 243       controlImpl.GetPinchGestureDetector().DetectedSignal().Connect( tracker, functor );
 244     }
 245     else if( 0 == strcmp( signalName.c_str(), SIGNAL_LONG_PRESSED ) )
 246     {
 247       controlImpl.EnableGestureDetection( Gesture::LongPress );
 248       controlImpl.GetLongPressGestureDetector().DetectedSignal().Connect( tracker, functor );
 249     }
 250   }
 251   return connected;
 252 }
 253
 254 /**
 255  * Creates control through type registry
 256  */
 257 BaseHandle Create()
 258 {
 259   return Internal::Control::New();
 260 }
 261 // Setup signals and actions using the type-registry.
 262 DALI_TYPE_REGISTRATION_BEGIN( Control, CustomActor, Create );
 263
 264 // Note: Properties are registered separately below.
 265
 266 SignalConnectorType registerSignal1( typeRegistration, SIGNAL_KEY_EVENT, &DoConnectSignal );
 267 SignalConnectorType registerSignal2( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_GAINED, &DoConnectSignal );
 268 SignalConnectorType registerSignal3( typeRegistration, SIGNAL_KEY_INPUT_FOCUS_LOST, &DoConnectSignal );
 269 SignalConnectorType registerSignal4( typeRegistration, SIGNAL_TAPPED, &DoConnectSignal );
 270 SignalConnectorType registerSignal5( typeRegistration, SIGNAL_PANNED, &DoConnectSignal );
 271 SignalConnectorType registerSignal6( typeRegistration, SIGNAL_PINCHED, &DoConnectSignal );
 272 SignalConnectorType registerSignal7( typeRegistration, SIGNAL_LONG_PRESSED, &DoConnectSignal );
 273
 274 TypeAction registerAction( typeRegistration, ACTION_ACCESSIBILITY_ACTIVATED, &DoAction );
 275
 276 DALI_TYPE_REGISTRATION_END()
 277
 278 /**
 279  * @brief Iterate through given container and setOffStage any visual found
 280  *
 281  * @param[in] container Container of visuals
 282  * @param[in] parent Parent actor to remove visuals from
 283  */
 284 void SetVisualsOffStage( const RegisteredVisualContainer& container, Actor parent )
 285 {
 286   for( auto iter = container.Begin(), end = container.End() ; iter!= end; iter++)
 287   {
 288     if( (*iter)->visual )
 289     {
 290       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::SetOffStage Setting visual(%d) off stage\n", (*iter)->index );
 291       Toolkit::GetImplementation((*iter)->visual).SetOffStage( parent );
 292     }
 293   }
 294 }
 295
 296 } // unnamed namespace
 297
 298
 299 // Properties registered without macro to use specific member variables.
 300 const PropertyRegistration Control::Impl::PROPERTY_1( typeRegistration, "styleName",              Toolkit::Control::Property::STYLE_NAME,                   Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 301 const PropertyRegistration Control::Impl::PROPERTY_2( typeRegistration, "backgroundColor",        Toolkit::Control::Property::BACKGROUND_COLOR,             Property::VECTOR4, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 302 const PropertyRegistration Control::Impl::PROPERTY_3( typeRegistration, "backgroundImage",        Toolkit::Control::Property::BACKGROUND_IMAGE,             Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 303 const PropertyRegistration Control::Impl::PROPERTY_4( typeRegistration, "keyInputFocus",          Toolkit::Control::Property::KEY_INPUT_FOCUS,              Property::BOOLEAN, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 304 const PropertyRegistration Control::Impl::PROPERTY_5( typeRegistration, "background",             Toolkit::Control::Property::BACKGROUND,                   Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 305 const PropertyRegistration Control::Impl::PROPERTY_6( typeRegistration, "margin",                 Toolkit::Control::Property::MARGIN,                       Property::EXTENTS, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 306 const PropertyRegistration Control::Impl::PROPERTY_7( typeRegistration, "padding",                Toolkit::Control::Property::PADDING,                      Property::EXTENTS, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 307 const PropertyRegistration Control::Impl::PROPERTY_8( typeRegistration, "tooltip",                Toolkit::DevelControl::Property::TOOLTIP,                 Property::MAP,     &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 308 const PropertyRegistration Control::Impl::PROPERTY_9( typeRegistration, "state",                  Toolkit::DevelControl::Property::STATE,                   Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 309 const PropertyRegistration Control::Impl::PROPERTY_10( typeRegistration, "subState",               Toolkit::DevelControl::Property::SUB_STATE,               Property::STRING,  &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 310 const PropertyRegistration Control::Impl::PROPERTY_11( typeRegistration, "leftFocusableActorId",   Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 311 const PropertyRegistration Control::Impl::PROPERTY_12( typeRegistration, "rightFocusableActorId", Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID,Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 312 const PropertyRegistration Control::Impl::PROPERTY_13( typeRegistration, "upFocusableActorId",    Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID,   Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 313 const PropertyRegistration Control::Impl::PROPERTY_14( typeRegistration, "downFocusableActorId",  Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID, Property::INTEGER, &Control::Impl::SetProperty, &Control::Impl::GetProperty );
 314
 315
 316 Control::Impl::Impl( Control& controlImpl )
 317 : mControlImpl( controlImpl ),
 318   mState( Toolkit::DevelControl::NORMAL ),
 319   mSubStateName(""),
 320   mLayout( NULL ),
 321   mLeftFocusableActorId( -1 ),
 322   mRightFocusableActorId( -1 ),
 323   mUpFocusableActorId( -1 ),
 324   mDownFocusableActorId( -1 ),
 325   mStyleName(""),
 326   mBackgroundColor(Color::TRANSPARENT),
 327   mStartingPinchScale( NULL ),
 328   mMargin( 0, 0, 0, 0 ),
 329   mPadding( 0, 0, 0, 0 ),
 330   mKeyEventSignal(),
 331   mKeyInputFocusGainedSignal(),
 332   mKeyInputFocusLostSignal(),
 333   mResourceReadySignal(),
 334   mPinchGestureDetector(),
 335   mPanGestureDetector(),
 336   mTapGestureDetector(),
 337   mLongPressGestureDetector(),
 338   mTooltip( NULL ),
 339   mInputMethodContext(),
 340   mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 341   mIsKeyboardNavigationSupported( false ),
 342   mIsKeyboardFocusGroup( false )
 343 {
 344 }
 345
 346 Control::Impl::~Impl()
 347 {
 348   // All gesture detectors will be destroyed so no need to disconnect.
 349   delete mStartingPinchScale;
 350 }
 351
 352 Control::Impl& Control::Impl::Get( Internal::Control& internalControl )
 353 {
 354   return *internalControl.mImpl;
 355 }
 356
 357 const Control::Impl& Control::Impl::Get( const Internal::Control& internalControl )
 358 {
 359   return *internalControl.mImpl;
 360 }
 361
 362 // Gesture Detection Methods
 363 void Control::Impl::PinchDetected(Actor actor, const PinchGesture& pinch)
 364 {
 365   mControlImpl.OnPinch(pinch);
 366 }
 367
 368 void Control::Impl::PanDetected(Actor actor, const PanGesture& pan)
 369 {
 370   mControlImpl.OnPan(pan);
 371 }
 372
 373 void Control::Impl::TapDetected(Actor actor, const TapGesture& tap)
 374 {
 375   mControlImpl.OnTap(tap);
 376 }
 377
 378 void Control::Impl::LongPressDetected(Actor actor, const LongPressGesture& longPress)
 379 {
 380   mControlImpl.OnLongPress(longPress);
 381 }
 382
 383 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
 384 {
 385   RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::NOT_SET );
 386 }
 387
 388 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
 389 {
 390   RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::SET, depthIndex );
 391 }
 392
 393 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
 394 {
 395   RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::NOT_SET );
 396 }
 397
 398 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
 399 {
 400   RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::SET, depthIndex );
 401 }
 402
 403 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex )
 404 {
 405   DALI_LOG_INFO( gLogFilter, Debug::Concise, "RegisterVisual:%d \n", index );
 406
 407   bool visualReplaced ( false );
 408   Actor self = mControlImpl.Self();
 409
 410   // Set the depth index, if not set by caller this will be either the current visual depth, max depth of all visuals
 411   // or zero.
 412   int requiredDepthIndex = visual.GetDepthIndex();
 413
 414   if( depthIndexValueSet == DepthIndexValue::SET )
 415   {
 416     requiredDepthIndex = depthIndex;
 417   }
 418
 419   // Visual replacement, existing visual should only be removed from stage when replacement ready.
 420   if( !mVisuals.Empty() )
 421   {
 422     RegisteredVisualContainer::Iterator registeredVisualsiter;
 423     // Check if visual (index) is already registered, this is the current visual.
 424     if( FindVisual( index, mVisuals, registeredVisualsiter ) )
 425     {
 426       Toolkit::Visual::Base& currentRegisteredVisual = (*registeredVisualsiter)->visual;
 427       if( currentRegisteredVisual )
 428       {
 429         // Store current visual depth index as may need to set the replacement visual to same depth
 430         const int currentDepthIndex = (*registeredVisualsiter)->visual.GetDepthIndex();
 431
 432         // No longer required to know if the replaced visual's resources are ready
 433         StopObservingVisual( currentRegisteredVisual );
 434
 435         // If control staged and visual enabled then visuals will be swapped once ready
 436         if(  self.OnStage() && enabled )
 437         {
 438           // Check if visual is currently in the process of being replaced ( is in removal container )
 439           RegisteredVisualContainer::Iterator visualQueuedForRemoval;
 440           if ( FindVisual( index, mRemoveVisuals, visualQueuedForRemoval ) )
 441           {
 442             // Visual with same index is already in removal container so current visual pending
 443             // Only the the last requested visual will be displayed so remove current visual which is staged but not ready.
 444             Toolkit::GetImplementation( currentRegisteredVisual ).SetOffStage( self );
 445             mVisuals.Erase( registeredVisualsiter );
 446           }
 447           else
 448           {
 449             // current visual not already in removal container so add now.
 450             DALI_LOG_INFO( gLogFilter, Debug::Verbose, "RegisterVisual Move current registered visual to removal Queue: %d \n", index );
 451             MoveVisual( registeredVisualsiter, mVisuals, mRemoveVisuals );
 452           }
 453         }
 454         else
 455         {
 456           // Control not staged or visual disabled so can just erase from registered visuals and new visual will be added later.
 457           mVisuals.Erase( registeredVisualsiter );
 458         }
 459
 460         // If we've not set the depth-index value and the new visual does not have a depth index applied to it, then use the previously set depth-index for this index
 461         if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
 462             ( visual.GetDepthIndex() == 0 ) )
 463         {
 464           requiredDepthIndex = currentDepthIndex;
 465         }
 466       }
 467
 468       visualReplaced = true;
 469     }
 470   }
 471
 472   // If not set, set the name of the visual to the same name as the control's property.
 473   // ( If the control has been type registered )
 474   if( visual.GetName().empty() )
 475   {
 476     try
 477     {
 478       std::string visualName = self.GetPropertyName( index );
 479       if( !visualName.empty() )
 480       {
 481         DALI_LOG_INFO( gLogFilter, Debug::Concise, "Setting visual name for property %d to %s\n",
 482                        index, visualName.c_str() );
 483         visual.SetName( visualName );
 484       }
 485     }
 486     catch( Dali::DaliException e )
 487     {
 488       DALI_LOG_WARNING( "Attempting to register visual without a registered property, index: %d\n", index );
 489     }
 490   }
 491
 492   if( !visualReplaced ) // New registration entry
 493   {
 494     // If we've not set the depth-index value, we have more than one visual and the visual does not have a depth index, then set it to be the highest
 495     if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
 496         ( mVisuals.Size() > 0 ) &&
 497         ( visual.GetDepthIndex() == 0 ) )
 498     {
 499       int maxDepthIndex = std::numeric_limits< int >::min();
 500
 501       RegisteredVisualContainer::ConstIterator iter;
 502       const RegisteredVisualContainer::ConstIterator endIter = mVisuals.End();
 503       for ( iter = mVisuals.Begin(); iter != endIter; iter++ )
 504       {
 505         const int visualDepthIndex = (*iter)->visual.GetDepthIndex();
 506         if ( visualDepthIndex > maxDepthIndex )
 507         {
 508           maxDepthIndex = visualDepthIndex;
 509         }
 510       }
 511       ++maxDepthIndex; // Add one to the current maximum depth index so that our added visual appears on top
 512       requiredDepthIndex = std::max( 0, maxDepthIndex ); // Start at zero if maxDepth index belongs to a background
 513     }
 514   }
 515
 516   if( visual )
 517   {
 518     // Set determined depth index
 519     visual.SetDepthIndex( requiredDepthIndex );
 520
 521     // Monitor when the visual resources are ready
 522     StartObservingVisual( visual );
 523
 524     DALI_LOG_INFO( gLogFilter, Debug::Concise, "New Visual registration index[%d] depth[%d]\n", index, requiredDepthIndex );
 525     RegisteredVisual* newRegisteredVisual  = new RegisteredVisual( index, visual,
 526                                              ( enabled == VisualState::ENABLED ? true : false ),
 527                                              ( visualReplaced && enabled ) ) ;
 528     mVisuals.PushBack( newRegisteredVisual );
 529
 530     Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 531     // Put on stage if enabled and the control is already on the stage
 532     if( ( enabled == VisualState::ENABLED ) && self.OnStage() )
 533     {
 534       visualImpl.SetOnStage( self );
 535     }
 536     else if( visualImpl.IsResourceReady() ) // When not being staged, check if visual already 'ResourceReady' before it was Registered. ( Resource may have been loaded already )
 537     {
 538       ResourceReady( visualImpl );
 539     }
 540
 541   }
 542
 543   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n",  visual.GetName().c_str(), index, enabled?"true":"false" );
 544 }
 545
 546 void Control::Impl::UnregisterVisual( Property::Index index )
 547 {
 548   RegisteredVisualContainer::Iterator iter;
 549   if ( FindVisual( index, mVisuals, iter ) )
 550   {
 551     // stop observing visual
 552     StopObservingVisual( (*iter)->visual );
 553
 554     Actor self( mControlImpl.Self() );
 555     Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
 556     (*iter)->visual.Reset();
 557     mVisuals.Erase( iter );
 558   }
 559
 560   if( FindVisual( index, mRemoveVisuals, iter ) )
 561   {
 562     Actor self( mControlImpl.Self() );
 563     Toolkit::GetImplementation( (*iter)->visual ).SetOffStage( self );
 564     (*iter)->pending = false;
 565     (*iter)->visual.Reset();
 566     mRemoveVisuals.Erase( iter );
 567   }
 568 }
 569
 570 Toolkit::Visual::Base Control::Impl::GetVisual( Property::Index index ) const
 571 {
 572   RegisteredVisualContainer::Iterator iter;
 573   if ( FindVisual( index, mVisuals, iter ) )
 574   {
 575     return (*iter)->visual;
 576   }
 577
 578   return Toolkit::Visual::Base();
 579 }
 580
 581 void Control::Impl::EnableVisual( Property::Index index, bool enable )
 582 {
 583   DALI_LOG_INFO( gLogFilter, Debug::General, "Control::EnableVisual(%d, %s)\n", index, enable?"T":"F");
 584
 585   RegisteredVisualContainer::Iterator iter;
 586   if ( FindVisual( index, mVisuals, iter ) )
 587   {
 588     if (  (*iter)->enabled == enable )
 589     {
 590       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
 591       return;
 592     }
 593
 594     (*iter)->enabled = enable;
 595     Actor parentActor = mControlImpl.Self();
 596     if ( mControlImpl.Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
 597     {
 598       if ( enable )
 599       {
 600         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
 601         Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
 602       }
 603       else
 604       {
 605         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
 606         Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor );  // No need to call if control not staged.
 607       }
 608     }
 609   }
 610   else
 611   {
 612     DALI_LOG_WARNING( "Control::EnableVisual(%d, %s) FAILED - NO SUCH VISUAL\n", index, enable?"T":"F" );
 613   }
 614 }
 615
 616 bool Control::Impl::IsVisualEnabled( Property::Index index ) const
 617 {
 618   RegisteredVisualContainer::Iterator iter;
 619   if ( FindVisual( index, mVisuals, iter ) )
 620   {
 621     return (*iter)->enabled;
 622   }
 623   return false;
 624 }
 625
 626 void Control::Impl::StopObservingVisual( Toolkit::Visual::Base& visual )
 627 {
 628   Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 629
 630   // Stop observing the visual
 631   visualImpl.RemoveResourceObserver( *this );
 632 }
 633
 634 void Control::Impl::StartObservingVisual( Toolkit::Visual::Base& visual)
 635 {
 636   Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 637
 638   // start observing the visual for resource ready
 639   visualImpl.AddResourceObserver( *this );
 640 }
 641
 642 // Called by a Visual when it's resource is ready
 643 void Control::Impl::ResourceReady( Visual::Base& object)
 644 {
 645   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::Impl::ResourceReady() replacements pending[%d]\n", mRemoveVisuals.Count() );
 646
 647   Actor self = mControlImpl.Self();
 648
 649   // A resource is ready, find resource in the registered visuals container and get its index
 650   for( auto registeredIter = mVisuals.Begin(),  end = mVisuals.End(); registeredIter != end; ++registeredIter )
 651   {
 652     Internal::Visual::Base& registeredVisualImpl = Toolkit::GetImplementation( (*registeredIter)->visual );
 653
 654     if( &object == &registeredVisualImpl )
 655     {
 656       RegisteredVisualContainer::Iterator visualToRemoveIter;
 657       // Find visual with the same index in the removal container
 658       // Set if off stage as it's replacement is now ready.
 659       // Remove if from removal list as now removed from stage.
 660       // Set Pending flag on the ready visual to false as now ready.
 661       if( FindVisual( (*registeredIter)->index, mRemoveVisuals, visualToRemoveIter ) )
 662       {
 663         (*registeredIter)->pending = false;
 664         Toolkit::GetImplementation( (*visualToRemoveIter)->visual ).SetOffStage( self );
 665         mRemoveVisuals.Erase( visualToRemoveIter );
 666       }
 667       break;
 668     }
 669   }
 670
 671   // A visual is ready so control may need relayouting if staged
 672   if ( self.OnStage() )
 673   {
 674     mControlImpl.RelayoutRequest();
 675   }
 676
 677   // Emit signal if all enabled visuals registered by the control are ready.
 678   if( IsResourceReady() )
 679   {
 680     Dali::Toolkit::Control handle( mControlImpl.GetOwner() );
 681     mResourceReadySignal.Emit( handle );
 682   }
 683 }
 684
 685 bool Control::Impl::IsResourceReady() const
 686 {
 687   // Iterate through and check all the enabled visuals are ready
 688   for( auto visualIter = mVisuals.Begin();
 689          visualIter != mVisuals.End(); ++visualIter )
 690   {
 691     const Toolkit::Visual::Base visual = (*visualIter)->visual;
 692     const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 693
 694     // one of the enabled visuals is not ready
 695     if( !visualImpl.IsResourceReady() && (*visualIter)->enabled )
 696     {
 697       return false;
 698     }
 699   }
 700   return true;
 701 }
 702
 703 Toolkit::Visual::ResourceStatus Control::Impl::GetVisualResourceStatus( Property::Index index ) const
 704 {
 705   RegisteredVisualContainer::Iterator iter;
 706   if ( FindVisual( index, mVisuals, iter ) )
 707   {
 708     const Toolkit::Visual::Base visual = (*iter)->visual;
 709     const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 710     return visualImpl.GetResourceStatus( );
 711   }
 712
 713   return Toolkit::Visual::ResourceStatus::PREPARING;
 714 }
 715
 716
 717
 718 void Control::Impl::AddTransitions( Dali::Animation& animation,
 719                                     const Toolkit::TransitionData& handle,
 720                                     bool createAnimation )
 721 {
 722   // Setup a Transition from TransitionData.
 723   const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
 724   TransitionData::Iterator end = transitionData.End();
 725   for( TransitionData::Iterator iter = transitionData.Begin() ;
 726        iter != end; ++iter )
 727   {
 728     TransitionData::Animator* animator = (*iter);
 729
 730     Toolkit::Visual::Base visual = GetVisualByName( mVisuals, animator->objectName );
 731
 732     if( visual )
 733     {
 734 #if defined(DEBUG_ENABLED)
 735       Dali::TypeInfo typeInfo;
 736       ControlWrapper* controlWrapperImpl = dynamic_cast<ControlWrapper*>(&mControlImpl);
 737       if( controlWrapperImpl )
 738       {
 739         typeInfo = controlWrapperImpl->GetTypeInfo();
 740       }
 741
 742       DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Found %s visual for %s\n",
 743                      visual.GetName().c_str(), typeInfo?typeInfo.GetName().c_str():"Unknown" );
 744 #endif
 745       Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 746       visualImpl.AnimateProperty( animation, *animator );
 747     }
 748     else
 749     {
 750       DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Could not find visual. Trying actors");
 751       // Otherwise, try any actor children of control (Including the control)
 752       Actor child = mControlImpl.Self().FindChildByName( animator->objectName );
 753       if( child )
 754       {
 755         Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
 756         if( propertyIndex != Property::INVALID_INDEX )
 757         {
 758           if( animator->animate == false )
 759           {
 760             if( animator->targetValue.GetType() != Property::NONE )
 761             {
 762               child.SetProperty( propertyIndex, animator->targetValue );
 763             }
 764           }
 765           else // animate the property
 766           {
 767             if( animator->initialValue.GetType() != Property::NONE )
 768             {
 769               child.SetProperty( propertyIndex, animator->initialValue );
 770             }
 771
 772             if( createAnimation && !animation )
 773             {
 774               animation = Dali::Animation::New( 0.1f );
 775             }
 776
 777             animation.AnimateTo( Property( child, propertyIndex ),
 778                                  animator->targetValue,
 779                                  animator->alphaFunction,
 780                                  TimePeriod( animator->timePeriodDelay,
 781                                              animator->timePeriodDuration ) );
 782           }
 783         }
 784       }
 785     }
 786   }
 787 }
 788
 789 Dali::Animation Control::Impl::CreateTransition( const Toolkit::TransitionData& transitionData )
 790 {
 791   Dali::Animation transition;
 792
 793   if( transitionData.Count() > 0 )
 794   {
 795     AddTransitions( transition, transitionData, true );
 796   }
 797   return transition;
 798 }
 799
 800
 801
 802 void Control::Impl::DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes )
 803 {
 804   RegisteredVisualContainer::Iterator iter;
 805   if ( FindVisual( visualIndex, mVisuals, iter ) )
 806   {
 807     Toolkit::GetImplementation((*iter)->visual).DoAction( actionId, attributes );
 808   }
 809 }
 810
 811 void Control::Impl::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 812 {
 813   Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 814
 815   if ( control )
 816   {
 817     Control& controlImpl( GetImplementation( control ) );
 818
 819     switch ( index )
 820     {
 821       case Toolkit::Control::Property::STYLE_NAME:
 822       {
 823         controlImpl.SetStyleName( value.Get< std::string >() );
 824         break;
 825       }
 826
 827       case Toolkit::DevelControl::Property::STATE:
 828       {
 829         bool withTransitions=true;
 830         const Property::Value* valuePtr=&value;
 831         Property::Map* map = value.GetMap();
 832         if(map)
 833         {
 834           Property::Value* value2 = map->Find("withTransitions");
 835           if( value2 )
 836           {
 837             withTransitions = value2->Get<bool>();
 838           }
 839
 840           valuePtr = map->Find("state");
 841         }
 842
 843         if( valuePtr )
 844         {
 845           Toolkit::DevelControl::State state( controlImpl.mImpl->mState );
 846           if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( *valuePtr, ControlStateTable, ControlStateTableCount, state ) )
 847           {
 848             controlImpl.mImpl->SetState( state, withTransitions );
 849           }
 850         }
 851       }
 852       break;
 853
 854       case Toolkit::DevelControl::Property::SUB_STATE:
 855       {
 856         std::string subState;
 857         if( value.Get( subState ) )
 858         {
 859           controlImpl.mImpl->SetSubState( subState );
 860         }
 861       }
 862       break;
 863
 864       case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
 865       {
 866         int focusId;
 867         if( value.Get( focusId ) )
 868         {
 869           controlImpl.mImpl->mLeftFocusableActorId = focusId;
 870         }
 871       }
 872       break;
 873
 874       case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
 875       {
 876         int focusId;
 877         if( value.Get( focusId ) )
 878         {
 879           controlImpl.mImpl->mRightFocusableActorId = focusId;
 880         }
 881       }
 882       break;
 883
 884       case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
 885       {
 886         int focusId;
 887         if( value.Get( focusId ) )
 888         {
 889           controlImpl.mImpl->mUpFocusableActorId = focusId;
 890         }
 891       }
 892       break;
 893
 894       case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
 895       {
 896         int focusId;
 897         if( value.Get( focusId ) )
 898         {
 899           controlImpl.mImpl->mDownFocusableActorId = focusId;
 900         }
 901       }
 902       break;
 903
 904       case Toolkit::Control::Property::BACKGROUND_COLOR:
 905       {
 906         DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 907         controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
 908         break;
 909       }
 910
 911       case Toolkit::Control::Property::BACKGROUND_IMAGE:
 912       {
 913         DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 914         Image image = Scripting::NewImage( value );
 915         if ( image )
 916         {
 917           controlImpl.SetBackgroundImage( image );
 918         }
 919         else
 920         {
 921           // An empty image means the background is no longer required
 922           controlImpl.ClearBackground();
 923         }
 924         break;
 925       }
 926
 927       case Toolkit::Control::Property::KEY_INPUT_FOCUS:
 928       {
 929         if ( value.Get< bool >() )
 930         {
 931           controlImpl.SetKeyInputFocus();
 932         }
 933         else
 934         {
 935           controlImpl.ClearKeyInputFocus();
 936         }
 937         break;
 938       }
 939
 940       case Toolkit::Control::Property::BACKGROUND:
 941       {
 942         std::string url;
 943         Vector4 color;
 944         const Property::Map* map = value.GetMap();
 945         if( map && !map->Empty() )
 946         {
 947           controlImpl.SetBackground( *map );
 948         }
 949         else if( value.Get( url ) )
 950         {
 951           // don't know the size to load
 952           Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
 953           if( visual )
 954           {
 955             controlImpl.mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
 956           }
 957         }
 958         else if( value.Get( color ) )
 959         {
 960           controlImpl.SetBackgroundColor(color);
 961         }
 962         else
 963         {
 964           // The background is an empty property map, so we should clear the background
 965           controlImpl.ClearBackground();
 966         }
 967         break;
 968       }
 969
 970       case Toolkit::Control::Property::MARGIN:
 971       {
 972         Extents margin;
 973         if( value.Get( margin ) )
 974         {
 975           controlImpl.mImpl->SetMargin( margin );
 976         }
 977         break;
 978       }
 979
 980       case Toolkit::Control::Property::PADDING:
 981       {
 982         Extents padding;
 983         if( value.Get( padding ) )
 984         {
 985           controlImpl.mImpl->SetPadding( padding );
 986         }
 987         break;
 988       }
 989
 990       case Toolkit::DevelControl::Property::TOOLTIP:
 991       {
 992         TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
 993         if( ! tooltipPtr )
 994         {
 995           tooltipPtr = Tooltip::New( control );
 996         }
 997         tooltipPtr->SetProperties( value );
 998         break;
 999       }
1000
1001     }
1002   }
1003 }
1004
1005 Property::Value Control::Impl::GetProperty( BaseObject* object, Property::Index index )
1006 {
1007   Property::Value value;
1008
1009   Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
1010
1011   if ( control )
1012   {
1013     Control& controlImpl( GetImplementation( control ) );
1014
1015     switch ( index )
1016     {
1017       case Toolkit::Control::Property::STYLE_NAME:
1018       {
1019         value = controlImpl.GetStyleName();
1020         break;
1021       }
1022
1023       case Toolkit::DevelControl::Property::STATE:
1024       {
1025         value = controlImpl.mImpl->mState;
1026         break;
1027       }
1028
1029       case Toolkit::DevelControl::Property::SUB_STATE:
1030       {
1031         value = controlImpl.mImpl->mSubStateName;
1032         break;
1033       }
1034
1035       case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
1036       {
1037         value = controlImpl.mImpl->mLeftFocusableActorId;
1038         break;
1039       }
1040
1041       case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
1042       {
1043         value = controlImpl.mImpl->mRightFocusableActorId;
1044         break;
1045       }
1046
1047       case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
1048       {
1049         value = controlImpl.mImpl->mUpFocusableActorId;
1050         break;
1051       }
1052
1053       case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
1054       {
1055         value = controlImpl.mImpl->mDownFocusableActorId;
1056         break;
1057       }
1058
1059       case Toolkit::Control::Property::BACKGROUND_COLOR:
1060       {
1061         DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
1062         value = controlImpl.GetBackgroundColor();
1063         break;
1064       }
1065
1066       case Toolkit::Control::Property::BACKGROUND_IMAGE:
1067       {
1068         DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
1069         Property::Map map;
1070         Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1071         if( visual )
1072         {
1073           visual.CreatePropertyMap( map );
1074         }
1075         value = map;
1076         break;
1077       }
1078
1079       case Toolkit::Control::Property::KEY_INPUT_FOCUS:
1080       {
1081         value = controlImpl.HasKeyInputFocus();
1082         break;
1083       }
1084
1085       case Toolkit::Control::Property::BACKGROUND:
1086       {
1087         Property::Map map;
1088         Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1089         if( visual )
1090         {
1091           visual.CreatePropertyMap( map );
1092         }
1093
1094         value = map;
1095         break;
1096       }
1097
1098       case Toolkit::Control::Property::MARGIN:
1099       {
1100         value = controlImpl.mImpl->GetMargin();
1101         break;
1102       }
1103
1104       case Toolkit::Control::Property::PADDING:
1105       {
1106         value = controlImpl.mImpl->GetPadding();
1107         break;
1108       }
1109
1110       case Toolkit::DevelControl::Property::TOOLTIP:
1111       {
1112         Property::Map map;
1113         if( controlImpl.mImpl->mTooltip )
1114         {
1115           controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
1116         }
1117         value = map;
1118         break;
1119       }
1120     }
1121   }
1122
1123   return value;
1124 }
1125
1126
1127 void  Control::Impl::CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties )
1128 {
1129   for(RegisteredVisualContainer::Iterator iter = visuals.Begin(); iter!= visuals.End(); iter++)
1130   {
1131     if( (*iter)->visual )
1132     {
1133       Property::Map instanceMap;
1134       Toolkit::GetImplementation((*iter)->visual).CreateInstancePropertyMap(instanceMap);
1135       instancedProperties.Add( (*iter)->visual.GetName(), instanceMap );
1136     }
1137   }
1138 }
1139
1140
1141 void Control::Impl::RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName )
1142 {
1143   Actor self( mControlImpl.Self() );
1144
1145   for ( RegisteredVisualContainer::Iterator visualIter = visuals.Begin();
1146         visualIter != visuals.End(); ++visualIter )
1147   {
1148     Toolkit::Visual::Base visual = (*visualIter)->visual;
1149     if( visual && visual.GetName() == visualName )
1150     {
1151       Toolkit::GetImplementation(visual).SetOffStage( self );
1152       (*visualIter)->visual.Reset();
1153       visuals.Erase( visualIter );
1154       break;
1155     }
1156   }
1157 }
1158
1159 void Control::Impl::RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals )
1160 {
1161   Actor self( mControlImpl.Self() );
1162   for( DictionaryKeys::iterator iter = removeVisuals.begin(); iter != removeVisuals.end(); ++iter )
1163   {
1164     const std::string visualName = *iter;
1165     RemoveVisual( visuals, visualName );
1166   }
1167 }
1168
1169 void Control::Impl::RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange,
1170                              Dictionary<Property::Map>& instancedProperties )
1171 {
1172   Dali::CustomActor handle( mControlImpl.GetOwner() );
1173   for( Dictionary<Property::Map>::iterator iter = stateVisualsToChange.Begin();
1174        iter != stateVisualsToChange.End(); ++iter )
1175   {
1176     const std::string& visualName = (*iter).key;
1177     const Property::Map& toMap = (*iter).entry;
1178
1179     // is it a candidate for re-creation?
1180     bool recreate = false;
1181
1182     Toolkit::Visual::Base visual = GetVisualByName( mVisuals, visualName );
1183     if( visual )
1184     {
1185       Property::Map fromMap;
1186       visual.CreatePropertyMap( fromMap );
1187
1188       Toolkit::Visual::Type fromType = GetVisualTypeFromMap( fromMap );
1189       Toolkit::Visual::Type toType = GetVisualTypeFromMap( toMap );
1190
1191       if( fromType != toType )
1192       {
1193         recreate = true;
1194       }
1195       else
1196       {
1197         if( fromType == Toolkit::Visual::IMAGE || fromType == Toolkit::Visual::N_PATCH
1198             || fromType == Toolkit::Visual::SVG || fromType == Toolkit::Visual::ANIMATED_IMAGE )
1199         {
1200           Property::Value* fromUrl = fromMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1201           Property::Value* toUrl = toMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1202
1203           if( fromUrl && toUrl )
1204           {
1205             std::string fromUrlString;
1206             std::string toUrlString;
1207             fromUrl->Get(fromUrlString);
1208             toUrl->Get(toUrlString);
1209
1210             if( fromUrlString != toUrlString )
1211             {
1212               recreate = true;
1213             }
1214           }
1215         }
1216       }
1217
1218       const Property::Map* instancedMap = instancedProperties.FindConst( visualName );
1219       if( recreate || instancedMap )
1220       {
1221         RemoveVisual( mVisuals, visualName );
1222         Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1223       }
1224       else
1225       {
1226         // @todo check to see if we can apply toMap without recreating the visual
1227         // e.g. by setting only animatable properties
1228         // For now, recreate all visuals, but merge in instance data.
1229         RemoveVisual( mVisuals, visualName );
1230         Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1231       }
1232     }
1233   }
1234 }
1235
1236 void Control::Impl::ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState )
1237 {
1238   // Collect all old visual names
1239   DictionaryKeys stateVisualsToRemove;
1240   if( oldState )
1241   {
1242     oldState->visuals.GetKeys( stateVisualsToRemove );
1243     if( ! subState.empty() )
1244     {
1245       const StylePtr* oldSubState = oldState->subStates.FindConst(subState);
1246       if( oldSubState )
1247       {
1248         DictionaryKeys subStateVisualsToRemove;
1249         (*oldSubState)->visuals.GetKeys( subStateVisualsToRemove );
1250         Merge( stateVisualsToRemove, subStateVisualsToRemove );
1251       }
1252     }
1253   }
1254
1255   // Collect all new visual properties
1256   Dictionary<Property::Map> stateVisualsToAdd;
1257   if( newState )
1258   {
1259     stateVisualsToAdd = newState->visuals;
1260     if( ! subState.empty() )
1261     {
1262       const StylePtr* newSubState = newState->subStates.FindConst(subState);
1263       if( newSubState )
1264       {
1265         stateVisualsToAdd.Merge( (*newSubState)->visuals );
1266       }
1267     }
1268   }
1269
1270   // If a name is in both add/remove, move it to change list.
1271   Dictionary<Property::Map> stateVisualsToChange;
1272   FindChangableVisuals( stateVisualsToAdd, stateVisualsToChange, stateVisualsToRemove);
1273
1274   // Copy instanced properties (e.g. text label) of current visuals
1275   Dictionary<Property::Map> instancedProperties;
1276   CopyInstancedProperties( mVisuals, instancedProperties );
1277
1278   // For each visual in remove list, remove from mVisuals
1279   RemoveVisuals( mVisuals, stateVisualsToRemove );
1280
1281   // For each visual in add list, create and add to mVisuals
1282   Dali::CustomActor handle( mControlImpl.GetOwner() );
1283   Style::ApplyVisuals( handle, stateVisualsToAdd, instancedProperties );
1284
1285   // For each visual in change list, if it requires a new visual,
1286   // remove old visual, create and add to mVisuals
1287   RecreateChangedVisuals( stateVisualsToChange, instancedProperties );
1288 }
1289
1290 void Control::Impl::SetState( DevelControl::State newState, bool withTransitions )
1291 {
1292   DevelControl::State oldState = mState;
1293   Dali::CustomActor handle( mControlImpl.GetOwner() );
1294   DALI_LOG_INFO(gLogFilter, Debug::Concise, "Control::Impl::SetState: %s\n",
1295                 (mState == DevelControl::NORMAL ? "NORMAL" :(
1296                   mState == DevelControl::FOCUSED ?"FOCUSED" : (
1297                     mState == DevelControl::DISABLED?"DISABLED":"NONE" ))));
1298
1299   if( mState != newState )
1300   {
1301     // If mState was Disabled, and new state is Focused, should probably
1302     // store that fact, e.g. in another property that FocusManager can access.
1303     mState = newState;
1304
1305     // Trigger state change and transitions
1306     // Apply new style, if stylemanager is available
1307     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1308     if( styleManager )
1309     {
1310       const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1311
1312       if( stylePtr )
1313       {
1314         std::string oldStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( oldState, ControlStateTable, ControlStateTableCount );
1315         std::string newStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( newState, ControlStateTable, ControlStateTableCount );
1316
1317         const StylePtr* newStateStyle = stylePtr->subStates.Find( newStateName );
1318         const StylePtr* oldStateStyle = stylePtr->subStates.Find( oldStateName );
1319         if( oldStateStyle && newStateStyle )
1320         {
1321           // Only change if both state styles exist
1322           ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, mSubStateName );
1323         }
1324       }
1325     }
1326   }
1327 }
1328
1329 void Control::Impl::SetSubState( const std::string& subStateName, bool withTransitions )
1330 {
1331   if( mSubStateName != subStateName )
1332   {
1333     // Get existing sub-state visuals, and unregister them
1334     Dali::CustomActor handle( mControlImpl.GetOwner() );
1335
1336     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1337     if( styleManager )
1338     {
1339       const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1340       if( stylePtr )
1341       {
1342         // Stringify state
1343         std::string stateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( mState, ControlStateTable, ControlStateTableCount );
1344
1345         const StylePtr* state = stylePtr->subStates.Find( stateName );
1346         if( state )
1347         {
1348           StylePtr stateStyle(*state);
1349
1350           const StylePtr* newStateStyle = stateStyle->subStates.Find( subStateName );
1351           const StylePtr* oldStateStyle = stateStyle->subStates.Find( mSubStateName );
1352           if( oldStateStyle && newStateStyle )
1353           {
1354             std::string empty;
1355             ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, empty );
1356           }
1357         }
1358       }
1359     }
1360
1361     mSubStateName = subStateName;
1362   }
1363 }
1364
1365 void Control::Impl::OnStageDisconnection()
1366 {
1367   Actor self = mControlImpl.Self();
1368
1369   // Any visuals set for replacement but not yet ready should still be registered.
1370   // Reason: If a request was made to register a new visual but the control removed from stage before visual was ready
1371   // then when this control appears back on stage it should use that new visual.
1372
1373   // Iterate through all registered visuals and set off stage
1374   SetVisualsOffStage( mVisuals, self );
1375
1376   // Visuals pending replacement can now be taken out of the removal list and set off stage
1377   // Iterate through all replacement visuals and add to a move queue then set off stage
1378   for( auto removalIter = mRemoveVisuals.Begin(), end = mRemoveVisuals.End(); removalIter != end; removalIter++ )
1379   {
1380     Toolkit::GetImplementation((*removalIter)->visual).SetOffStage( self );
1381   }
1382
1383   for( auto replacedIter = mVisuals.Begin(), end = mVisuals.End(); replacedIter != end; replacedIter++ )
1384   {
1385     (*replacedIter)->pending = false;
1386   }
1387
1388   mRemoveVisuals.Clear();
1389 }
1390
1391 void Control::Impl::SetMargin( Extents margin )
1392 {
1393   mControlImpl.mImpl->mMargin = margin;
1394 }
1395
1396 Extents Control::Impl::GetMargin() const
1397 {
1398   return mControlImpl.mImpl->mMargin;
1399 }
1400
1401 void Control::Impl::SetPadding( Extents padding )
1402 {
1403   mControlImpl.mImpl->mPadding = padding;
1404 }
1405
1406 Extents Control::Impl::GetPadding() const
1407 {
1408   return mControlImpl.mImpl->mPadding;
1409 }
1410
1411 void Control::Impl::SetInputMethodContext( InputMethodContext& inputMethodContext )
1412 {
1413   mInputMethodContext = inputMethodContext;
1414 }
1415
1416 bool Control::Impl::FilterKeyEvent( const KeyEvent& event )
1417 {
1418   bool consumed ( false );
1419
1420   if ( mInputMethodContext )
1421   {
1422     consumed = mInputMethodContext.FilterEventKey( event );
1423   }
1424   return consumed;
1425 }
1426
1427 Toolkit::Internal::LayoutItemPtr Control::Impl::GetLayout() const
1428 {
1429   return mLayout;
1430 }
1431
1432 void Control::Impl::SetLayout( Toolkit::Internal::LayoutItem& layout )
1433 {
1434   if( mLayout )
1435   {
1436     mLayout->Unparent();
1437     mLayout.Reset();
1438   }
1439   mLayout = &layout;
1440
1441   auto controlHandle = Toolkit::Control::DownCast( mControlImpl.Self() ); // Get a handle of this control implementation without copying internals.
1442   mLayout->Initialize( controlHandle, controlHandle.GetTypeName() ); // LayoutGroup takes ownership of existing children
1443 }
1444
1445 } // namespace Internal
1446
1447 } // namespace Toolkit
1448
1449 } // namespace Dali