Type registry helper: Toolkit change to correct Programming Guide for Custom Controls
[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-event.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_TOUCH_EVENTS | 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 bool Button::OnTouchEvent(const TouchEvent& event)
946 {
947   // Only events are processed when the button is not disabled and the touch event has only
948   // one touch point.
949   if( ( !mDisabled ) && ( 1 == event.GetPointCount() ) )
950   {
951     switch( event.GetPoint(0).state )
952     {
953       case TouchPoint::Down:
954       {
955         OnButtonDown(); // Notification for derived classes.
956
957         // Sets the button state to ButtonDown.
958         mState = ButtonDown;
959         break;
960       }
961       case TouchPoint::Up:
962       {
963         OnButtonUp(); // Notification for derived classes.
964
965         // Sets the button state to ButtonUp.
966         mState = ButtonUp;
967         break;
968       }
969       case TouchPoint::Interrupted:
970       {
971         OnTouchPointInterrupted(); // Notification for derived classes.
972
973         // Sets the button state to the default (ButtonUp).
974         mState = ButtonUp;
975         break;
976       }
977       case TouchPoint::Leave:
978       {
979         OnTouchPointLeave(); // Notification for derived classes.
980
981         // Sets the button state to the default (ButtonUp).
982         mState = ButtonUp;
983         break;
984       }
985       case TouchPoint::Motion:
986       case TouchPoint::Stationary: // FALLTHROUGH
987       {
988         // Nothing to do
989         break;
990       }
991       default:
992       {
993         DALI_ASSERT_ALWAYS( !"Point status unhandled." );
994         break;
995       }
996     }
997   }
998   else if( 1 < event.GetPointCount() )
999   {
1000     OnTouchPointLeave(); // Notification for derived classes.
1001
1002     // Sets the button state to the default (ButtonUp).
1003     mState = ButtonUp;
1004   }
1005
1006   return false;
1007 }
1008
1009 void Button::OnInitialize()
1010 {
1011   Actor self = Self();
1012
1013   mTapDetector = TapGestureDetector::New();
1014   mTapDetector.Attach( self );
1015   mTapDetector.DetectedSignal().Connect(this, &Button::OnTap);
1016
1017   self.SetKeyboardFocusable( true );
1018 }
1019
1020 bool Button::OnAccessibilityActivated()
1021 {
1022   return OnKeyboardEnter();
1023 }
1024
1025 bool Button::OnKeyboardEnter()
1026 {
1027   // When the enter key is pressed, or button is activated, the click action is performed.
1028   Property::Map attributes;
1029   bool ret = DoClickAction( attributes );
1030
1031   return ret;
1032 }
1033
1034 void Button::OnStageDisconnection()
1035 {
1036   if( ButtonDown == mState )
1037   {
1038     if( !mTogglableButton )
1039     {
1040       Released();
1041
1042       if( mAutoRepeating )
1043       {
1044         mAutoRepeatingTimer.Reset();
1045       }
1046     }
1047   }
1048
1049   mState = ButtonUp;
1050
1051   Control::OnStageDisconnection();
1052 }
1053
1054 void Button::OnTap(Actor actor, const TapGesture& tap)
1055 {
1056   // Do nothing.
1057 }
1058
1059 void Button::SetUpTimer( float delay )
1060 {
1061   mAutoRepeatingTimer = Dali::Timer::New( static_cast<unsigned int>( 1000.f * delay ) );
1062   mAutoRepeatingTimer.TickSignal().Connect( this, &Button::AutoRepeatingSlot );
1063   mAutoRepeatingTimer.Start();
1064 }
1065
1066 bool Button::AutoRepeatingSlot()
1067 {
1068   bool consumed = false;
1069   if( !mDisabled )
1070   {
1071     // Restart the autorepeat timer.
1072     SetUpTimer( mNextAutoRepeatingDelay );
1073
1074     Pressed();
1075
1076     Toolkit::Button handle( GetOwner() );
1077
1078     //Emit signal.
1079     consumed = mReleasedSignal.Emit( handle );
1080     consumed |= mClickedSignal.Emit( handle );
1081     consumed |= mPressedSignal.Emit( handle );
1082  }
1083
1084   return consumed;
1085 }
1086
1087 void Button::Pressed()
1088 {
1089   if( mPaintState == UnselectedState )
1090   {
1091     StopTransitionAnimation();
1092
1093     // Notifies the derived class the button has been pressed.
1094     OnPressed();
1095
1096     //Layer Order
1097     //(4) mSelectedContent (Inserted)
1098     //(3) mUnselectedContent
1099     //(2) mSelectedBackgroundContent (Inserted)
1100     //(1) mBackgroundContent
1101
1102     AddButtonImage( mBackgroundContent );
1103     TransitionButtonImage( mSelectedBackgroundContent );
1104     AddButtonImage( mUnselectedContent );
1105     TransitionButtonImage( mSelectedContent );
1106
1107     AddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1108     TransitionButtonImage( mDecoration[ SELECTED_DECORATION ] );
1109     ReAddLabel();
1110
1111     TransitionOut( mDecoration[ UNSELECTED_DECORATION ] );
1112     TransitionOut( mUnselectedContent );
1113     TransitionOut( mDisabledContent );
1114     TransitionOut( mDisabledSelectedContent );
1115     TransitionOut( mDisabledBackgroundContent );
1116
1117     mPaintState = SelectedState;
1118
1119     StartTransitionAnimation();
1120   }
1121 }
1122
1123 void Button::Released()
1124 {
1125   if( mPaintState == SelectedState )
1126   {
1127     StopTransitionAnimation();
1128
1129     // Notifies the derived class the button has been released.
1130     OnReleased();
1131
1132     //Layer Order
1133     //(3) mUnselectedContent (Inserted)
1134     //(2) mSelectedContent
1135     //(1) mBackgroundContent
1136
1137     AddButtonImage( mBackgroundContent );
1138     AddButtonImage( mSelectedContent );
1139     TransitionButtonImage( mUnselectedContent );
1140
1141     AddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1142     TransitionButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1143     ReAddLabel();
1144
1145     TransitionOut( mDecoration[ SELECTED_DECORATION ] );
1146     TransitionOut( mSelectedContent );
1147     TransitionOut( mSelectedBackgroundContent );
1148     TransitionOut( mDisabledContent );
1149     TransitionOut( mDisabledSelectedContent );
1150     TransitionOut( mDisabledBackgroundContent );
1151
1152     mPaintState = UnselectedState;
1153
1154     StartTransitionAnimation();
1155   }
1156 }
1157
1158 Button::ButtonState Button::GetState()
1159 {
1160   return mState;
1161 }
1162
1163 Button::PaintState Button::GetPaintState()
1164 {
1165   return mPaintState;
1166 }
1167
1168 void Button::PrepareAddButtonImage( Actor& actor )
1169 {
1170   if( actor )
1171   {
1172     Self().Add( actor );
1173     PrepareForTranstionOut( actor );
1174   }
1175 }
1176
1177 void Button::TransitionButtonImage( Actor& actor )
1178 {
1179   if( actor )
1180   {
1181     if( !actor.GetParent() )
1182     {
1183       Self().Add( actor );
1184     }
1185
1186     OnTransitionIn( actor );
1187   }
1188 }
1189
1190 void Button::AddButtonImage( Actor& actor )
1191 {
1192   if( actor )
1193   {
1194     Self().Add( actor );
1195   }
1196 }
1197
1198 void Button::ReAddLabel()
1199 {
1200   if( mLabel )
1201   {
1202     mLabel.Unparent();
1203     Self().Add( mLabel );
1204   }
1205 }
1206
1207 void Button::RemoveButtonImage( Actor& actor )
1208 {
1209   if( actor )
1210   {
1211     if( actor.GetParent() )
1212     {
1213       Self().Remove( actor );
1214     }
1215     PrepareForTranstionIn( actor );
1216   }
1217 }
1218
1219 unsigned int Button::FindChildIndex( Actor& actor )
1220 {
1221   Actor self = Self();
1222   unsigned int childrenNum = self.GetChildCount();
1223
1224   for( unsigned int i = 0; i < childrenNum; i++ )
1225   {
1226     Actor child = self.GetChildAt( i );
1227     if( child == actor )
1228     {
1229       return i;
1230     }
1231   }
1232
1233   return childrenNum;
1234 }
1235
1236 void Button::TransitionOut( Actor actor )
1237 {
1238   OnTransitionOut( actor );
1239 }
1240
1241 void Button::ResetImageLayers()
1242 {
1243   // Ensure that all layers are in the correct order and state according to the paint state
1244
1245   switch( mPaintState )
1246   {
1247     case UnselectedState:
1248     {
1249       //Layer Order
1250       //(2) mUnselectedContent
1251       //(1) mBackgroundContent
1252
1253       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1254       RemoveButtonImage( mSelectedContent );
1255       RemoveButtonImage( mSelectedBackgroundContent );
1256       RemoveButtonImage( mDisabledContent );
1257       RemoveButtonImage( mDisabledSelectedContent );
1258       RemoveButtonImage( mDisabledBackgroundContent );
1259
1260       PrepareAddButtonImage( mBackgroundContent );
1261       PrepareAddButtonImage( mUnselectedContent );
1262
1263       PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1264       ReAddLabel();
1265       break;
1266     }
1267     case SelectedState:
1268     {
1269       //Layer Order
1270       //(3) mSelectedContent
1271       //(2) mSelectedBackgroundContent
1272       //(1) mBackgroundContent
1273
1274       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1275       RemoveButtonImage( mUnselectedContent );
1276       RemoveButtonImage( mDisabledContent );
1277       RemoveButtonImage( mDisabledSelectedContent );
1278       RemoveButtonImage( mDisabledBackgroundContent );
1279
1280       PrepareAddButtonImage( mBackgroundContent );
1281       PrepareAddButtonImage( mSelectedBackgroundContent );
1282       PrepareAddButtonImage( mSelectedContent );
1283
1284       PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1285       ReAddLabel();
1286       break;
1287     }
1288     case DisabledUnselectedState:
1289     {
1290       //Layer Order
1291       //(2) mDisabledContent
1292       //(1) mDisabledBackgroundContent
1293
1294       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1295       RemoveButtonImage( mUnselectedContent );
1296       RemoveButtonImage( mBackgroundContent );
1297       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1298       RemoveButtonImage( mSelectedContent );
1299       RemoveButtonImage( mDisabledSelectedContent );
1300       RemoveButtonImage( mSelectedBackgroundContent );
1301
1302       PrepareAddButtonImage( mDisabledBackgroundContent ? mDisabledBackgroundContent : mBackgroundContent );
1303       PrepareAddButtonImage( mDisabledContent ? mDisabledContent : mUnselectedContent );
1304
1305       PrepareAddButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1306       ReAddLabel();
1307       break;
1308     }
1309     case DisabledSelectedState:
1310     {
1311       //Layer Order
1312       // (2) mDisabledSelectedContent
1313       // (1) mDisabledBackgroundContent
1314
1315       RemoveButtonImage( mDecoration[ UNSELECTED_DECORATION ] );
1316       RemoveButtonImage( mUnselectedContent );
1317       RemoveButtonImage( mDecoration[ SELECTED_DECORATION ] );
1318       RemoveButtonImage( mSelectedContent );
1319       RemoveButtonImage( mBackgroundContent );
1320       RemoveButtonImage( mSelectedBackgroundContent );
1321       RemoveButtonImage( mDisabledContent );
1322
1323       if( mDisabledBackgroundContent )
1324       {
1325         PrepareAddButtonImage( mDisabledBackgroundContent );
1326       }
1327       else
1328       {
1329         PrepareAddButtonImage( mBackgroundContent );
1330         PrepareAddButtonImage( mSelectedBackgroundContent );
1331       }
1332
1333       PrepareAddButtonImage( mDisabledSelectedContent ? mDisabledSelectedContent : mSelectedContent );
1334
1335       PrepareAddButtonImage( mDecoration[ SELECTED_DECORATION ] );
1336       ReAddLabel();
1337       break;
1338     }
1339   }
1340 }
1341
1342 void Button::StartTransitionAnimation()
1343 {
1344   if( mTransitionAnimation )
1345   {
1346     mTransitionAnimation.Play();
1347   }
1348   else
1349   {
1350     ResetImageLayers();
1351   }
1352 }
1353
1354 void Button::StopTransitionAnimation()
1355 {
1356   if( mTransitionAnimation )
1357   {
1358     mTransitionAnimation.Clear();
1359     mTransitionAnimation.Reset();
1360   }
1361 }
1362
1363 Dali::Animation Button::GetTransitionAnimation()
1364 {
1365   if( !mTransitionAnimation )
1366   {
1367     mTransitionAnimation = Dali::Animation::New( GetAnimationTime() );
1368     mTransitionAnimation.FinishedSignal().Connect( this, &Button::TransitionAnimationFinished );
1369   }
1370
1371   return mTransitionAnimation;
1372 }
1373
1374 void Button::TransitionAnimationFinished( Dali::Animation& source )
1375 {
1376   StopTransitionAnimation();
1377   ResetImageLayers();
1378 }
1379
1380 void Button::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
1381 {
1382   Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1383
1384   if ( button )
1385   {
1386     switch ( index )
1387     {
1388       case Toolkit::Button::Property::DISABLED:
1389       {
1390         GetImplementation( button ).SetDisabled( value.Get< bool >() );
1391         break;
1392       }
1393
1394       case Toolkit::Button::Property::AUTO_REPEATING:
1395       {
1396         GetImplementation( button ).SetAutoRepeating( value.Get< bool >() );
1397         break;
1398       }
1399
1400       case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1401       {
1402         GetImplementation( button ).SetInitialAutoRepeatingDelay( value.Get< float >() );
1403         break;
1404       }
1405
1406       case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1407       {
1408         GetImplementation( button ).SetNextAutoRepeatingDelay( value.Get< float >() );
1409         break;
1410       }
1411
1412       case Toolkit::Button::Property::TOGGLABLE:
1413       {
1414         GetImplementation( button ).SetTogglableButton( value.Get< bool >() );
1415         break;
1416       }
1417
1418       case Toolkit::Button::Property::SELECTED:
1419       {
1420         GetImplementation( button ).SetSelected( value.Get< bool >() );
1421         break;
1422       }
1423
1424       case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1425       {
1426         GetImplementation( button ).SetUnselectedImage( value.Get< std::string >() );
1427         break;
1428       }
1429
1430       case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1431       {
1432         GetImplementation( button ).SetSelectedImage( value.Get< std::string >() );
1433         break;
1434       }
1435
1436       case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1437       {
1438         GetImplementation( button ).SetDisabledImage( value.Get< std::string >() );
1439         break;
1440       }
1441
1442       case Toolkit::Button::Property::UNSELECTED_COLOR:
1443       {
1444         GetImplementation( button ).SetUnselectedColor( value.Get< Vector4 >() );
1445         break;
1446       }
1447
1448       case Toolkit::Button::Property::SELECTED_COLOR:
1449       {
1450         GetImplementation( button ).SetSelectedColor( value.Get< Vector4 >() );
1451         break;
1452       }
1453
1454       case Toolkit::Button::Property::LABEL_TEXT:
1455       {
1456         GetImplementation( button ).SetLabelText( value.Get< std::string >() );
1457         break;
1458       }
1459
1460       case Toolkit::Button::Property::LABEL:
1461       {
1462         // Get a Property::Map from the property if possible.
1463         Property::Map setPropertyMap;
1464         if( value.Get( setPropertyMap ) )
1465         {
1466           GetImplementation( button ).ModifyLabel( setPropertyMap );
1467         }
1468       }
1469       break;
1470     }
1471   }
1472 }
1473
1474 Property::Value Button::GetProperty( BaseObject* object, Property::Index propertyIndex )
1475 {
1476   Property::Value value;
1477
1478   Toolkit::Button button = Toolkit::Button::DownCast( Dali::BaseHandle( object ) );
1479
1480   if ( button )
1481   {
1482     switch ( propertyIndex )
1483     {
1484       case Toolkit::Button::Property::DISABLED:
1485       {
1486         value = GetImplementation( button ).mDisabled;
1487         break;
1488       }
1489
1490       case Toolkit::Button::Property::AUTO_REPEATING:
1491       {
1492         value = GetImplementation( button ).mAutoRepeating;
1493         break;
1494       }
1495
1496       case Toolkit::Button::Property::INITIAL_AUTO_REPEATING_DELAY:
1497       {
1498         value = GetImplementation( button ).mInitialAutoRepeatingDelay;
1499         break;
1500       }
1501
1502       case Toolkit::Button::Property::NEXT_AUTO_REPEATING_DELAY:
1503       {
1504         value = GetImplementation( button ).mNextAutoRepeatingDelay;
1505         break;
1506       }
1507
1508       case Toolkit::Button::Property::TOGGLABLE:
1509       {
1510         value = GetImplementation( button ).mTogglableButton;
1511         break;
1512       }
1513
1514       case Toolkit::Button::Property::SELECTED:
1515       {
1516         value = GetImplementation( button ).mSelected;
1517         break;
1518       }
1519
1520       case Toolkit::Button::Property::UNSELECTED_STATE_IMAGE:
1521       {
1522         value = GetImplementation( button ).GetUnselectedImageFilename();
1523         break;
1524       }
1525
1526       case Toolkit::Button::Property::SELECTED_STATE_IMAGE:
1527       {
1528         value = GetImplementation( button ).GetSelectedImageFilename();
1529         break;
1530       }
1531
1532       case Toolkit::Button::Property::DISABLED_STATE_IMAGE:
1533       {
1534         value = GetImplementation( button ).GetDisabledImageFilename();
1535         break;
1536       }
1537
1538       case Toolkit::Button::Property::UNSELECTED_COLOR:
1539       {
1540         value = GetImplementation( button ).GetUnselectedColor();
1541         break;
1542       }
1543
1544       case Toolkit::Button::Property::SELECTED_COLOR:
1545       {
1546         value = GetImplementation( button ).GetSelectedColor();
1547         break;
1548       }
1549
1550       case Toolkit::Button::Property::LABEL_TEXT:
1551       {
1552         value = GetImplementation( button ).GetLabelText();
1553         break;
1554       }
1555
1556       case Toolkit::Button::Property::LABEL:
1557       {
1558         Property::Map emptyMap;
1559         value = emptyMap;
1560         break;
1561       }
1562     }
1563   }
1564
1565   return value;
1566 }
1567
1568 // Deprecated API
1569
1570 void Button::SetLabel( Actor label )
1571 {
1572   if( mLabel != label )
1573   {
1574     if( mLabel && mLabel.GetParent() )
1575     {
1576       mLabel.GetParent().Remove( mLabel );
1577     }
1578
1579     mLabel = label;
1580     mLabel.SetPosition( 0.0f, 0.0f );
1581
1582     // label should be the top of the button
1583     Self().Add( mLabel );
1584
1585     ResetImageLayers();
1586     OnLabelSet( true );
1587
1588     RelayoutRequest();
1589   }
1590 }
1591
1592 void Button::SetButtonImage( Actor image )
1593 {
1594   if( image )
1595   {
1596     StopTransitionAnimation();
1597
1598     SetupContent( mUnselectedContent, image );
1599
1600     OnUnselectedImageSet();
1601     RelayoutRequest();
1602   }
1603 }
1604
1605 void Button::SetSelectedImage( Actor image )
1606 {
1607   if( image )
1608   {
1609     StopTransitionAnimation();
1610
1611     SetupContent( mSelectedContent, image );
1612
1613     OnSelectedImageSet();
1614     RelayoutRequest();
1615   }
1616 }
1617
1618 void Button::SetBackgroundImage( Actor image )
1619 {
1620   if( image )
1621   {
1622     StopTransitionAnimation();
1623
1624     SetupContent( mBackgroundContent, image );
1625
1626     OnBackgroundImageSet();
1627     RelayoutRequest();
1628   }
1629 }
1630
1631 void Button::SetSelectedBackgroundImage( Actor image )
1632 {
1633   if( image )
1634   {
1635     StopTransitionAnimation();
1636
1637     SetupContent( mSelectedBackgroundContent, image );
1638
1639     OnSelectedBackgroundImageSet();
1640     RelayoutRequest();
1641   }
1642 }
1643
1644 void Button::SetDisabledImage( Actor image )
1645 {
1646   if( image )
1647   {
1648     StopTransitionAnimation();
1649
1650     SetupContent( mDisabledContent, image );
1651
1652     OnDisabledImageSet();
1653     RelayoutRequest();
1654   }
1655 }
1656
1657 void Button::SetDisabledSelectedImage( Actor image )
1658 {
1659   if( image )
1660   {
1661     StopTransitionAnimation();
1662
1663     SetupContent( mDisabledSelectedContent, image );
1664
1665     OnDisabledSelectedImageSet();
1666     RelayoutRequest();
1667   }
1668 }
1669
1670 void Button::SetDisabledBackgroundImage( Actor image )
1671 {
1672   if( image )
1673   {
1674     StopTransitionAnimation();
1675
1676     SetupContent( mDisabledBackgroundContent, image );
1677
1678     OnDisabledBackgroundImageSet();
1679     RelayoutRequest();
1680   }
1681 }
1682
1683 Actor Button::GetButtonImage() const
1684 {
1685   return mUnselectedContent;
1686 }
1687
1688 Actor Button::GetSelectedImage() const
1689 {
1690   return mSelectedContent;
1691 }
1692
1693
1694 } // namespace Internal
1695
1696 } // namespace Toolkit
1697
1698 } // namespace Dali