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