30e84a962add2986fb16f9ce53076b9bc85e0fd8
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / button-impl.cpp
1 /*
2  * Copyright (c) 2014 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 "button-impl.h"
20
21 // EXTERNAL INCLUDES
22 #include <cstring> // for strcmp
23 #include <dali/public-api/events/touch-data.h>
24 #include <dali/public-api/images/resource-image.h>
25 #include <dali/public-api/object/type-registry.h>
26 #include <dali/public-api/object/type-registry-helper.h>
27 #include <dali/devel-api/scripting/scripting.h>
28
29 // INTERNAL INCLUDES
30 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
31 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
32
33 /**
34  * Button states and contents
35  *                                         (3) mSelectedContent
36  *  (2) mUnselectedContent                 (2) mSelectedBackgroundContent
37  *  (1) mBackgroundContent                 (1) mBackgroundContent
38  * < unselected > ----------------------- < selected >
39  *       |                OnSelect()            |
40  *       | OnDisabled()                         | OnDisabled()
41  *       |                                      |
42  * < disabled >                           < disabled-selected >
43  *  (2) mDisabledContent                   (2) mDisabledSelectedContent
44  *  (1) mDisabledBackgroundContent         (1) mDisabledBackgroundContent
45  *
46  * The drawing order of child actors is as follows.
47  *
48  *  Top      mLabel
49  *   |       mUnselectedContent / mSelectedContent / mDisabledContent / mDisabledSelectedContent
50  *   |       mSelectedBackgroundContent
51  * Bottom    mBackgroundContent / mDisabledBackgroundContent
52  *
53  * Some of contents may be missed.
54  * And 2 images - fade-in image and fade-out image - in the same layer can be shown during the transition animation. Fade-in image should be above fade-out image.
55  */
56
57 namespace Dali
58 {
59
60 namespace Toolkit
61 {
62
63 namespace Internal
64 {
65
66 namespace
67 {
68
69 BaseHandle Create()
70 {
71   // empty handle as we cannot create button (but type registered for clicked signal)
72   return BaseHandle();
73 }
74
75 // Setup properties, signals and actions using the type-registry.
76 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Button, Toolkit::Control, Create );
77
78 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabled",                     BOOLEAN, DISABLED                     )
79 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "autoRepeating",                BOOLEAN, AUTO_REPEATING               )
80 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "initialAutoRepeatingDelay",    FLOAT,   INITIAL_AUTO_REPEATING_DELAY )
81 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "nextAutoRepeatingDelay",       FLOAT,   NEXT_AUTO_REPEATING_DELAY    )
82 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "togglable",                    BOOLEAN, TOGGLABLE                    )
83 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selected",                     BOOLEAN, SELECTED                     )
84 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedStateImage",         STRING,  UNSELECTED_STATE_IMAGE       )
85 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedStateImage",           STRING,  SELECTED_STATE_IMAGE         )
86 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "disabledStateImage",           STRING,  DISABLED_STATE_IMAGE         )
87 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "unselectedColor",              VECTOR4, UNSELECTED_COLOR             )
88 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "selectedColor",                VECTOR4, SELECTED_COLOR               )
89 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "label",                        MAP,     LABEL                        )
90
91 // Deprecated properties:
92 DALI_PROPERTY_REGISTRATION( Toolkit, Button, "labelText",                    STRING,  LABEL_TEXT                   )
93
94 // Signals:
95 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "pressed",                               SIGNAL_PRESSED               )
96 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "released",                              SIGNAL_RELEASED              )
97 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "clicked",                               SIGNAL_CLICKED               )
98 DALI_SIGNAL_REGISTRATION(   Toolkit, Button, "stateChanged",                          SIGNAL_STATE_CHANGED         )
99
100 // Actions:
101 DALI_ACTION_REGISTRATION(   Toolkit, Button, "buttonClick",                           ACTION_BUTTON_CLICK          )
102
103 DALI_TYPE_REGISTRATION_END()
104
105 const unsigned int INITIAL_AUTOREPEATING_DELAY( 0.15f );
106 const unsigned int NEXT_AUTOREPEATING_DELAY( 0.05f );
107
108 } // unnamed namespace
109
110 Button::Button()
111 : Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
112   mAutoRepeatingTimer(),
113   mUnselectedColor( Color::WHITE ), // The natural colors of the specified images will be used by default.
114   mSelectedColor( Color::WHITE ),
115   mDisabled( false ),
116   mAutoRepeating( false ),
117   mTogglableButton( false ),
118   mSelected( false ),
119   mInitialAutoRepeatingDelay( INITIAL_AUTOREPEATING_DELAY ),
120   mNextAutoRepeatingDelay( NEXT_AUTOREPEATING_DELAY ),
121   mAnimationTime( 0.0f ),
122   mClickActionPerforming( false ),
123   mState( ButtonUp ),
124   mPaintState( UnselectedState )
125 {
126 }
127
128 Button::~Button()
129 {
130 }
131
132 void Button::SetDisabled( bool disabled )
133 {
134   if( disabled == mDisabled )
135   {
136     return;
137   }
138
139   StopTransitionAnimation();
140
141   mDisabled = disabled;
142
143   // Notifies the derived class the button has been disabled.
144   OnDisabled();
145
146   switch( mPaintState )
147   {
148     case UnselectedState:
149     {
150       //Layer Order
151       //(3) mDisabledContent (Inserted)
152       //(4) mUnselectedContent
153       //(2) mDisabledBackgroundContent (Inserted)
154       //(1) mBackgroundContent
155
156       AddButtonImage( mBackgroundContent );
157       TransitionButtonImage( mDisabledBackgroundContent );
158       AddButtonImage( mUnselectedContent );
159       TransitionButtonImage( mDisabledContent );
160
161       AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
162       ReAddLabel();
163
164       TransitionOut( mDecoration[ SELECTED_DECORATION ] );
165       TransitionOut( mUnselectedContent );
166       TransitionOut( mSelectedContent );
167       TransitionOut( mBackgroundContent );
168       TransitionOut( mSelectedBackgroundContent );
169       TransitionOut( mDisabledSelectedContent );
170
171       mPaintState = DisabledUnselectedState;
172       break;
173     }
174     case SelectedState:
175     {
176       //Layer Order
177       //(5) mDisabledSelectedContent (Inserted)
178       //(4) mSelectedContent
179       //(3) mDisabledBackgroundContent (Inserted)
180       //(2) mSelectedBackgroundContent
181       //(1) mBackgroundContent
182
183       AddButtonImage( mBackgroundContent );
184       AddButtonImage( mSelectedBackgroundContent );
185       TransitionButtonImage( mDisabledBackgroundContent );
186       AddButtonImage( mSelectedContent );
187       TransitionButtonImage( mDisabledSelectedContent );
188
189       AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
190       ReAddLabel();
191
192       TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
193       TransitionOut( mUnselectedContent );
194       TransitionOut( mSelectedContent );
195       TransitionOut( mBackgroundContent );
196       TransitionOut( mSelectedBackgroundContent );
197       TransitionOut( mDisabledContent );
198
199       mPaintState = DisabledSelectedState;
200       break;
201     }
202     case DisabledUnselectedState:
203     {
204       //Layer Order
205       //(3) mUnselectedContent (Inserted)
206       //(4) mDisabledContent
207       //(2) mBackgroundContent (Inserted)
208       //(1) mDisabledBackgroundContent
209
210       AddButtonImage( mDisabledBackgroundContent );
211       TransitionButtonImage( mBackgroundContent );
212       AddButtonImage( mDisabledContent );
213       TransitionButtonImage( mUnselectedContent );
214
215       AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
216       ReAddLabel();
217
218       TransitionOut( mDecoration[ SELECTED_DECORATION ] );
219       TransitionOut( mSelectedContent );
220       TransitionOut( mSelectedBackgroundContent );
221       TransitionOut( mDisabledContent );
222       TransitionOut( mDisabledSelectedContent );
223       TransitionOut( mDisabledBackgroundContent );
224
225       mPaintState = UnselectedState;
226       break;
227     }
228     case DisabledSelectedState:
229     {
230       //Layer Order
231       //(4) mSelectedContent (Inserted)
232       //(5) mDisabledSelectedContent
233       //(3) mSelectedBackgroundContent (Inserted)
234       //(2) mBackgroundContent (Inserted)
235       //(1) mDisabledBackgroundContent
236
237       AddButtonImage( mDisabledBackgroundContent );
238       TransitionButtonImage( mBackgroundContent );
239       TransitionButtonImage( mSelectedBackgroundContent );
240       AddButtonImage( mDisabledSelectedContent );
241       TransitionButtonImage( mSelectedContent );
242
243       AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
244       ReAddLabel();
245
246       TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
247       TransitionOut( mUnselectedContent );
248       TransitionOut( mDisabledContent );
249       TransitionOut( mDisabledSelectedContent );
250       TransitionOut( mDisabledBackgroundContent );
251
252       mPaintState = SelectedState;
253       break;
254     }
255   }
256
257   StartTransitionAnimation();
258 }
259
260 bool Button::IsDisabled() const
261 {
262   return mDisabled;
263 }
264
265 void Button::SetAutoRepeating( bool autoRepeating )
266 {
267   mAutoRepeating = autoRepeating;
268
269   // An autorepeating button can't be a togglable button.
270   if( autoRepeating )
271   {
272     mTogglableButton = false;
273
274     if( mSelected )
275     {
276       // Emit a signal is not wanted, only change the appearance.
277       SetSelected( false, false );
278     }
279   }
280 }
281
282 bool Button::IsAutoRepeating() const
283 {
284   return mAutoRepeating;
285 }
286
287 void Button::SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay )
288 {
289   DALI_ASSERT_ALWAYS( initialAutoRepeatingDelay > 0.f );
290   mInitialAutoRepeatingDelay = initialAutoRepeatingDelay;
291 }
292
293 float Button::GetInitialAutoRepeatingDelay() const
294 {
295   return mInitialAutoRepeatingDelay;
296 }
297
298 void Button::SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay )
299 {
300   DALI_ASSERT_ALWAYS( nextAutoRepeatingDelay > 0.f );
301   mNextAutoRepeatingDelay = nextAutoRepeatingDelay;
302 }
303
304 float Button::GetNextAutoRepeatingDelay() const
305 {
306   return mNextAutoRepeatingDelay;
307 }
308
309 void Button::SetTogglableButton( bool togglable )
310 {
311   mTogglableButton = togglable;
312
313   // A togglable button can't be an autorepeating button.
314   if( togglable )
315   {
316     mAutoRepeating = false;
317   }
318 }
319
320 bool Button::IsTogglableButton() const
321 {
322   return mTogglableButton;
323 }
324
325 void Button::SetSelected( bool selected )
326 {
327   if( !mDisabled && mTogglableButton && ( selected != mSelected ) )
328   {
329     SetSelected( selected, true );
330   }
331 }
332
333 void Button::SetSelected( bool selected, bool emitSignal )
334 {
335   StopTransitionAnimation();
336
337   mSelected = selected;
338
339   // Notifies the derived class the button has been selected.
340   OnSelected();
341
342   switch( mPaintState )
343   {
344     case UnselectedState:
345     {
346       //Layer Order
347       //(3) mSelectedContent (Inserted)
348       //(4) mUnselectedContent
349       //(2) mSelectedBackgroundContent (Inserted)
350       //(1) mBackgroundContent
351
352       AddButtonImage( mBackgroundContent );
353       TransitionButtonImage( mSelectedBackgroundContent );
354       AddButtonImage( mUnselectedContent );
355       TransitionButtonImage( mSelectedContent );
356
357       AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
358       TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
359       ReAddLabel();
360
361       TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
362       TransitionOut( mUnselectedContent );
363       TransitionOut( mDisabledContent );
364       TransitionOut( mDisabledSelectedContent );
365       TransitionOut( mDisabledBackgroundContent );
366
367       mPaintState = SelectedState;
368       break;
369     }
370     case SelectedState:
371     {
372       //Layer Order
373       //(3) mUnselectedContent (Inserted)
374       //(2) mSelectedContent
375       //(1) mBackgroundContent
376
377       AddButtonImage( mBackgroundContent );
378       AddButtonImage( mSelectedContent );
379       TransitionButtonImage( mUnselectedContent );
380
381       AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
382       TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
383       ReAddLabel();
384
385       TransitionOut( mDecoration[ SELECTED_DECORATION ] );
386       TransitionOut( mSelectedContent );
387       TransitionOut( mSelectedBackgroundContent );
388       TransitionOut( mDisabledContent );
389       TransitionOut( mDisabledSelectedContent );
390       TransitionOut( mDisabledBackgroundContent );
391
392       mPaintState = UnselectedState;
393       break;
394     }
395     case DisabledUnselectedState:
396     case DisabledSelectedState:
397     {
398       DALI_ASSERT_DEBUG( 0 && "Shouldn't be able to change paint state if the button is disabled." );
399       break;
400     }
401   }
402
403   StartTransitionAnimation();
404
405   if( emitSignal )
406   {
407     Toolkit::Button handle( GetOwner() );
408
409     // Emit signal.
410     mStateChangedSignal.Emit( handle );
411   }
412
413   RelayoutRequest();
414 }
415
416 bool Button::IsSelected() const
417 {
418   return mTogglableButton && mSelected;
419 }
420
421 void Button::SetAnimationTime( float animationTime )
422 {
423   mAnimationTime = animationTime;
424 }
425
426 float Button::GetAnimationTime() const
427 {
428   return mAnimationTime;
429 }
430
431 void Button::SetLabelText( const std::string& label )
432 {
433   Property::Map labelProperty;
434   labelProperty.Insert( "text", label );
435   ModifyLabel( labelProperty );
436 }
437
438 std::string Button::GetLabelText() const
439 {
440   Toolkit::TextLabel label = Dali::Toolkit::TextLabel::DownCast( mLabel );
441   if( label )
442   {
443     return label.GetProperty<std::string>( Dali::Toolkit::TextLabel::Property::TEXT );
444   }
445   return std::string();
446 }
447
448 void Button::ModifyLabel( const Property::Map& properties )
449 {
450   // If we don't have a label yet, create one.
451   if( !mLabel )
452   {
453     // If we don't have a label, create one and set it up.
454     // Note: The label text is set from the passed in property map after creation.
455     mLabel = Toolkit::TextLabel::New();
456     mLabel.SetPosition( 0.0f, 0.0f );
457     // label should be the top of the button
458     Self().Add( mLabel );
459   }
460
461   // Set any properties specified for the label by iterating through all property key-value pairs.
462   for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
463   {
464     const StringValuePair& propertyPair( properties.GetPair( i ) );
465
466     // Convert the property string to a property index.
467     Property::Index setPropertyIndex = mLabel.GetPropertyIndex( propertyPair.first );
468     if( setPropertyIndex != Property::INVALID_INDEX )
469     {
470       // If the conversion worked, we have a valid property index,
471       // Set the property to the new value.
472       mLabel.SetProperty( setPropertyIndex, propertyPair.second );
473     }
474   }
475
476   // Notify derived button classes of the change.
477   OnLabelSet( false );
478
479   RelayoutRequest();
480 }
481
482 Actor& Button::GetLabelActor()
483 {
484   return mLabel;
485 }
486
487 void Button::SetDecoration( DecorationState state, Actor actor )
488 {
489   if( mDecoration[ state ] && mDecoration[ state ].GetParent() )
490   {
491     mDecoration[ state ].Unparent();
492   }
493
494   mDecoration[ state ] = actor;
495   mDecoration[ state ].SetColorMode( USE_OWN_COLOR );
496
497   ResetImageLayers();
498   RelayoutRequest();
499 }
500
501 Actor& Button::GetDecoration( DecorationState state )
502 {
503   return mDecoration[ state ];
504 }
505
506 void Button::SetupContent( Actor& actorToModify, Actor newActor )
507 {
508   if( newActor )
509   {
510     StopTransitionAnimation();
511
512     if( actorToModify && actorToModify.GetParent() )
513     {
514       actorToModify.Unparent();
515     }
516
517     actorToModify = newActor;
518
519     if( actorToModify )
520     {
521       actorToModify.SetAnchorPoint( AnchorPoint::TOP_LEFT );
522       actorToModify.SetParentOrigin( ParentOrigin::TOP_LEFT );
523       actorToModify.SetPosition( 0.f, 0.f );
524     }
525
526     ResetImageLayers();
527   }
528 }
529
530 void Button::SetUnselectedColor( const Vector4& color )
531 {
532   mUnselectedColor = color;
533
534   if( mUnselectedContent && !GetUnselectedImageFilename().empty() )
535   {
536     // If there is existing unselected content, change the color on it directly.
537     mUnselectedContent.SetColor( mUnselectedColor );
538   }
539   else
540   {
541     // If there is no existing content, create a new actor to use for flat color.
542     Toolkit::Control unselectedContentActor = Toolkit::Control::New();
543     unselectedContentActor.SetBackgroundColor( mUnselectedColor );
544     SetupContent( mUnselectedContent, unselectedContentActor );
545     mUnselectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
546   }
547 }
548
549 const Vector4 Button::GetUnselectedColor() const
550 {
551   return mUnselectedColor;
552 }
553
554 void Button::SetSelectedColor( const Vector4& color )
555 {
556   mSelectedColor = color;
557
558   if( mSelectedContent && !GetSelectedImageFilename().empty() )
559   {
560     // If there is existing unselected content, change the color on it directly.
561     mSelectedContent.SetColor( mSelectedColor );
562   }
563   else
564   {
565     // If there is no existing content, create a new actor to use for flat color.
566     Toolkit::Control selectedContentActor = Toolkit::Control::New();
567     selectedContentActor.SetBackgroundColor( mSelectedColor );
568     SetupContent( mSelectedContent, selectedContentActor );
569     mSelectedContent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
570   }
571 }
572
573 const Vector4 Button::GetSelectedColor() const
574 {
575   return mSelectedColor;
576 }
577
578 void Button::SetUnselectedImage( const std::string& filename )
579 {
580   Toolkit::ImageView newContent;
581   if( !filename.empty() )
582   {
583     newContent = Toolkit::ImageView::New( filename );
584   }
585   else
586   {
587     newContent = Toolkit::ImageView::New();
588   }
589
590   if( newContent )
591   {
592     SetupContent( mUnselectedContent, newContent );
593
594     mUnselectedContent.SetColor( mUnselectedColor );
595
596     OnUnselectedImageSet();
597     RelayoutRequest();
598   }
599 }
600
601 Actor& Button::GetUnselectedImage()
602 {
603   return mUnselectedContent;
604 }
605
606 void Button::SetSelectedImage( const std::string& filename )
607 {
608   Toolkit::ImageView newContent;
609   if( !filename.empty() )
610   {
611    newContent = Toolkit::ImageView::New( filename );
612   }
613   else
614   {
615     newContent = Toolkit::ImageView::New();
616   }
617
618   if( newContent )
619   {
620     SetupContent( mSelectedContent, newContent );
621
622     mSelectedContent.SetColor( mSelectedColor );
623
624     OnSelectedImageSet();
625     RelayoutRequest();
626   }
627 }
628
629 Actor& Button::GetSelectedImage()
630 {
631   return mSelectedContent;
632 }
633
634 void Button::SetBackgroundImage( const std::string& filename )
635 {
636   SetupContent( mBackgroundContent, Toolkit::ImageView::New( filename ) );
637
638   OnBackgroundImageSet();
639   RelayoutRequest();
640 }
641
642 Actor& Button::GetBackgroundImage()
643 {
644   return mBackgroundContent;
645 }
646
647 void Button::SetSelectedBackgroundImage( const std::string& filename )
648 {
649   SetupContent( mSelectedBackgroundContent, Toolkit::ImageView::New( filename ) );
650
651   OnSelectedBackgroundImageSet();
652   RelayoutRequest();
653 }
654
655 Actor& Button::GetSelectedBackgroundImage()
656 {
657   return mSelectedBackgroundContent;
658 }
659
660 void Button::SetDisabledImage( const std::string& filename )
661 {
662   SetupContent( mDisabledContent, Toolkit::ImageView::New( filename ) );
663
664   OnDisabledImageSet();
665   RelayoutRequest();
666 }
667
668 Actor& Button::GetDisabledImage()
669 {
670   return mDisabledContent;
671 }
672
673 void Button::SetDisabledSelectedImage( const std::string& filename )
674 {
675   SetupContent( mDisabledSelectedContent, Toolkit::ImageView::New( filename ) );
676
677   OnDisabledSelectedImageSet();
678   RelayoutRequest();
679 }
680
681 Actor& Button::GetDisabledSelectedImage()
682 {
683   return mDisabledSelectedContent;
684 }
685
686 void Button::SetDisabledBackgroundImage( const std::string& filename )
687 {
688   SetupContent( mDisabledBackgroundContent, Toolkit::ImageView::New( filename ) );
689
690   OnDisabledBackgroundImageSet();
691   RelayoutRequest();
692 }
693
694 Actor& Button::GetDisabledBackgroundImage()
695 {
696   return mDisabledBackgroundContent;
697 }
698
699 std::string Button::GetUnselectedImageFilename() const
700 {
701   if( mUnselectedContent )
702   {
703     ResourceImage image = ResourceImage::DownCast( mUnselectedContent );
704     if( image )
705     {
706       return image.GetUrl();
707     }
708   }
709   return std::string();
710 }
711
712 std::string Button::GetSelectedImageFilename() const
713 {
714   if( mSelectedContent )
715   {
716     ResourceImage image = ResourceImage::DownCast( mSelectedContent );
717     if( image )
718     {
719       return image.GetUrl();
720     }
721   }
722   return std::string();
723 }
724
725 std::string Button::GetBackgroundImageFilename() const
726 {
727   if( mBackgroundContent )
728   {
729     ResourceImage image = ResourceImage::DownCast( mBackgroundContent );
730     if( image )
731     {
732       return image.GetUrl();
733     }
734   }
735   return std::string();
736 }
737
738 std::string Button::GetSelectedBackgroundImageFilename() const
739 {
740   if( mSelectedBackgroundContent )
741   {
742     ResourceImage image = ResourceImage::DownCast( mSelectedBackgroundContent );
743     if( image )
744     {
745       return image.GetUrl();
746     }
747   }
748   return std::string();
749 }
750
751 std::string Button::GetDisabledImageFilename() const
752 {
753   if( mDisabledContent )
754   {
755     ResourceImage image = ResourceImage::DownCast( mDisabledContent );
756     if( image )
757     {
758       return image.GetUrl();
759     }
760   }
761   return std::string();
762 }
763
764 std::string Button::GetDisabledSelectedImageFilename() const
765 {
766   if( mDisabledSelectedContent )
767   {
768     ResourceImage image = ResourceImage::DownCast( mDisabledSelectedContent );
769     if( image )
770     {
771       return image.GetUrl();
772     }
773   }
774   return std::string();
775 }
776
777 std::string Button::GetDisabledBackgroundImageFilename() const
778 {
779   if( mDisabledBackgroundContent )
780   {
781     ResourceImage image = ResourceImage::DownCast( mDisabledBackgroundContent );
782     if( image )
783     {
784       return image.GetUrl();
785     }
786   }
787   return std::string();
788 }
789
790 bool Button::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
791 {
792   bool ret = false;
793
794   Dali::BaseHandle handle( object );
795
796   Toolkit::Button button = Toolkit::Button::DownCast( handle );
797
798   DALI_ASSERT_ALWAYS( button );
799
800   if( 0 == strcmp( actionName.c_str(), ACTION_BUTTON_CLICK ) )
801   {
802     ret = GetImplementation( button ).DoClickAction( attributes );
803   }
804
805   return ret;
806 }
807
808 bool Button::DoClickAction( const Property::Map& attributes )
809 {
810   // Prevents the button signals from doing a recursive loop by sending an action
811   // and re-emitting the signals.
812   if( !mClickActionPerforming )
813   {
814     mClickActionPerforming = true;
815     OnButtonDown();
816     mState = ButtonDown;
817     OnButtonUp();
818     mClickActionPerforming = false;
819
820     return true;
821   }
822
823   return false;
824 }
825
826 void Button::OnButtonDown()
827 {
828   if( !mTogglableButton )
829   {
830     Pressed();
831
832     if( mAutoRepeating )
833     {
834       SetUpTimer( mInitialAutoRepeatingDelay );
835     }
836   }
837
838   // The pressed signal should be emitted regardless of toggle mode.
839   Toolkit::Button handle( GetOwner() );
840   mPressedSignal.Emit( handle );
841 }
842
843 void Button::OnButtonUp()
844 {
845   if( ButtonDown == mState )
846   {
847     if( mTogglableButton )
848     {
849       SetSelected( !mSelected );
850     }
851     else
852     {
853       Released();
854
855       if( mAutoRepeating )
856       {
857         mAutoRepeatingTimer.Reset();
858       }
859     }
860
861     // The clicked and released signals should be emitted regardless of toggle mode.
862     Toolkit::Button handle( GetOwner() );
863     mReleasedSignal.Emit( handle );
864     mClickedSignal.Emit( handle );
865   }
866 }
867
868 void Button::OnTouchPointLeave()
869 {
870   if( ButtonDown == mState )
871   {
872     if( !mTogglableButton )
873     {
874       Released();
875
876       if( mAutoRepeating )
877       {
878         mAutoRepeatingTimer.Reset();
879       }
880     }
881
882     // The released signal should be emitted regardless of toggle mode.
883     Toolkit::Button handle( GetOwner() );
884     mReleasedSignal.Emit( handle );
885   }
886 }
887
888 void Button::OnTouchPointInterrupted()
889 {
890   OnTouchPointLeave();
891 }
892
893 Toolkit::Button::ButtonSignalType& Button::PressedSignal()
894 {
895   return mPressedSignal;
896 }
897
898 Toolkit::Button::ButtonSignalType& Button::ReleasedSignal()
899 {
900   return mReleasedSignal;
901 }
902
903 Toolkit::Button::ButtonSignalType& Button::ClickedSignal()
904 {
905   return mClickedSignal;
906 }
907
908 Toolkit::Button::ButtonSignalType& Button::StateChangedSignal()
909 {
910   return mStateChangedSignal;
911 }
912
913 bool Button::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
914 {
915   Dali::BaseHandle handle( object );
916
917   bool connected( true );
918   Toolkit::Button button = Toolkit::Button::DownCast( handle );
919
920   if( 0 == strcmp( signalName.c_str(), SIGNAL_PRESSED ) )
921   {
922     button.PressedSignal().Connect( tracker, functor );
923   }
924   else if( 0 == strcmp( signalName.c_str(), SIGNAL_RELEASED ) )
925   {
926     button.ReleasedSignal().Connect( tracker, functor );
927   }
928   else if( 0 == strcmp( signalName.c_str(), SIGNAL_CLICKED ) )
929   {
930     button.ClickedSignal().Connect( tracker, functor );
931   }
932   else if( 0 == strcmp( signalName.c_str(), SIGNAL_STATE_CHANGED ) )
933   {
934     button.StateChangedSignal().Connect( tracker, functor );
935   }
936   else
937   {
938     // signalName does not match any signal
939     connected = false;
940   }
941
942   return connected;
943 }
944
945 void Button::OnInitialize()
946 {
947   Actor self = Self();
948
949   mTapDetector = TapGestureDetector::New();
950   mTapDetector.Attach( self );
951   mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
952
953   self.SetKeyboardFocusable( true );
954
955   self.TouchSignal().Connect( this, &Button::OnTouch );
956 }
957
958 bool Button::OnAccessibilityActivated()
959 {
960   return OnKeyboardEnter();
961 }
962
963 bool Button::OnKeyboardEnter()
964 {
965   // When the enter key is pressed, or button is activated, the click action is performed.
966   Property::Map attributes;
967   bool ret = DoClickAction( attributes );
968
969   return ret;
970 }
971
972 void Button::OnStageDisconnection()
973 {
974   if( ButtonDown == mState )
975   {
976     if( !mTogglableButton )
977     {
978       Released();
979
980       if( mAutoRepeating )
981       {
982         mAutoRepeatingTimer.Reset();
983       }
984     }
985   }
986
987   mState = ButtonUp;
988
989   Control::OnStageDisconnection();
990 }
991
992 bool Button::OnTouch( Actor actor, const TouchData& touch )
993 {
994   // Only events are processed when the button is not disabled and the touch event has only
995   // one touch point.
996   if( ( !mDisabled ) && ( 1 == touch.GetPointCount() ) )
997   {
998     switch( touch.GetState( 0 ) )
999     {
1000       case PointState::DOWN:
1001       {
1002         OnButtonDown(); // Notification for derived classes.
1003
1004         // Sets the button state to ButtonDown.
1005         mState = ButtonDown;
1006         break;
1007       }
1008       case PointState::UP:
1009       {
1010         OnButtonUp(); // Notification for derived classes.
1011
1012         // Sets the button state to ButtonUp.
1013         mState = ButtonUp;
1014         break;
1015       }
1016       case PointState::INTERRUPTED:
1017       {
1018         OnTouchPointInterrupted(); // Notification for derived classes.
1019
1020         // Sets the button state to the default (ButtonUp).
1021         mState = ButtonUp;
1022         break;
1023       }
1024       case PointState::LEAVE:
1025       {
1026         OnTouchPointLeave(); // Notification for derived classes.
1027
1028         // Sets the button state to the default (ButtonUp).
1029         mState = ButtonUp;
1030         break;
1031       }
1032       case PointState::MOTION:
1033       case PointState::STATIONARY: // FALLTHROUGH
1034       {
1035         // Nothing to do
1036         break;
1037       }
1038     }
1039   }
1040   else if( 1 < touch.GetPointCount() )
1041   {
1042     OnTouchPointLeave(); // Notification for derived classes.
1043
1044     // Sets the button state to the default (ButtonUp).
1045     mState = ButtonUp;
1046   }
1047
1048   return false;
1049 }
1050
1051 void Button::OnTap(Actor actor, const TapGesture& tap)
1052 {
1053   // Do nothing.
1054 }
1055
1056 void Button::SetUpTimer( float delay )
1057 {
1058   mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
1059   mAutoRepeatingTimer.TickSignal().Connect( this, &Button::AutoRepeatingSlot );
1060   mAutoRepeatingTimer.Start();
1061 }
1062
1063 bool Button::AutoRepeatingSlot()
1064 {
1065   bool consumed = false;
1066   if( !mDisabled )
1067   {
1068     // Restart the autorepeat timer.
1069     SetUpTimer( mNextAutoRepeatingDelay );
1070
1071     Pressed();
1072
1073     Toolkit::Button handle( GetOwner() );
1074
1075     //Emit signal.
1076     consumed = mReleasedSignal.Emit( handle );
1077     consumed |= mClickedSignal.Emit( handle );
1078     consumed |= mPressedSignal.Emit( handle );
1079  }
1080
1081   return consumed;
1082 }
1083
1084 void Button::Pressed()
1085 {
1086   if( mPaintState == UnselectedState )
1087   {
1088     StopTransitionAnimation();
1089
1090     // Notifies the derived class the button has been pressed.
1091     OnPressed();
1092
1093     //Layer Order
1094     //(4) mSelectedContent (Inserted)
1095     //(3) mUnselectedContent
1096     //(2) mSelectedBackgroundContent (Inserted)
1097     //(1) mBackgroundContent
1098
1099     AddButtonImage( mBackgroundContent );
1100     TransitionButtonImage( mSelectedBackgroundContent );
1101     AddButtonImage( mUnselectedContent );
1102     TransitionButtonImage( mSelectedContent );
1103
1104     AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1105     TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
1106     ReAddLabel();
1107
1108     TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
1109     TransitionOut( mUnselectedContent );
1110     TransitionOut( mDisabledContent );
1111     TransitionOut( mDisabledSelectedContent );
1112     TransitionOut( mDisabledBackgroundContent );
1113
1114     mPaintState = SelectedState;
1115
1116     StartTransitionAnimation();
1117   }
1118 }
1119
1120 void Button::Released()
1121 {
1122   if( mPaintState == SelectedState )
1123   {
1124     StopTransitionAnimation();
1125
1126     // Notifies the derived class the button has been released.
1127     OnReleased();
1128
1129     //Layer Order
1130     //(3) mUnselectedContent (Inserted)
1131     //(2) mSelectedContent
1132     //(1) mBackgroundContent
1133
1134     AddButtonImage( mBackgroundContent );
1135     AddButtonImage( mSelectedContent );
1136     TransitionButtonImage( mUnselectedContent );
1137
1138     AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1139     TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1140     ReAddLabel();
1141
1142     TransitionOut( mDecoration[ SELECTED_DECORATION ] );
1143     TransitionOut( mSelectedContent );
1144     TransitionOut( mSelectedBackgroundContent );
1145     TransitionOut( mDisabledContent );
1146     TransitionOut( mDisabledSelectedContent );
1147     TransitionOut( mDisabledBackgroundContent );
1148
1149     mPaintState = UnselectedState;
1150
1151     StartTransitionAnimation();
1152   }
1153 }
1154
1155 Button::ButtonState Button::GetState()
1156 {
1157   return mState;
1158 }
1159
1160 Button::PaintState Button::GetPaintState()
1161 {
1162   return mPaintState;
1163 }
1164
1165 void Button::PrepareAddButtonImage( Actor& actor )
1166 {
1167   if( actor )
1168   {
1169     Self().Add( actor );
1170     PrepareForTranstionOut( actor );
1171   }
1172 }
1173
1174 void Button::TransitionButtonImage( Actor& actor )
1175 {
1176   if( actor )
1177   {
1178     if( !actor.GetParent() )
1179     {
1180       Self().Add( actor );
1181     }
1182
1183     OnTransitionIn( actor );
1184   }
1185 }
1186
1187 void Button::AddButtonImage( Actor& actor )
1188 {
1189   if( actor )
1190   {
1191     Self().Add( actor );
1192   }
1193 }
1194
1195 void Button::ReAddLabel()
1196 {
1197   if( mLabel )
1198   {
1199     mLabel.Unparent();
1200     Self().Add( mLabel );
1201   }
1202 }
1203
1204 void Button::RemoveButtonImage( Actor& actor )
1205 {
1206   if( actor )
1207   {
1208     if( actor.GetParent() )
1209     {
1210       Self().Remove( actor );
1211     }
1212     PrepareForTranstionIn( actor );
1213   }
1214 }
1215
1216 unsigned int Button::FindChildIndex( Actor& actor )
1217 {
1218   Actor self = Self();
1219   unsigned int childrenNum = self.GetChildCount();
1220
1221   for( unsigned int i = 0; i < childrenNum; i++ )
1222   {
1223     Actor child = self.GetChildAt( i );
1224     if( child == actor )
1225     {
1226       return i;
1227     }
1228   }
1229
1230   return childrenNum;
1231 }
1232
1233 void Button::TransitionOut( Actor actor )
1234 {
1235   OnTransitionOut( actor );
1236 }
1237
1238 void Button::ResetImageLayers()
1239 {
1240   // Ensure that all layers are in the correct order and state according to the paint state
1241
1242   switch( mPaintState )
1243   {
1244     case UnselectedState:
1245     {
1246       //Layer Order
1247       //(2) mUnselectedContent
1248       //(1) mBackgroundContent
1249
1250       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1251       RemoveButtonImage( mSelectedContent );
1252       RemoveButtonImage( mSelectedBackgroundContent );
1253       RemoveButtonImage( mDisabledContent );
1254       RemoveButtonImage( mDisabledSelectedContent );
1255       RemoveButtonImage( mDisabledBackgroundContent );
1256
1257       PrepareAddButtonImage( mBackgroundContent );
1258       PrepareAddButtonImage( mUnselectedContent );
1259
1260       PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1261       ReAddLabel();
1262       break;
1263     }
1264     case SelectedState:
1265     {
1266       //Layer Order
1267       //(3) mSelectedContent
1268       //(2) mSelectedBackgroundContent
1269       //(1) mBackgroundContent
1270
1271       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1272       RemoveButtonImage( mUnselectedContent );
1273       RemoveButtonImage( mDisabledContent );
1274       RemoveButtonImage( mDisabledSelectedContent );
1275       RemoveButtonImage( mDisabledBackgroundContent );
1276
1277       PrepareAddButtonImage( mBackgroundContent );
1278       PrepareAddButtonImage( mSelectedBackgroundContent );
1279       PrepareAddButtonImage( mSelectedContent );
1280
1281       PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1282       ReAddLabel();
1283       break;
1284     }
1285     case DisabledUnselectedState:
1286     {
1287       //Layer Order
1288       //(2) mDisabledContent
1289       //(1) mDisabledBackgroundContent
1290
1291       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1292       RemoveButtonImage( mUnselectedContent );
1293       RemoveButtonImage( mBackgroundContent );
1294       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1295       RemoveButtonImage( mSelectedContent );
1296       RemoveButtonImage( mDisabledSelectedContent );
1297       RemoveButtonImage( mSelectedBackgroundContent );
1298
1299       PrepareAddButtonImage( mDisabledBackgroundContent ? mDisabledBackgroundContent : mBackgroundContent );
1300       PrepareAddButtonImage( mDisabledContent ? mDisabledContent : mUnselectedContent );
1301
1302       PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1303       ReAddLabel();
1304       break;
1305     }
1306     case DisabledSelectedState:
1307     {
1308       //Layer Order
1309       // (2) mDisabledSelectedContent
1310       // (1) mDisabledBackgroundContent
1311
1312       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1313       RemoveButtonImage( mUnselectedContent );
1314       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1315       RemoveButtonImage( mSelectedContent );
1316       RemoveButtonImage( mBackgroundContent );
1317       RemoveButtonImage( mSelectedBackgroundContent );
1318       RemoveButtonImage( mDisabledContent );
1319
1320       if( mDisabledBackgroundContent )
1321       {
1322         PrepareAddButtonImage( mDisabledBackgroundContent );
1323       }
1324       else
1325       {
1326         PrepareAddButtonImage( mBackgroundContent );
1327         PrepareAddButtonImage( mSelectedBackgroundContent );
1328       }
1329
1330       PrepareAddButtonImage( mDisabledSelectedContent ? mDisabledSelectedContent : mSelectedContent );
1331
1332       PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1333       ReAddLabel();
1334       break;
1335     }
1336   }
1337 }
1338
1339 void Button::StartTransitionAnimation()
1340 {
1341   if( mTransitionAnimation )
1342   {
1343     mTransitionAnimation.Play();
1344   }
1345   else
1346   {
1347     ResetImageLayers();
1348   }
1349 }
1350
1351 void Button::StopTransitionAnimation()
1352 {
1353   if( mTransitionAnimation )
1354   {
1355     mTransitionAnimation.Clear();
1356     mTransitionAnimation.Reset();
1357   }
1358 }
1359
1360 Dali::Animation Button::GetTransitionAnimation()
1361 {
1362   if( !mTransitionAnimation )
1363   {
1364     mTransitionAnimation = Dali::Animation::New( GetAnimationTime() );
1365     mTransitionAnimation.FinishedSignal().Connect( this, &Button::TransitionAnimationFinished );
1366   }
1367
1368   return mTransitionAnimation;
1369 }
1370
1371 void Button::TransitionAnimationFinished( Dali::Animation& source )
1372 {
1373   StopTransitionAnimation();
1374   ResetImageLayers();
1375 }
1376
1377 void Button::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
1378 {
1379   Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1380
1381   if ( button )
1382   {
1383     switch ( index )
1384     {
1385       case Toolkit::Button::Property::DISABLED:
1386       {
1387         GetImplementation( button ).SetDisabled( value.Get< bool >() );
1388         break;
1389       }
1390
1391       case Toolkit::Button::Property::AUTO_REPEATING:
1392       {
1393         GetImplementation( button ).SetAutoRepeating( value.Get< bool >() );
1394         break;
1395       }
1396
1397       case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1398       {
1399         GetImplementation( button ).SetInitialAutoRepeatingDelay( value.Get< float >() );
1400         break;
1401       }
1402
1403       case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1404       {
1405         GetImplementation( button ).SetNextAutoRepeatingDelay( value.Get< float >() );
1406         break;
1407       }
1408
1409       case Toolkit::Button::Property::TOGGLABLE:
1410       {
1411         GetImplementation( button ).SetTogglableButton( value.Get< bool >() );
1412         break;
1413       }
1414
1415       case Toolkit::Button::Property::SELECTED:
1416       {
1417         GetImplementation( button ).SetSelected( value.Get< bool >() );
1418         break;
1419       }
1420
1421       case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1422       {
1423         GetImplementation( button ).SetUnselectedImage( value.Get< std::string >() );
1424         break;
1425       }
1426
1427       case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1428       {
1429         GetImplementation( button ).SetSelectedImage( value.Get< std::string >() );
1430         break;
1431       }
1432
1433       case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1434       {
1435         GetImplementation( button ).SetDisabledImage( value.Get< std::string >() );
1436         break;
1437       }
1438
1439       case Toolkit::Button::Property::UNSELECTED_COLOR:
1440       {
1441         GetImplementation( button ).SetUnselectedColor( value.Get< Vector4 >() );
1442         break;
1443       }
1444
1445       case Toolkit::Button::Property::SELECTED_COLOR:
1446       {
1447         GetImplementation( button ).SetSelectedColor( value.Get< Vector4 >() );
1448         break;
1449       }
1450
1451       case Toolkit::Button::Property::LABEL_TEXT:
1452       {
1453         GetImplementation( button ).SetLabelText( value.Get< std::string >() );
1454         break;
1455       }
1456
1457       case Toolkit::Button::Property::LABEL:
1458       {
1459         // Get a Property::Map from the property if possible.
1460         Property::Map setPropertyMap;
1461         if( value.Get( setPropertyMap ) )
1462         {
1463           GetImplementation( button ).ModifyLabel( setPropertyMap );
1464         }
1465       }
1466       break;
1467     }
1468   }
1469 }
1470
1471 Property::Value Button::GetProperty( BaseObject* object, Property::Index propertyIndex )
1472 {
1473   Property::Value value;
1474
1475   Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1476
1477   if ( button )
1478   {
1479     switch ( propertyIndex )
1480     {
1481       case Toolkit::Button::Property::DISABLED:
1482       {
1483         value = GetImplementation( button ).mDisabled;
1484         break;
1485       }
1486
1487       case Toolkit::Button::Property::AUTO_REPEATING:
1488       {
1489         value = GetImplementation( button ).mAutoRepeating;
1490         break;
1491       }
1492
1493       case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1494       {
1495         value = GetImplementation( button ).mInitialAutoRepeatingDelay;
1496         break;
1497       }
1498
1499       case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1500       {
1501         value = GetImplementation( button ).mNextAutoRepeatingDelay;
1502         break;
1503       }
1504
1505       case Toolkit::Button::Property::TOGGLABLE:
1506       {
1507         value = GetImplementation( button ).mTogglableButton;
1508         break;
1509       }
1510
1511       case Toolkit::Button::Property::SELECTED:
1512       {
1513         value = GetImplementation( button ).mSelected;
1514         break;
1515       }
1516
1517       case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1518       {
1519         value = GetImplementation( button ).GetUnselectedImageFilename();
1520         break;
1521       }
1522
1523       case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1524       {
1525         value = GetImplementation( button ).GetSelectedImageFilename();
1526         break;
1527       }
1528
1529       case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1530       {
1531         value = GetImplementation( button ).GetDisabledImageFilename();
1532         break;
1533       }
1534
1535       case Toolkit::Button::Property::UNSELECTED_COLOR:
1536       {
1537         value = GetImplementation( button ).GetUnselectedColor();
1538         break;
1539       }
1540
1541       case Toolkit::Button::Property::SELECTED_COLOR:
1542       {
1543         value = GetImplementation( button ).GetSelectedColor();
1544         break;
1545       }
1546
1547       case Toolkit::Button::Property::LABEL_TEXT:
1548       {
1549         value = GetImplementation( button ).GetLabelText();
1550         break;
1551       }
1552
1553       case Toolkit::Button::Property::LABEL:
1554       {
1555         Property::Map emptyMap;
1556         value = emptyMap;
1557         break;
1558       }
1559     }
1560   }
1561
1562   return value;
1563 }
1564
1565 // Deprecated API
1566
1567 void Button::SetLabel( Actor label )
1568 {
1569   if( mLabel != label )
1570   {
1571     if( mLabel && mLabel.GetParent() )
1572     {
1573       mLabel.GetParent().Remove( mLabel );
1574     }
1575
1576     mLabel = label;
1577     mLabel.SetPosition( 0.0f, 0.0f );
1578
1579     // label should be the top of the button
1580     Self().Add( mLabel );
1581
1582     ResetImageLayers();
1583     OnLabelSet( true );
1584
1585     RelayoutRequest();
1586   }
1587 }
1588
1589 void Button::SetButtonImage( Actor image )
1590 {
1591   if( image )
1592   {
1593     StopTransitionAnimation();
1594
1595     SetupContent( mUnselectedContent, image );
1596
1597     OnUnselectedImageSet();
1598     RelayoutRequest();
1599   }
1600 }
1601
1602 void Button::SetSelectedImage( Actor image )
1603 {
1604   if( image )
1605   {
1606     StopTransitionAnimation();
1607
1608     SetupContent( mSelectedContent, image );
1609
1610     OnSelectedImageSet();
1611     RelayoutRequest();
1612   }
1613 }
1614
1615 void Button::SetBackgroundImage( Actor image )
1616 {
1617   if( image )
1618   {
1619     StopTransitionAnimation();
1620
1621     SetupContent( mBackgroundContent, image );
1622
1623     OnBackgroundImageSet();
1624     RelayoutRequest();
1625   }
1626 }
1627
1628 void Button::SetSelectedBackgroundImage( Actor image )
1629 {
1630   if( image )
1631   {
1632     StopTransitionAnimation();
1633
1634     SetupContent( mSelectedBackgroundContent, image );
1635
1636     OnSelectedBackgroundImageSet();
1637     RelayoutRequest();
1638   }
1639 }
1640
1641 void Button::SetDisabledImage( Actor image )
1642 {
1643   if( image )
1644   {
1645     StopTransitionAnimation();
1646
1647     SetupContent( mDisabledContent, image );
1648
1649     OnDisabledImageSet();
1650     RelayoutRequest();
1651   }
1652 }
1653
1654 void Button::SetDisabledSelectedImage( Actor image )
1655 {
1656   if( image )
1657   {
1658     StopTransitionAnimation();
1659
1660     SetupContent( mDisabledSelectedContent, image );
1661
1662     OnDisabledSelectedImageSet();
1663     RelayoutRequest();
1664   }
1665 }
1666
1667 void Button::SetDisabledBackgroundImage( Actor image )
1668 {
1669   if( image )
1670   {
1671     StopTransitionAnimation();
1672
1673     SetupContent( mDisabledBackgroundContent, image );
1674
1675     OnDisabledBackgroundImageSet();
1676     RelayoutRequest();
1677   }
1678 }
1679
1680 Actor Button::GetButtonImage() const
1681 {
1682   return mUnselectedContent;
1683 }
1684
1685 Actor Button::GetSelectedImage() const
1686 {
1687   return mSelectedContent;
1688 }
1689
1690
1691 } // namespace Internal
1692
1693 } // namespace Toolkit
1694
1695 } // namespace Dali