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

   1 /*
   2  * Copyright (c) 2017 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/public-api/common/dali-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/devel-api/controls/control-depth-index-ranges.h>
  35 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  36 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  37 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  39 #include <dali-toolkit/devel-api/controls/control-devel.h>
  40 #include <dali-toolkit/devel-api/controls/control-wrapper-impl.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   mLeftFocusableActorId( -1 ),
 321   mRightFocusableActorId( -1 ),
 322   mUpFocusableActorId( -1 ),
 323   mDownFocusableActorId( -1 ),
 324   mStyleName(""),
 325   mBackgroundColor(Color::TRANSPARENT),
 326   mStartingPinchScale( NULL ),
 327   mMargin( 0, 0, 0, 0 ),
 328   mPadding( 0, 0, 0, 0 ),
 329   mKeyEventSignal(),
 330   mPinchGestureDetector(),
 331   mPanGestureDetector(),
 332   mTapGestureDetector(),
 333   mLongPressGestureDetector(),
 334   mFlags( Control::ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 335   mIsKeyboardNavigationSupported( false ),
 336   mIsKeyboardFocusGroup( false )
 337 {
 338
 339 }
 340
 341 Control::Impl::~Impl()
 342 {
 343   // All gesture detectors will be destroyed so no need to disconnect.
 344   delete mStartingPinchScale;
 345 }
 346
 347 Control::Impl& Control::Impl::Get( Internal::Control& internalControl )
 348 {
 349   return *internalControl.mImpl;
 350 }
 351
 352 const Control::Impl& Control::Impl::Get( const Internal::Control& internalControl )
 353 {
 354   return *internalControl.mImpl;
 355 }
 356
 357 // Gesture Detection Methods
 358 void Control::Impl::PinchDetected(Actor actor, const PinchGesture& pinch)
 359 {
 360   mControlImpl.OnPinch(pinch);
 361 }
 362
 363 void Control::Impl::PanDetected(Actor actor, const PanGesture& pan)
 364 {
 365   mControlImpl.OnPan(pan);
 366 }
 367
 368 void Control::Impl::TapDetected(Actor actor, const TapGesture& tap)
 369 {
 370   mControlImpl.OnTap(tap);
 371 }
 372
 373 void Control::Impl::LongPressDetected(Actor actor, const LongPressGesture& longPress)
 374 {
 375   mControlImpl.OnLongPress(longPress);
 376 }
 377
 378 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual )
 379 {
 380   RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::NOT_SET );
 381 }
 382
 383 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, int depthIndex )
 384 {
 385   RegisterVisual( index, visual, VisualState::ENABLED, DepthIndexValue::SET, depthIndex );
 386 }
 387
 388 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled )
 389 {
 390   RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::NOT_SET );
 391 }
 392
 393 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled, int depthIndex )
 394 {
 395   RegisterVisual( index, visual, ( enabled ? VisualState::ENABLED : VisualState::DISABLED ), DepthIndexValue::SET, depthIndex );
 396 }
 397
 398 void Control::Impl::RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex )
 399 {
 400   DALI_LOG_INFO( gLogFilter, Debug::Concise, "RegisterVisual:%d \n", index );
 401
 402   bool visualReplaced ( false );
 403   Actor self = mControlImpl.Self();
 404
 405   // Set the depth index, if not set by caller this will be either the current visual depth, max depth of all visuals
 406   // or zero.
 407   int requiredDepthIndex = visual.GetDepthIndex();
 408
 409   if( depthIndexValueSet == DepthIndexValue::SET )
 410   {
 411     requiredDepthIndex = depthIndex;
 412   }
 413
 414   // Visual replacement, existing visual should only be removed from stage when replacement ready.
 415   if( !mVisuals.Empty() )
 416   {
 417     RegisteredVisualContainer::Iterator registeredVisualsiter;
 418     // Check if visual (index) is already registered, this is the current visual.
 419     if( FindVisual( index, mVisuals, registeredVisualsiter ) )
 420     {
 421       Toolkit::Visual::Base& currentRegisteredVisual = (*registeredVisualsiter)->visual;
 422       if( currentRegisteredVisual )
 423       {
 424         // Store current visual depth index as may need to set the replacement visual to same depth
 425         const int currentDepthIndex = (*registeredVisualsiter)->visual.GetDepthIndex();
 426
 427         // No longer required to know if the replaced visual's resources are ready
 428         StopObservingVisual( currentRegisteredVisual );
 429
 430         // If control staged and visual enabled then visuals will be swapped once ready
 431         if(  self.OnStage() && enabled )
 432         {
 433           // Check if visual is currently in the process of being replaced ( is in removal container )
 434           RegisteredVisualContainer::Iterator visualQueuedForRemoval;
 435           if ( FindVisual( index, mRemoveVisuals, visualQueuedForRemoval ) )
 436           {
 437             // Visual with same index is already in removal container so current visual pending
 438             // Only the the last requested visual will be displayed so remove current visual which is staged but not ready.
 439             Toolkit::GetImplementation( currentRegisteredVisual ).SetOffStage( self );
 440             mVisuals.Erase( registeredVisualsiter );
 441           }
 442           else
 443           {
 444             // current visual not already in removal container so add now.
 445             DALI_LOG_INFO( gLogFilter, Debug::Verbose, "RegisterVisual Move current registered visual to removal Queue: %d \n", index );
 446             MoveVisual( registeredVisualsiter, mVisuals, mRemoveVisuals );
 447           }
 448         }
 449         else
 450         {
 451           // Control not staged or visual disabled so can just erase from registered visuals and new visual will be added later.
 452           mVisuals.Erase( registeredVisualsiter );
 453         }
 454
 455         // 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
 456         if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
 457             ( visual.GetDepthIndex() == 0 ) )
 458         {
 459           requiredDepthIndex = currentDepthIndex;
 460         }
 461       }
 462
 463       visualReplaced = true;
 464     }
 465   }
 466
 467   // If not set, set the name of the visual to the same name as the control's property.
 468   // ( If the control has been type registered )
 469   if( visual.GetName().empty() )
 470   {
 471     try
 472     {
 473       std::string visualName = self.GetPropertyName( index );
 474       if( !visualName.empty() )
 475       {
 476         DALI_LOG_INFO( gLogFilter, Debug::Concise, "Setting visual name for property %d to %s\n",
 477                        index, visualName.c_str() );
 478         visual.SetName( visualName );
 479       }
 480     }
 481     catch( Dali::DaliException e )
 482     {
 483       DALI_LOG_WARNING( "Attempting to register visual without a registered property, index: %d\n", index );
 484     }
 485   }
 486
 487   if( !visualReplaced ) // New registration entry
 488   {
 489     // 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
 490     if( ( depthIndexValueSet == DepthIndexValue::NOT_SET ) &&
 491         ( mVisuals.Size() > 0 ) &&
 492         ( visual.GetDepthIndex() == 0 ) )
 493     {
 494       int maxDepthIndex = std::numeric_limits< int >::min();
 495
 496       RegisteredVisualContainer::ConstIterator iter;
 497       const RegisteredVisualContainer::ConstIterator endIter = mVisuals.End();
 498       for ( iter = mVisuals.Begin(); iter != endIter; iter++ )
 499       {
 500         const int visualDepthIndex = (*iter)->visual.GetDepthIndex();
 501         if ( visualDepthIndex > maxDepthIndex )
 502         {
 503           maxDepthIndex = visualDepthIndex;
 504         }
 505       }
 506       ++maxDepthIndex; // Add one to the current maximum depth index so that our added visual appears on top
 507       requiredDepthIndex = std::max( 0, maxDepthIndex ); // Start at zero if maxDepth index belongs to a background
 508     }
 509   }
 510
 511   if( visual )
 512   {
 513     // Set determined depth index
 514     visual.SetDepthIndex( requiredDepthIndex );
 515
 516     // Monitor when the visual resources are ready
 517     StartObservingVisual( visual );
 518
 519     DALI_LOG_INFO( gLogFilter, Debug::Concise, "New Visual registration index[%d] depth[%d]\n", index, requiredDepthIndex );
 520     RegisteredVisual* newRegisteredVisual  = new RegisteredVisual( index, visual,
 521                                              ( enabled == VisualState::ENABLED ? true : false ),
 522                                              ( visualReplaced && enabled ) ) ;
 523     mVisuals.PushBack( newRegisteredVisual );
 524
 525     Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 526     // Put on stage if enabled and the control is already on the stage
 527     if( ( enabled == VisualState::ENABLED ) && self.OnStage() )
 528     {
 529       visualImpl.SetOnStage( self );
 530     }
 531     else if( visualImpl.IsResourceReady() ) // When not being staged, check if visual already 'ResourceReady' before it was Registered. ( Resource may have been loaded already )
 532     {
 533       ResourceReady( visualImpl );
 534     }
 535
 536   }
 537
 538   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::RegisterVisual() Registered %s(%d), enabled:%s\n",  visual.GetName().c_str(), index, enabled?"true":"false" );
 539 }
 540
 541 void Control::Impl::UnregisterVisual( Property::Index index )
 542 {
 543   RegisteredVisualContainer::Iterator iter;
 544   if ( FindVisual( index, mVisuals, iter ) )
 545   {
 546     // stop observing visual
 547     StopObservingVisual( (*iter)->visual );
 548
 549     Actor self( mControlImpl.Self() );
 550     Toolkit::GetImplementation((*iter)->visual).SetOffStage( self );
 551     (*iter)->visual.Reset();
 552     mVisuals.Erase( iter );
 553   }
 554
 555   if( FindVisual( index, mRemoveVisuals, iter ) )
 556   {
 557     Actor self( mControlImpl.Self() );
 558     Toolkit::GetImplementation( (*iter)->visual ).SetOffStage( self );
 559     (*iter)->pending = false;
 560     (*iter)->visual.Reset();
 561     mRemoveVisuals.Erase( iter );
 562   }
 563 }
 564
 565 Toolkit::Visual::Base Control::Impl::GetVisual( Property::Index index ) const
 566 {
 567   RegisteredVisualContainer::Iterator iter;
 568   if ( FindVisual( index, mVisuals, iter ) )
 569   {
 570     return (*iter)->visual;
 571   }
 572
 573   return Toolkit::Visual::Base();
 574 }
 575
 576 void Control::Impl::EnableVisual( Property::Index index, bool enable )
 577 {
 578   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual (%d)\n", index);
 579
 580   RegisteredVisualContainer::Iterator iter;
 581   if ( FindVisual( index, mVisuals, iter ) )
 582   {
 583     if (  (*iter)->enabled == enable )
 584     {
 585       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Visual %s(%d) already %s\n", (*iter)->visual.GetName().c_str(), index, enable?"enabled":"disabled");
 586       return;
 587     }
 588
 589     (*iter)->enabled = enable;
 590     Actor parentActor = mControlImpl.Self();
 591     if ( mControlImpl.Self().OnStage() ) // If control not on Stage then Visual will be added when StageConnection is called.
 592     {
 593       if ( enable )
 594       {
 595         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) on stage \n", (*iter)->visual.GetName().c_str(), index );
 596         Toolkit::GetImplementation((*iter)->visual).SetOnStage( parentActor );
 597       }
 598       else
 599       {
 600         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Control::EnableVisual Setting %s(%d) off stage \n", (*iter)->visual.GetName().c_str(), index );
 601         Toolkit::GetImplementation((*iter)->visual).SetOffStage( parentActor );  // No need to call if control not staged.
 602       }
 603     }
 604   }
 605 }
 606
 607 bool Control::Impl::IsVisualEnabled( Property::Index index ) const
 608 {
 609   RegisteredVisualContainer::Iterator iter;
 610   if ( FindVisual( index, mVisuals, iter ) )
 611   {
 612     return (*iter)->enabled;
 613   }
 614   return false;
 615 }
 616
 617 void Control::Impl::StopObservingVisual( Toolkit::Visual::Base& visual )
 618 {
 619   Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 620
 621   // Stop observing the visual
 622   visualImpl.RemoveResourceObserver( *this );
 623 }
 624
 625 void Control::Impl::StartObservingVisual( Toolkit::Visual::Base& visual)
 626 {
 627   Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 628
 629   // start observing the visual for resource ready
 630   visualImpl.AddResourceObserver( *this );
 631 }
 632
 633 // Called by a Visual when it's resource is ready
 634 void Control::Impl::ResourceReady( Visual::Base& object)
 635 {
 636   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "ResourceReady replacements pending[%d]\n", mRemoveVisuals.Count() );
 637
 638   Actor self = mControlImpl.Self();
 639
 640   // A resource is ready, find resource in the registered visuals container and get its index
 641   for( auto registeredIter = mVisuals.Begin(),  end = mVisuals.End(); registeredIter != end; ++registeredIter )
 642   {
 643     Internal::Visual::Base& registeredVisualImpl = Toolkit::GetImplementation( (*registeredIter)->visual );
 644
 645     if( &object == &registeredVisualImpl )
 646     {
 647       RegisteredVisualContainer::Iterator visualToRemoveIter;
 648       // Find visual with the same index in the removal container
 649       // Set if off stage as it's replacement is now ready.
 650       // Remove if from removal list as now removed from stage.
 651       // Set Pending flag on the ready visual to false as now ready.
 652       if( FindVisual( (*registeredIter)->index, mRemoveVisuals, visualToRemoveIter ) )
 653       {
 654         (*registeredIter)->pending = false;
 655         Toolkit::GetImplementation( (*visualToRemoveIter)->visual ).SetOffStage( self );
 656         mRemoveVisuals.Erase( visualToRemoveIter );
 657       }
 658       break;
 659     }
 660   }
 661
 662   // A visual is ready so control may need relayouting if staged
 663   if ( self.OnStage() )
 664   {
 665     mControlImpl.RelayoutRequest();
 666   }
 667
 668   // Emit signal if all enabled visuals registered by the control are ready.
 669   if( IsResourceReady() )
 670   {
 671     Dali::Toolkit::Control handle( mControlImpl.GetOwner() );
 672     mResourceReadySignal.Emit( handle );
 673   }
 674 }
 675
 676 bool Control::Impl::IsResourceReady() const
 677 {
 678   // Iterate through and check all the enabled visuals are ready
 679   for( auto visualIter = mVisuals.Begin();
 680          visualIter != mVisuals.End(); ++visualIter )
 681   {
 682     const Toolkit::Visual::Base visual = (*visualIter)->visual;
 683     const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 684
 685     // one of the enabled visuals is not ready
 686     if( !visualImpl.IsResourceReady() && (*visualIter)->enabled )
 687     {
 688       return false;
 689     }
 690   }
 691   return true;
 692 }
 693
 694 Toolkit::Visual::ResourceStatus Control::Impl::GetVisualResourceStatus( Property::Index index ) const
 695 {
 696   RegisteredVisualContainer::Iterator iter;
 697   if ( FindVisual( index, mVisuals, iter ) )
 698   {
 699     const Toolkit::Visual::Base visual = (*iter)->visual;
 700     const Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 701     return visualImpl.GetResourceStatus( );
 702   }
 703
 704   return Toolkit::Visual::ResourceStatus::PREPARING;
 705 }
 706
 707 Dali::Animation Control::Impl::CreateTransition( const Toolkit::TransitionData& handle )
 708 {
 709   Dali::Animation transition;
 710   const Internal::TransitionData& transitionData = Toolkit::GetImplementation( handle );
 711
 712   if( transitionData.Count() > 0 )
 713   {
 714     // Setup a Transition from TransitionData.
 715     TransitionData::Iterator end = transitionData.End();
 716     for( TransitionData::Iterator iter = transitionData.Begin() ;
 717          iter != end; ++iter )
 718     {
 719       TransitionData::Animator* animator = (*iter);
 720
 721       Toolkit::Visual::Base visual = GetVisualByName( mVisuals, animator->objectName );
 722
 723       if( visual )
 724       {
 725 #if defined(DEBUG_ENABLED)
 726         Dali::TypeInfo typeInfo;
 727         ControlWrapper* controlWrapperImpl = dynamic_cast<ControlWrapper*>(&mControlImpl);
 728         if( controlWrapperImpl )
 729         {
 730           typeInfo = controlWrapperImpl->GetTypeInfo();
 731         }
 732
 733         DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Found %s visual for %s\n",
 734                        visual.GetName().c_str(), typeInfo?typeInfo.GetName().c_str():"Unknown" );
 735 #endif
 736         Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 737         visualImpl.AnimateProperty( transition, *animator );
 738       }
 739       else
 740       {
 741         DALI_LOG_INFO( gLogFilter, Debug::Concise, "CreateTransition: Could not find visual. Trying actors");
 742         // Otherwise, try any actor children of control (Including the control)
 743         Actor child = mControlImpl.Self().FindChildByName( animator->objectName );
 744         if( child )
 745         {
 746           Property::Index propertyIndex = DevelHandle::GetPropertyIndex( child, animator->propertyKey );
 747           if( propertyIndex != Property::INVALID_INDEX )
 748           {
 749             if( animator->animate == false )
 750             {
 751               if( animator->targetValue.GetType() != Property::NONE )
 752               {
 753                 child.SetProperty( propertyIndex, animator->targetValue );
 754               }
 755             }
 756             else // animate the property
 757             {
 758               if( animator->initialValue.GetType() != Property::NONE )
 759               {
 760                 child.SetProperty( propertyIndex, animator->initialValue );
 761               }
 762
 763               if( ! transition )
 764               {
 765                 transition = Dali::Animation::New( 0.1f );
 766               }
 767
 768               transition.AnimateTo( Property( child, propertyIndex ),
 769                                     animator->targetValue,
 770                                     animator->alphaFunction,
 771                                     TimePeriod( animator->timePeriodDelay,
 772                                                 animator->timePeriodDuration ) );
 773             }
 774           }
 775         }
 776       }
 777     }
 778   }
 779
 780   return transition;
 781 }
 782
 783 void Control::Impl::DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes )
 784 {
 785   RegisteredVisualContainer::Iterator iter;
 786   if ( FindVisual( visualIndex, mVisuals, iter ) )
 787   {
 788     Toolkit::GetImplementation((*iter)->visual).DoAction( actionId, attributes );
 789   }
 790 }
 791
 792 void Control::Impl::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 793 {
 794   Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 795
 796   if ( control )
 797   {
 798     Control& controlImpl( GetImplementation( control ) );
 799
 800     switch ( index )
 801     {
 802       case Toolkit::Control::Property::STYLE_NAME:
 803       {
 804         controlImpl.SetStyleName( value.Get< std::string >() );
 805         break;
 806       }
 807
 808       case Toolkit::DevelControl::Property::STATE:
 809       {
 810         bool withTransitions=true;
 811         const Property::Value* valuePtr=&value;
 812         Property::Map* map = value.GetMap();
 813         if(map)
 814         {
 815           Property::Value* value2 = map->Find("withTransitions");
 816           if( value2 )
 817           {
 818             withTransitions = value2->Get<bool>();
 819           }
 820
 821           valuePtr = map->Find("state");
 822         }
 823
 824         if( valuePtr )
 825         {
 826           Toolkit::DevelControl::State state( controlImpl.mImpl->mState );
 827           if( Scripting::GetEnumerationProperty< Toolkit::DevelControl::State >( *valuePtr, ControlStateTable, ControlStateTableCount, state ) )
 828           {
 829             controlImpl.mImpl->SetState( state, withTransitions );
 830           }
 831         }
 832       }
 833       break;
 834
 835       case Toolkit::DevelControl::Property::SUB_STATE:
 836       {
 837         std::string subState;
 838         if( value.Get( subState ) )
 839         {
 840           controlImpl.mImpl->SetSubState( subState );
 841         }
 842       }
 843       break;
 844
 845       case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
 846       {
 847         int focusId;
 848         if( value.Get( focusId ) )
 849         {
 850           controlImpl.mImpl->mLeftFocusableActorId = focusId;
 851         }
 852       }
 853       break;
 854
 855       case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
 856       {
 857         int focusId;
 858         if( value.Get( focusId ) )
 859         {
 860           controlImpl.mImpl->mRightFocusableActorId = focusId;
 861         }
 862       }
 863       break;
 864
 865       case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
 866       {
 867         int focusId;
 868         if( value.Get( focusId ) )
 869         {
 870           controlImpl.mImpl->mUpFocusableActorId = focusId;
 871         }
 872       }
 873       break;
 874
 875       case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
 876       {
 877         int focusId;
 878         if( value.Get( focusId ) )
 879         {
 880           controlImpl.mImpl->mDownFocusableActorId = focusId;
 881         }
 882       }
 883       break;
 884
 885       case Toolkit::Control::Property::BACKGROUND_COLOR:
 886       {
 887         DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
 888         controlImpl.SetBackgroundColor( value.Get< Vector4 >() );
 889         break;
 890       }
 891
 892       case Toolkit::Control::Property::BACKGROUND_IMAGE:
 893       {
 894         DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
 895         Image image = Scripting::NewImage( value );
 896         if ( image )
 897         {
 898           controlImpl.SetBackgroundImage( image );
 899         }
 900         else
 901         {
 902           // An empty image means the background is no longer required
 903           controlImpl.ClearBackground();
 904         }
 905         break;
 906       }
 907
 908       case Toolkit::Control::Property::KEY_INPUT_FOCUS:
 909       {
 910         if ( value.Get< bool >() )
 911         {
 912           controlImpl.SetKeyInputFocus();
 913         }
 914         else
 915         {
 916           controlImpl.ClearKeyInputFocus();
 917         }
 918         break;
 919       }
 920
 921       case Toolkit::Control::Property::BACKGROUND:
 922       {
 923         std::string url;
 924         Vector4 color;
 925         const Property::Map* map = value.GetMap();
 926         if( map && !map->Empty() )
 927         {
 928           controlImpl.SetBackground( *map );
 929         }
 930         else if( value.Get( url ) )
 931         {
 932           // don't know the size to load
 933           Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, ImageDimensions() );
 934           if( visual )
 935           {
 936             controlImpl.mImpl->RegisterVisual( Toolkit::Control::Property::BACKGROUND, visual, DepthIndex::BACKGROUND );
 937           }
 938         }
 939         else if( value.Get( color ) )
 940         {
 941           controlImpl.SetBackgroundColor(color);
 942         }
 943         else
 944         {
 945           // The background is an empty property map, so we should clear the background
 946           controlImpl.ClearBackground();
 947         }
 948         break;
 949       }
 950
 951       case Toolkit::Control::Property::MARGIN:
 952       {
 953         Extents margin;
 954         if( value.Get( margin ) )
 955         {
 956           controlImpl.mImpl->SetMargin( margin );
 957         }
 958         break;
 959       }
 960
 961       case Toolkit::Control::Property::PADDING:
 962       {
 963         Extents padding;
 964         if( value.Get( padding ) )
 965         {
 966           controlImpl.mImpl->SetPadding( padding );
 967         }
 968         break;
 969       }
 970
 971       case Toolkit::DevelControl::Property::TOOLTIP:
 972       {
 973         TooltipPtr& tooltipPtr = controlImpl.mImpl->mTooltip;
 974         if( ! tooltipPtr )
 975         {
 976           tooltipPtr = Tooltip::New( control );
 977         }
 978         tooltipPtr->SetProperties( value );
 979         break;
 980       }
 981
 982     }
 983   }
 984 }
 985
 986 Property::Value Control::Impl::GetProperty( BaseObject* object, Property::Index index )
 987 {
 988   Property::Value value;
 989
 990   Toolkit::Control control = Toolkit::Control::DownCast( BaseHandle( object ) );
 991
 992   if ( control )
 993   {
 994     Control& controlImpl( GetImplementation( control ) );
 995
 996     switch ( index )
 997     {
 998       case Toolkit::Control::Property::STYLE_NAME:
 999       {
1000         value = controlImpl.GetStyleName();
1001         break;
1002       }
1003
1004       case Toolkit::DevelControl::Property::STATE:
1005       {
1006         value = controlImpl.mImpl->mState;
1007         break;
1008       }
1009
1010       case Toolkit::DevelControl::Property::SUB_STATE:
1011       {
1012         value = controlImpl.mImpl->mSubStateName;
1013         break;
1014       }
1015
1016       case Toolkit::DevelControl::Property::LEFT_FOCUSABLE_ACTOR_ID:
1017       {
1018         value = controlImpl.mImpl->mLeftFocusableActorId;
1019         break;
1020       }
1021
1022       case Toolkit::DevelControl::Property::RIGHT_FOCUSABLE_ACTOR_ID:
1023       {
1024         value = controlImpl.mImpl->mRightFocusableActorId;
1025         break;
1026       }
1027
1028       case Toolkit::DevelControl::Property::UP_FOCUSABLE_ACTOR_ID:
1029       {
1030         value = controlImpl.mImpl->mUpFocusableActorId;
1031         break;
1032       }
1033
1034       case Toolkit::DevelControl::Property::DOWN_FOCUSABLE_ACTOR_ID:
1035       {
1036         value = controlImpl.mImpl->mDownFocusableActorId;
1037         break;
1038       }
1039
1040       case Toolkit::Control::Property::BACKGROUND_COLOR:
1041       {
1042         DALI_LOG_WARNING( "BACKGROUND_COLOR property is deprecated. Use BACKGROUND property instead\n" );
1043         value = controlImpl.GetBackgroundColor();
1044         break;
1045       }
1046
1047       case Toolkit::Control::Property::BACKGROUND_IMAGE:
1048       {
1049         DALI_LOG_WARNING( "BACKGROUND_IMAGE property is deprecated. Use BACKGROUND property instead\n" );
1050         Property::Map map;
1051         Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1052         if( visual )
1053         {
1054           visual.CreatePropertyMap( map );
1055         }
1056         value = map;
1057         break;
1058       }
1059
1060       case Toolkit::Control::Property::KEY_INPUT_FOCUS:
1061       {
1062         value = controlImpl.HasKeyInputFocus();
1063         break;
1064       }
1065
1066       case Toolkit::Control::Property::BACKGROUND:
1067       {
1068         Property::Map map;
1069         Toolkit::Visual::Base visual = controlImpl.mImpl->GetVisual( Toolkit::Control::Property::BACKGROUND );
1070         if( visual )
1071         {
1072           visual.CreatePropertyMap( map );
1073         }
1074
1075         value = map;
1076         break;
1077       }
1078
1079       case Toolkit::Control::Property::MARGIN:
1080       {
1081         value = controlImpl.mImpl->GetMargin();
1082         break;
1083       }
1084
1085       case Toolkit::Control::Property::PADDING:
1086       {
1087         value = controlImpl.mImpl->GetPadding();
1088         break;
1089       }
1090
1091       case Toolkit::DevelControl::Property::TOOLTIP:
1092       {
1093         Property::Map map;
1094         if( controlImpl.mImpl->mTooltip )
1095         {
1096           controlImpl.mImpl->mTooltip->CreatePropertyMap( map );
1097         }
1098         value = map;
1099         break;
1100       }
1101     }
1102   }
1103
1104   return value;
1105 }
1106
1107
1108 void  Control::Impl::CopyInstancedProperties( RegisteredVisualContainer& visuals, Dictionary<Property::Map>& instancedProperties )
1109 {
1110   for(RegisteredVisualContainer::Iterator iter = visuals.Begin(); iter!= visuals.End(); iter++)
1111   {
1112     if( (*iter)->visual )
1113     {
1114       Property::Map instanceMap;
1115       Toolkit::GetImplementation((*iter)->visual).CreateInstancePropertyMap(instanceMap);
1116       instancedProperties.Add( (*iter)->visual.GetName(), instanceMap );
1117     }
1118   }
1119 }
1120
1121
1122 void Control::Impl::RemoveVisual( RegisteredVisualContainer& visuals, const std::string& visualName )
1123 {
1124   Actor self( mControlImpl.Self() );
1125
1126   for ( RegisteredVisualContainer::Iterator visualIter = visuals.Begin();
1127         visualIter != visuals.End(); ++visualIter )
1128   {
1129     Toolkit::Visual::Base visual = (*visualIter)->visual;
1130     if( visual && visual.GetName() == visualName )
1131     {
1132       Toolkit::GetImplementation(visual).SetOffStage( self );
1133       (*visualIter)->visual.Reset();
1134       visuals.Erase( visualIter );
1135       break;
1136     }
1137   }
1138 }
1139
1140 void Control::Impl::RemoveVisuals( RegisteredVisualContainer& visuals, DictionaryKeys& removeVisuals )
1141 {
1142   Actor self( mControlImpl.Self() );
1143   for( DictionaryKeys::iterator iter = removeVisuals.begin(); iter != removeVisuals.end(); ++iter )
1144   {
1145     const std::string visualName = *iter;
1146     RemoveVisual( visuals, visualName );
1147   }
1148 }
1149
1150 void Control::Impl::RecreateChangedVisuals( Dictionary<Property::Map>& stateVisualsToChange,
1151                              Dictionary<Property::Map>& instancedProperties )
1152 {
1153   Dali::CustomActor handle( mControlImpl.GetOwner() );
1154   for( Dictionary<Property::Map>::iterator iter = stateVisualsToChange.Begin();
1155        iter != stateVisualsToChange.End(); ++iter )
1156   {
1157     const std::string& visualName = (*iter).key;
1158     const Property::Map& toMap = (*iter).entry;
1159
1160     // is it a candidate for re-creation?
1161     bool recreate = false;
1162
1163     Toolkit::Visual::Base visual = GetVisualByName( mVisuals, visualName );
1164     if( visual )
1165     {
1166       Property::Map fromMap;
1167       visual.CreatePropertyMap( fromMap );
1168
1169       Toolkit::Visual::Type fromType = GetVisualTypeFromMap( fromMap );
1170       Toolkit::Visual::Type toType = GetVisualTypeFromMap( toMap );
1171
1172       if( fromType != toType )
1173       {
1174         recreate = true;
1175       }
1176       else
1177       {
1178         if( fromType == Toolkit::Visual::IMAGE || fromType == Toolkit::Visual::N_PATCH
1179             || fromType == Toolkit::Visual::SVG || fromType == Toolkit::Visual::ANIMATED_IMAGE )
1180         {
1181           Property::Value* fromUrl = fromMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1182           Property::Value* toUrl = toMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
1183
1184           if( fromUrl && toUrl )
1185           {
1186             std::string fromUrlString;
1187             std::string toUrlString;
1188             fromUrl->Get(fromUrlString);
1189             toUrl->Get(toUrlString);
1190
1191             if( fromUrlString != toUrlString )
1192             {
1193               recreate = true;
1194             }
1195           }
1196         }
1197       }
1198
1199       const Property::Map* instancedMap = instancedProperties.FindConst( visualName );
1200       if( recreate || instancedMap )
1201       {
1202         RemoveVisual( mVisuals, visualName );
1203         Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1204       }
1205       else
1206       {
1207         // @todo check to see if we can apply toMap without recreating the visual
1208         // e.g. by setting only animatable properties
1209         // For now, recreate all visuals, but merge in instance data.
1210         RemoveVisual( mVisuals, visualName );
1211         Style::ApplyVisual( handle, visualName, toMap, instancedMap );
1212       }
1213     }
1214   }
1215 }
1216
1217 void Control::Impl::ReplaceStateVisualsAndProperties( const StylePtr oldState, const StylePtr newState, const std::string& subState )
1218 {
1219   // Collect all old visual names
1220   DictionaryKeys stateVisualsToRemove;
1221   if( oldState )
1222   {
1223     oldState->visuals.GetKeys( stateVisualsToRemove );
1224     if( ! subState.empty() )
1225     {
1226       const StylePtr* oldSubState = oldState->subStates.FindConst(subState);
1227       if( oldSubState )
1228       {
1229         DictionaryKeys subStateVisualsToRemove;
1230         (*oldSubState)->visuals.GetKeys( subStateVisualsToRemove );
1231         Merge( stateVisualsToRemove, subStateVisualsToRemove );
1232       }
1233     }
1234   }
1235
1236   // Collect all new visual properties
1237   Dictionary<Property::Map> stateVisualsToAdd;
1238   if( newState )
1239   {
1240     stateVisualsToAdd = newState->visuals;
1241     if( ! subState.empty() )
1242     {
1243       const StylePtr* newSubState = newState->subStates.FindConst(subState);
1244       if( newSubState )
1245       {
1246         stateVisualsToAdd.Merge( (*newSubState)->visuals );
1247       }
1248     }
1249   }
1250
1251   // If a name is in both add/remove, move it to change list.
1252   Dictionary<Property::Map> stateVisualsToChange;
1253   FindChangableVisuals( stateVisualsToAdd, stateVisualsToChange, stateVisualsToRemove);
1254
1255   // Copy instanced properties (e.g. text label) of current visuals
1256   Dictionary<Property::Map> instancedProperties;
1257   CopyInstancedProperties( mVisuals, instancedProperties );
1258
1259   // For each visual in remove list, remove from mVisuals
1260   RemoveVisuals( mVisuals, stateVisualsToRemove );
1261
1262   // For each visual in add list, create and add to mVisuals
1263   Dali::CustomActor handle( mControlImpl.GetOwner() );
1264   Style::ApplyVisuals( handle, stateVisualsToAdd, instancedProperties );
1265
1266   // For each visual in change list, if it requires a new visual,
1267   // remove old visual, create and add to mVisuals
1268   RecreateChangedVisuals( stateVisualsToChange, instancedProperties );
1269 }
1270
1271 void Control::Impl::SetState( DevelControl::State newState, bool withTransitions )
1272 {
1273   DevelControl::State oldState = mState;
1274   Dali::CustomActor handle( mControlImpl.GetOwner() );
1275   DALI_LOG_INFO(gLogFilter, Debug::Concise, "Control::Impl::SetState: %s\n",
1276                 (mState == DevelControl::NORMAL ? "NORMAL" :(
1277                   mState == DevelControl::FOCUSED ?"FOCUSED" : (
1278                     mState == DevelControl::DISABLED?"DISABLED":"NONE" ))));
1279
1280   if( mState != newState )
1281   {
1282     // If mState was Disabled, and new state is Focused, should probably
1283     // store that fact, e.g. in another property that FocusManager can access.
1284     mState = newState;
1285
1286     // Trigger state change and transitions
1287     // Apply new style, if stylemanager is available
1288     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1289     if( styleManager )
1290     {
1291       const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1292
1293       if( stylePtr )
1294       {
1295         std::string oldStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( oldState, ControlStateTable, ControlStateTableCount );
1296         std::string newStateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( newState, ControlStateTable, ControlStateTableCount );
1297
1298         const StylePtr* newStateStyle = stylePtr->subStates.Find( newStateName );
1299         const StylePtr* oldStateStyle = stylePtr->subStates.Find( oldStateName );
1300         if( oldStateStyle && newStateStyle )
1301         {
1302           // Only change if both state styles exist
1303           ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, mSubStateName );
1304         }
1305       }
1306     }
1307   }
1308 }
1309
1310 void Control::Impl::SetSubState( const std::string& subStateName, bool withTransitions )
1311 {
1312   if( mSubStateName != subStateName )
1313   {
1314     // Get existing sub-state visuals, and unregister them
1315     Dali::CustomActor handle( mControlImpl.GetOwner() );
1316
1317     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
1318     if( styleManager )
1319     {
1320       const StylePtr stylePtr = GetImpl( styleManager ).GetRecordedStyle( Toolkit::Control( mControlImpl.GetOwner() ) );
1321       if( stylePtr )
1322       {
1323         // Stringify state
1324         std::string stateName = Scripting::GetEnumerationName< Toolkit::DevelControl::State >( mState, ControlStateTable, ControlStateTableCount );
1325
1326         const StylePtr* state = stylePtr->subStates.Find( stateName );
1327         if( state )
1328         {
1329           StylePtr stateStyle(*state);
1330
1331           const StylePtr* newStateStyle = stateStyle->subStates.Find( subStateName );
1332           const StylePtr* oldStateStyle = stateStyle->subStates.Find( mSubStateName );
1333           if( oldStateStyle && newStateStyle )
1334           {
1335             std::string empty;
1336             ReplaceStateVisualsAndProperties( *oldStateStyle, *newStateStyle, empty );
1337           }
1338         }
1339       }
1340     }
1341
1342     mSubStateName = subStateName;
1343   }
1344 }
1345
1346 void Control::Impl::OnStageDisconnection()
1347 {
1348   Actor self = mControlImpl.Self();
1349
1350   // Any visuals set for replacement but not yet ready should still be registered.
1351   // Reason: If a request was made to register a new visual but the control removed from stage before visual was ready
1352   // then when this control appears back on stage it should use that new visual.
1353
1354   // Iterate through all registered visuals and set off stage
1355   SetVisualsOffStage( mVisuals, self );
1356
1357   // Visuals pending replacement can now be taken out of the removal list and set off stage
1358   // Iterate through all replacement visuals and add to a move queue then set off stage
1359   for( auto removalIter = mRemoveVisuals.Begin(), end = mRemoveVisuals.End(); removalIter != end; removalIter++ )
1360   {
1361     Toolkit::GetImplementation((*removalIter)->visual).SetOffStage( self );
1362   }
1363
1364   for( auto replacedIter = mVisuals.Begin(), end = mVisuals.End(); replacedIter != end; replacedIter++ )
1365   {
1366     (*replacedIter)->pending = false;
1367   }
1368
1369   mRemoveVisuals.Clear();
1370 }
1371
1372 void Control::Impl::SetMargin( Extents margin )
1373 {
1374   mControlImpl.mImpl->mMargin = margin;
1375 }
1376
1377 Extents Control::Impl::GetMargin() const
1378 {
1379   return mControlImpl.mImpl->mMargin;
1380 }
1381
1382 void Control::Impl::SetPadding( Extents padding )
1383 {
1384   mControlImpl.mImpl->mPadding = padding;
1385 }
1386
1387 Extents Control::Impl::GetPadding() const
1388 {
1389   return mControlImpl.mImpl->mPadding;
1390 }
1391
1392 } // namespace Internal
1393
1394 } // namespace Toolkit
1395
1396 } // namespace Dali