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