dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp

   1 /*
   2  * Copyright (c) 2020 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 <dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstring> // for strcmp
  23 #include <dali/public-api/animation/constraint.h>
  24 #include <dali/public-api/animation/constraints.h>
  25 #include <dali/public-api/object/type-registry.h>
  26 #include <dali/public-api/object/property-array.h>
  27 #include <dali/public-api/object/type-registry-helper.h>
  28 #include <dali/integration-api/debug.h>
  29 #include <dali/devel-api/object/property-helper-devel.h>
  30 #include <dali/devel-api/actors/actor-devel.h>
  31
  32 // INTERNAL INCLUDES
  33 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  34 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
  35 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  36
  37 using namespace Dali;
  38
  39 namespace
  40 {
  41
  42 const char* DEFAULT_INDICATOR_IMAGE_FILE_NAME = "popup_scroll.9.png";
  43 const float DEFAULT_SLIDER_DEPTH(1.0f);
  44 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
  45 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
  46 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
  47 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
  48 const float DEFAULT_INDICATOR_MINIMUM_HEIGHT(0.0f);
  49 const float DEFAULT_INDICATOR_START_PADDING(0.0f);
  50 const float DEFAULT_INDICATOR_END_PADDING(0.0f);
  51 const float DEFAULT_INDICATOR_TRANSIENT_DURATION(1.0f);
  52
  53 /**
  54  * Indicator size constraint
  55  * Indicator size depends on both indicator's parent size and the scroll content size
  56  */
  57 struct IndicatorSizeConstraint
  58 {
  59   /**
  60    * @param[in] minimumHeight The minimum height for the indicator
  61    * @param[in] padding The sum of the padding at the start & end of the indicator
  62    */
  63   IndicatorSizeConstraint( float minimumHeight, float padding )
  64   : mMinimumHeight( minimumHeight ),
  65     mPadding( padding )
  66   {
  67   }
  68
  69   /**
  70    * Constraint operator
  71    * @param[in] current The current indicator size
  72    * @param[in] parentSizeProperty The parent size of scroll indicator.
  73    * @return The new scroll indicator size.
  74    */
  75   void operator()( Vector3& current, const PropertyInputContainer& inputs )
  76   {
  77     const Vector3& parentSize = inputs[0]->GetVector3();
  78     const float contentSize = inputs[1]->GetFloat();
  79
  80     // Take into account padding that may exist at the beginning and end of the indicator.
  81     const float parentHeightMinusPadding = parentSize.height - mPadding;
  82
  83     float height = contentSize > parentHeightMinusPadding ?
  84                    parentHeightMinusPadding * ( parentHeightMinusPadding / contentSize ) :
  85                    parentHeightMinusPadding * ( ( parentHeightMinusPadding - contentSize * 0.5f ) / parentHeightMinusPadding );
  86
  87     current.y = std::max( mMinimumHeight, height );
  88   }
  89
  90   float mMinimumHeight;
  91   float mPadding;
  92 };
  93
  94 /**
  95  * Indicator position constraint
  96  * Positions the indicator to reflect the current scroll position within the scroll domain.
  97  */
  98 struct IndicatorPositionConstraint
  99 {
 100   /**
 101    * @param[in] startPadding The padding at the start of the indicator
 102    * @param[in] endPadding The padding at the end of the indicator
 103    */
 104   IndicatorPositionConstraint( float startPadding, float endPadding )
 105   : mStartPadding( startPadding ),
 106     mEndPadding( endPadding )
 107   {
 108   }
 109
 110   /**
 111    * Constraint operator
 112    * @param[in,out] current The current indicator position
 113    * @param[in] inputs Contains the size of indicator, the size of indicator's parent, and the scroll position of the scrollable container (from 0.0 -> 1.0 in each axis)
 114    * @return The new indicator position is returned.
 115    */
 116   void operator()( Vector3& current, const PropertyInputContainer& inputs )
 117   {
 118     const Vector3& indicatorSize = inputs[0]->GetVector3();
 119     const Vector3& parentSize = inputs[1]->GetVector3();
 120     const float scrollPosition = -inputs[2]->GetFloat();
 121     const float minimumScrollPosition = inputs[3]->GetFloat();
 122     const float maximumScrollPosition = inputs[4]->GetFloat();
 123
 124     // Take into account padding that may exist at the beginning and end of the indicator.
 125     const float parentHeightMinusPadding = parentSize.height - ( mStartPadding + mEndPadding );
 126
 127     float relativePosition = std::max( 0.0f, std::min( 1.0f, ( scrollPosition - minimumScrollPosition ) / ( maximumScrollPosition - minimumScrollPosition ) ) );
 128     current.y = mStartPadding + ( parentHeightMinusPadding - indicatorSize.height ) * relativePosition;
 129     current.z = DEFAULT_SLIDER_DEPTH;
 130   }
 131
 132   float mStartPadding;
 133   float mEndPadding;
 134 };
 135
 136 } // unnamed namespace
 137
 138 namespace Dali
 139 {
 140
 141 namespace Toolkit
 142 {
 143
 144 namespace Internal
 145 {
 146
 147 namespace
 148 {
 149
 150 using namespace Dali;
 151
 152 BaseHandle Create()
 153 {
 154   return Toolkit::ScrollBar::New();
 155 }
 156
 157 // Setup properties, signals and actions using the type-registry.
 158 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ScrollBar, Toolkit::Control, Create );
 159
 160 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "scrollDirection",                   STRING, SCROLL_DIRECTION             )
 161 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorHeightPolicy",             STRING, INDICATOR_HEIGHT_POLICY      )
 162 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorFixedHeight",              FLOAT,  INDICATOR_FIXED_HEIGHT       )
 163 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorShowDuration",             FLOAT,  INDICATOR_SHOW_DURATION      )
 164 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorHideDuration",             FLOAT,  INDICATOR_HIDE_DURATION      )
 165 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "scrollPositionIntervals",           ARRAY,  SCROLL_POSITION_INTERVALS    )
 166 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorMinimumHeight",            FLOAT,  INDICATOR_MINIMUM_HEIGHT     )
 167 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorStartPadding",             FLOAT,  INDICATOR_START_PADDING      )
 168 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorEndPadding",               FLOAT,  INDICATOR_END_PADDING        )
 169 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorTransientDuration",        FLOAT,  INDICATOR_TRANSIENT_DURATION )
 170
 171 DALI_SIGNAL_REGISTRATION(   Toolkit, ScrollBar, "panFinished",                       PAN_FINISHED_SIGNAL                     )
 172 DALI_SIGNAL_REGISTRATION(   Toolkit, ScrollBar, "scrollPositionIntervalReached",     SCROLL_POSITION_INTERVAL_REACHED_SIGNAL )
 173
 174 DALI_ACTION_REGISTRATION(   Toolkit, ScrollBar, "ShowIndicator",                     ACTION_SHOW_INDICATOR                   )
 175 DALI_ACTION_REGISTRATION(   Toolkit, ScrollBar, "HideIndicator",                     ACTION_HIDE_INDICATOR                   )
 176 DALI_ACTION_REGISTRATION(   Toolkit, ScrollBar, "ShowTransientIndicator",            ACTION_SHOW_TRANSIENT_INDICATOR         )
 177
 178 DALI_TYPE_REGISTRATION_END()
 179
 180 const char* SCROLL_DIRECTION_NAME[] = {"VERTICAL", "HORIZONTAL"};
 181 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"VARIABLE", "FIXED"};
 182
 183 }
 184
 185 ScrollBar::ScrollBar(Toolkit::ScrollBar::Direction direction)
 186 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
 187   mIndicatorShowAlpha(1.0f),
 188   mDirection(direction),
 189   mScrollableObject(WeakHandle<Handle>()),
 190   mPropertyScrollPosition(Property::INVALID_INDEX),
 191   mPropertyMinScrollPosition(Property::INVALID_INDEX),
 192   mPropertyMaxScrollPosition(Property::INVALID_INDEX),
 193   mPropertyScrollContentSize(Property::INVALID_INDEX),
 194   mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
 195   mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
 196   mTransientIndicatorDuration(DEFAULT_INDICATOR_TRANSIENT_DURATION),
 197   mScrollStart(0.0f),
 198   mGestureDisplacement( Vector2::ZERO ),
 199   mCurrentScrollPosition(0.0f),
 200   mIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE),
 201   mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
 202   mIndicatorMinimumHeight(DEFAULT_INDICATOR_MINIMUM_HEIGHT),
 203   mIndicatorStartPadding(DEFAULT_INDICATOR_START_PADDING),
 204   mIndicatorEndPadding(DEFAULT_INDICATOR_END_PADDING),
 205   mIsPanning(false),
 206   mIndicatorFirstShow(true)
 207 {
 208 }
 209
 210 ScrollBar::~ScrollBar()
 211 {
 212 }
 213
 214 void ScrollBar::OnInitialize()
 215 {
 216   CreateDefaultIndicatorActor();
 217   Self().SetProperty( Actor::Property::DRAW_MODE,DrawMode::OVERLAY_2D);
 218
 219   DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
 220     return std::unique_ptr< Dali::Accessibility::Accessible >(
 221       new AccessibleImpl( actor, Dali::Accessibility::Role::SCROLL_BAR ) );
 222   } );
 223 }
 224
 225 void ScrollBar::SetScrollPropertySource( Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize )
 226 {
 227   if( handle
 228       && propertyScrollPosition != Property::INVALID_INDEX
 229       && propertyMinScrollPosition != Property::INVALID_INDEX
 230       && propertyMaxScrollPosition != Property::INVALID_INDEX
 231       && propertyScrollContentSize != Property::INVALID_INDEX )
 232   {
 233     mScrollableObject = WeakHandle<Handle>(handle);
 234     mPropertyScrollPosition = propertyScrollPosition;
 235     mPropertyMinScrollPosition = propertyMinScrollPosition;
 236     mPropertyMaxScrollPosition = propertyMaxScrollPosition;
 237     mPropertyScrollContentSize = propertyScrollContentSize;
 238
 239     ApplyConstraints();
 240   }
 241   else
 242   {
 243     DALI_LOG_ERROR("Can not set empty handle of source object or invalid source property index\n");
 244   }
 245 }
 246
 247 void ScrollBar::CreateDefaultIndicatorActor()
 248 {
 249   const std::string imageDirPath = AssetManager::GetDaliImagePath();
 250   Toolkit::ImageView indicator = Toolkit::ImageView::New( imageDirPath + DEFAULT_INDICATOR_IMAGE_FILE_NAME );
 251   indicator.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT );
 252   indicator.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT );
 253   indicator.SetStyleName( "ScrollBarIndicator" );
 254   indicator.SetProperty( Actor::Property::COLOR_MODE, USE_OWN_MULTIPLY_PARENT_COLOR );
 255   SetScrollIndicator(indicator);
 256 }
 257
 258 void ScrollBar::SetScrollIndicator( Actor indicator )
 259 {
 260   // Don't allow empty handle
 261   if( indicator )
 262   {
 263     // Remove current Indicator
 264     if( mIndicator )
 265     {
 266       Self().Remove( mIndicator );
 267     }
 268     mIndicator = indicator;
 269
 270     mIndicatorFirstShow = true;
 271     Self().Add( mIndicator );
 272
 273     EnableGestureDetection( GestureType::Value( GestureType::PAN ) );
 274
 275     PanGestureDetector detector( GetPanGestureDetector() );
 276     detector.DetachAll();
 277     detector.Attach( mIndicator );
 278
 279     unsigned int childCount = mIndicator.GetChildCount();
 280     for ( unsigned int index = 0; index < childCount; index++ )
 281     {
 282       Actor child = mIndicator.GetChildAt( index );
 283       if ( child )
 284       {
 285         detector.Attach( child );
 286       }
 287     }
 288   }
 289   else
 290   {
 291     DALI_LOG_ERROR("Empty handle of scroll indicator\n");
 292   }
 293 }
 294
 295 Actor ScrollBar::GetScrollIndicator()
 296 {
 297   return mIndicator;
 298 }
 299
 300 void ScrollBar::ApplyConstraints()
 301 {
 302   Handle scrollableHandle = mScrollableObject.GetHandle();
 303
 304   if( scrollableHandle )
 305   {
 306     if(mIndicatorSizeConstraint)
 307     {
 308       mIndicatorSizeConstraint.Remove();
 309     }
 310
 311     // Set indicator height according to the indicator's height policy
 312     if(mIndicatorHeightPolicy == Toolkit::ScrollBar::FIXED)
 313     {
 314       mIndicator.SetProperty( Actor::Property::SIZE, Vector2( Self().GetCurrentProperty< Vector3 >( Actor::Property::SIZE ).width, mIndicatorFixedHeight) );
 315     }
 316     else
 317     {
 318       mIndicatorSizeConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::SIZE,
 319                                                            IndicatorSizeConstraint( mIndicatorMinimumHeight, mIndicatorStartPadding + mIndicatorEndPadding ) );
 320       mIndicatorSizeConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
 321       mIndicatorSizeConstraint.AddSource( Source( scrollableHandle, mPropertyScrollContentSize ) );
 322       mIndicatorSizeConstraint.Apply();
 323     }
 324
 325     if(mIndicatorPositionConstraint)
 326     {
 327       mIndicatorPositionConstraint.Remove();
 328     }
 329
 330     mIndicatorPositionConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::POSITION,
 331                                                              IndicatorPositionConstraint( mIndicatorStartPadding, mIndicatorEndPadding ) );
 332     mIndicatorPositionConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
 333     mIndicatorPositionConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
 334     mIndicatorPositionConstraint.AddSource( Source( scrollableHandle, mPropertyScrollPosition ) );
 335     mIndicatorPositionConstraint.AddSource( Source( scrollableHandle, mPropertyMinScrollPosition ) );
 336     mIndicatorPositionConstraint.AddSource( Source( scrollableHandle, mPropertyMaxScrollPosition ) );
 337     mIndicatorPositionConstraint.Apply();
 338   }
 339 }
 340
 341 void ScrollBar::SetScrollPositionIntervals( const Dali::Vector<float>& positions )
 342 {
 343   mScrollPositionIntervals = positions;
 344
 345   Handle scrollableHandle = mScrollableObject.GetHandle();
 346
 347   if( scrollableHandle )
 348   {
 349     if( mPositionNotification )
 350     {
 351       scrollableHandle.RemovePropertyNotification(mPositionNotification);
 352     }
 353
 354     mPositionNotification = scrollableHandle.AddPropertyNotification( mPropertyScrollPosition, VariableStepCondition(mScrollPositionIntervals) );
 355     mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionIntervalReached );
 356   }
 357 }
 358
 359 Dali::Vector<float> ScrollBar::GetScrollPositionIntervals() const
 360 {
 361   return mScrollPositionIntervals;
 362 }
 363
 364 void ScrollBar::OnScrollPositionIntervalReached(PropertyNotification& source)
 365 {
 366   // Emit the signal to notify the scroll position crossing
 367   Handle scrollableHandle = mScrollableObject.GetHandle();
 368   if(scrollableHandle)
 369   {
 370     mScrollPositionIntervalReachedSignal.Emit( scrollableHandle.GetCurrentProperty< float >( mPropertyScrollPosition ) );
 371     if (Self() == Dali::Accessibility::Accessible::GetCurrentlyHighlightedActor())
 372     {
 373       Control::Impl::GetAccessibilityObject(Self())->Emit(Dali::Accessibility::ObjectPropertyChangeEvent::VALUE);
 374     }
 375   }
 376 }
 377
 378 void ScrollBar::ShowIndicator()
 379 {
 380   // Cancel any animation
 381   if(mAnimation)
 382   {
 383     mAnimation.Clear();
 384     mAnimation.Reset();
 385   }
 386
 387   if( mIndicatorFirstShow )
 388   {
 389     // Preserve the alpha value from the stylesheet
 390     mIndicatorShowAlpha = Self().GetCurrentProperty< Vector4 >( Actor::Property::COLOR ).a;
 391     mIndicatorFirstShow = false;
 392   }
 393
 394   if(mIndicatorShowDuration > 0.0f)
 395   {
 396     mAnimation = Animation::New( mIndicatorShowDuration );
 397     mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), mIndicatorShowAlpha, AlphaFunction::EASE_IN );
 398     mAnimation.Play();
 399   }
 400   else
 401   {
 402     mIndicator.SetProperty( Actor::Property::OPACITY,mIndicatorShowAlpha);
 403   }
 404 }
 405
 406 void ScrollBar::HideIndicator()
 407 {
 408   // Cancel any animation
 409   if(mAnimation)
 410   {
 411     mAnimation.Clear();
 412     mAnimation.Reset();
 413   }
 414
 415   if(mIndicatorHideDuration > 0.0f)
 416   {
 417     mAnimation = Animation::New( mIndicatorHideDuration );
 418     mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN );
 419     mAnimation.Play();
 420   }
 421   else
 422   {
 423     mIndicator.SetProperty( Actor::Property::OPACITY,0.0f);
 424   }
 425 }
 426
 427 void ScrollBar::ShowTransientIndicator()
 428 {
 429   // Cancel any animation
 430   if(mAnimation)
 431   {
 432     mAnimation.Clear();
 433     mAnimation.Reset();
 434   }
 435
 436   mAnimation = Animation::New( mIndicatorShowDuration + mTransientIndicatorDuration + mIndicatorHideDuration );
 437   if(mIndicatorShowDuration > 0.0f)
 438   {
 439     mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ),
 440                           mIndicatorShowAlpha, AlphaFunction::EASE_IN, TimePeriod(0, mIndicatorShowDuration) );
 441   }
 442   else
 443   {
 444     mIndicator.SetProperty( Actor::Property::OPACITY,mIndicatorShowAlpha);
 445   }
 446   mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ),
 447                         0.0f, AlphaFunction::EASE_IN, TimePeriod((mIndicatorShowDuration + mTransientIndicatorDuration), mIndicatorHideDuration) );
 448   mAnimation.Play();
 449 }
 450
 451 bool ScrollBar::OnPanGestureProcessTick()
 452 {
 453   // Update the scroll position property.
 454   Handle scrollableHandle = mScrollableObject.GetHandle();
 455   if( scrollableHandle )
 456   {
 457     scrollableHandle.SetProperty(mPropertyScrollPosition, mCurrentScrollPosition);
 458   }
 459
 460   return true;
 461 }
 462
 463 void ScrollBar::OnPan( const PanGesture& gesture )
 464 {
 465   Handle scrollableHandle = mScrollableObject.GetHandle();
 466
 467   if(scrollableHandle)
 468   {
 469     Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(scrollableHandle);
 470
 471     switch(gesture.GetState())
 472     {
 473       case Dali::GestureState::STARTED:
 474       {
 475         if( !mPanProcessTimer )
 476         {
 477           // Make sure the pan gesture is only being processed once per frame.
 478           mPanProcessTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
 479           mPanProcessTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
 480           mPanProcessTimer.Start();
 481         }
 482
 483         ShowIndicator();
 484         mScrollStart = scrollableHandle.GetCurrentProperty< float >( mPropertyScrollPosition );
 485         mGestureDisplacement = Vector2::ZERO;
 486         mIsPanning = true;
 487
 488         break;
 489       }
 490       case Dali::GestureState::CONTINUING:
 491       {
 492         mGestureDisplacement += gesture.GetDisplacement();
 493
 494         float minScrollPosition = scrollableHandle.GetCurrentProperty<float>( mPropertyMinScrollPosition );
 495         float maxScrollPosition = scrollableHandle.GetCurrentProperty<float>( mPropertyMaxScrollPosition );
 496
 497         // The domain size is the internal range
 498         float domainSize = maxScrollPosition - minScrollPosition;
 499         float logicalSize = Self().GetCurrentProperty< Vector3 >( Actor::Property::SIZE ).y - ( mIndicator.GetCurrentProperty< Vector3 >( Actor::Property::SIZE ).y + mIndicatorStartPadding + mIndicatorEndPadding );
 500
 501         mCurrentScrollPosition = mScrollStart - ( ( mGestureDisplacement.y * domainSize ) / logicalSize );
 502         mCurrentScrollPosition = -std::min( maxScrollPosition, std::max( -mCurrentScrollPosition, minScrollPosition ) );
 503
 504         break;
 505       }
 506       default:
 507       {
 508         mIsPanning = false;
 509
 510         if( mPanProcessTimer )
 511         {
 512           // Destroy the timer when pan gesture is finished.
 513           mPanProcessTimer.Stop();
 514           mPanProcessTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
 515           mPanProcessTimer.Reset();
 516         }
 517
 518         if(itemView)
 519         {
 520           // Refresh the ItemView cache with extra items
 521           GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
 522         }
 523
 524         mPanFinishedSignal.Emit();
 525
 526         break;
 527       }
 528     }
 529
 530     if(itemView)
 531     {
 532       // Disable automatic refresh in ItemView during fast scrolling
 533       GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
 534     }
 535   }
 536 }
 537
 538 void ScrollBar::OnSizeSet( const Vector3& size )
 539 {
 540   if(mIndicatorHeightPolicy == Toolkit::ScrollBar::FIXED)
 541   {
 542     mIndicator.SetProperty( Actor::Property::SIZE, Vector2( size.width, mIndicatorFixedHeight ) );
 543   }
 544
 545   Control::OnSizeSet( size );
 546 }
 547
 548 void ScrollBar::SetScrollDirection( Toolkit::ScrollBar::Direction direction )
 549 {
 550   mDirection = direction;
 551 }
 552
 553 Toolkit::ScrollBar::Direction ScrollBar::GetScrollDirection() const
 554 {
 555   return mDirection;
 556 }
 557
 558 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
 559 {
 560   if( policy != mIndicatorHeightPolicy )
 561   {
 562     mIndicatorHeightPolicy = policy;
 563     ApplyConstraints();
 564   }
 565 }
 566
 567 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy() const
 568 {
 569   return mIndicatorHeightPolicy;
 570 }
 571
 572 void ScrollBar::SetIndicatorFixedHeight( float height )
 573 {
 574   mIndicatorFixedHeight = height;
 575
 576   if(mIndicatorHeightPolicy == Toolkit::ScrollBar::FIXED)
 577   {
 578     mIndicator.SetProperty( Actor::Property::SIZE, Vector2( Self().GetCurrentProperty< Vector3 >( Actor::Property::SIZE ).width, mIndicatorFixedHeight) );
 579   }
 580 }
 581
 582 float ScrollBar::GetIndicatorFixedHeight() const
 583 {
 584   return mIndicatorFixedHeight;
 585 }
 586
 587 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
 588 {
 589   mIndicatorShowDuration = durationSeconds;
 590 }
 591
 592 float ScrollBar::GetIndicatorShowDuration() const
 593 {
 594   return mIndicatorShowDuration;
 595 }
 596
 597 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
 598 {
 599   mIndicatorHideDuration = durationSeconds;
 600 }
 601
 602 float ScrollBar::GetIndicatorHideDuration() const
 603 {
 604   return mIndicatorHideDuration;
 605 }
 606
 607 void ScrollBar::OnScrollDirectionPropertySet( Property::Value propertyValue )
 608 {
 609   std::string directionName( propertyValue.Get<std::string>() );
 610   if(directionName == "VERTICAL")
 611   {
 612     SetScrollDirection(Toolkit::ScrollBar::VERTICAL);
 613   }
 614   else if(directionName == "HORIZONTAL")
 615   {
 616     SetScrollDirection(Toolkit::ScrollBar::HORIZONTAL);
 617   }
 618   else
 619   {
 620     DALI_ASSERT_ALWAYS( !"ScrollBar::OnScrollDirectionPropertySet(). Invalid Property value." );
 621   }
 622 }
 623
 624 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
 625 {
 626   std::string policyName( propertyValue.Get<std::string>() );
 627   if(policyName == "VARIABLE")
 628   {
 629     SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
 630   }
 631   else if(policyName == "FIXED")
 632   {
 633     SetIndicatorHeightPolicy(Toolkit::ScrollBar::FIXED);
 634   }
 635   else
 636   {
 637     DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
 638   }
 639 }
 640
 641 bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 642 {
 643   Dali::BaseHandle handle( object );
 644
 645   bool connected( true );
 646   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
 647
 648   if( 0 == strcmp( signalName.c_str(), PAN_FINISHED_SIGNAL ) )
 649   {
 650     scrollBar.PanFinishedSignal().Connect( tracker, functor );
 651   }
 652   else if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_INTERVAL_REACHED_SIGNAL ) )
 653   {
 654     scrollBar.ScrollPositionIntervalReachedSignal().Connect( tracker, functor );
 655   }
 656   else
 657   {
 658     // signalName does not match any signal
 659     connected = false;
 660   }
 661
 662   return connected;
 663 }
 664
 665 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 666 {
 667   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 668
 669   if( scrollBar )
 670   {
 671     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 672     switch( index )
 673     {
 674       case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
 675       {
 676         scrollBarImpl.OnScrollDirectionPropertySet( value );
 677         break;
 678       }
 679       case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
 680       {
 681         scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
 682         break;
 683       }
 684       case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
 685       {
 686         scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
 687         break;
 688       }
 689       case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
 690       {
 691         scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
 692         break;
 693       }
 694       case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
 695       {
 696         scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
 697         break;
 698       }
 699       case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
 700       {
 701         const Property::Array* array = value.GetArray();
 702         if( array )
 703         {
 704           Dali::Vector<float> positions;
 705           size_t positionCount = array->Count();
 706           positions.Resize( positionCount );
 707           for( size_t i = 0; i != positionCount; ++i )
 708           {
 709             array->GetElementAt( i ).Get( positions[i] );
 710           }
 711
 712           scrollBarImpl.SetScrollPositionIntervals(positions);
 713         }
 714         break;
 715       }
 716       case Toolkit::ScrollBar::Property::INDICATOR_MINIMUM_HEIGHT:
 717       {
 718         scrollBarImpl.mIndicatorMinimumHeight = value.Get<float>();
 719         scrollBarImpl.ApplyConstraints();
 720         break;
 721       }
 722       case Toolkit::ScrollBar::Property::INDICATOR_START_PADDING:
 723       {
 724         scrollBarImpl.mIndicatorStartPadding = value.Get<float>();
 725         scrollBarImpl.ApplyConstraints();
 726         break;
 727       }
 728       case Toolkit::ScrollBar::Property::INDICATOR_END_PADDING:
 729       {
 730         scrollBarImpl.mIndicatorEndPadding = value.Get<float>();
 731         scrollBarImpl.ApplyConstraints();
 732         break;
 733       }
 734       case Toolkit::ScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
 735       {
 736         scrollBarImpl.mTransientIndicatorDuration = value.Get<float>();
 737         break;
 738       }
 739     }
 740   }
 741 }
 742
 743 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
 744 {
 745   Property::Value value;
 746
 747   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 748
 749   if( scrollBar )
 750   {
 751     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 752     switch( index )
 753     {
 754       case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
 755       {
 756         value = SCROLL_DIRECTION_NAME[ scrollBarImpl.GetScrollDirection() ];
 757         break;
 758       }
 759       case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
 760       {
 761         value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
 762         break;
 763       }
 764       case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
 765       {
 766         value = scrollBarImpl.GetIndicatorFixedHeight();
 767         break;
 768       }
 769       case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
 770       {
 771         value = scrollBarImpl.GetIndicatorShowDuration();
 772         break;
 773       }
 774       case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
 775       {
 776         value = scrollBarImpl.GetIndicatorHideDuration();
 777         break;
 778       }
 779       case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
 780       {
 781         Property::Value tempValue( Property::ARRAY );
 782         Property::Array* array = tempValue.GetArray();
 783
 784         if( array )
 785         {
 786           Dali::Vector<float> positions = scrollBarImpl.GetScrollPositionIntervals();
 787           size_t positionCount( positions.Count() );
 788
 789           for( size_t i( 0 ); i != positionCount; ++i )
 790           {
 791             array->PushBack( positions[i] );
 792           }
 793
 794           value = tempValue;
 795         }
 796         break;
 797       }
 798       case Toolkit::ScrollBar::Property::INDICATOR_MINIMUM_HEIGHT:
 799       {
 800         value = scrollBarImpl.mIndicatorMinimumHeight;
 801         break;
 802       }
 803       case Toolkit::ScrollBar::Property::INDICATOR_START_PADDING:
 804       {
 805         value = scrollBarImpl.mIndicatorStartPadding;
 806         break;
 807       }
 808       case Toolkit::ScrollBar::Property::INDICATOR_END_PADDING:
 809       {
 810         value = scrollBarImpl.mIndicatorEndPadding;
 811         break;
 812       }
 813       case Toolkit::ScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
 814       {
 815         value = scrollBarImpl.mTransientIndicatorDuration;
 816         break;
 817       }
 818     }
 819   }
 820   return value;
 821 }
 822
 823 bool ScrollBar::DoAction( BaseObject* object, const std::string& actionName, const Property::Map& attributes )
 824 {
 825   bool ret = false;
 826
 827   Dali::BaseHandle handle( object );
 828
 829   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
 830
 831   DALI_ASSERT_DEBUG( scrollBar );
 832
 833   if( scrollBar )
 834   {
 835     if( 0 == strcmp( actionName.c_str(), ACTION_SHOW_INDICATOR ) )
 836     {
 837       GetImpl( scrollBar ).ShowIndicator();
 838       ret = true;
 839     }
 840     else if( 0 == strcmp( actionName.c_str(), ACTION_HIDE_INDICATOR ) )
 841     {
 842       GetImpl( scrollBar ).HideIndicator();
 843       ret = true;
 844     }
 845     else if( 0 == strcmp( actionName.c_str(), ACTION_SHOW_TRANSIENT_INDICATOR ) )
 846     {
 847       GetImpl( scrollBar ).ShowTransientIndicator();
 848       ret = true;
 849     }
 850   }
 851
 852   return ret;
 853 }
 854
 855 Toolkit::ScrollBar ScrollBar::New(Toolkit::ScrollBar::Direction direction)
 856 {
 857   // Create the implementation, temporarily owned by this handle on stack
 858   IntrusivePtr< ScrollBar > impl = new ScrollBar(direction);
 859
 860   // Pass ownership to CustomActor handle
 861   Toolkit::ScrollBar handle( *impl );
 862
 863   // Second-phase init of the implementation
 864   // This can only be done after the CustomActor connection has been made...
 865   impl->Initialize();
 866
 867   return handle;
 868 }
 869
 870 double ScrollBar::AccessibleImpl::GetMinimum()
 871 {
 872   auto p = Toolkit::ScrollBar::DownCast( self );
 873   Handle scrollableHandle = GetImpl( p ).mScrollableObject.GetHandle();
 874   return scrollableHandle ? scrollableHandle.GetCurrentProperty< float >( GetImpl( p ).mPropertyMinScrollPosition ) : 0.0f;
 875 }
 876
 877 double ScrollBar::AccessibleImpl::GetCurrent()
 878 {
 879   auto p = Toolkit::ScrollBar::DownCast( self );
 880   Handle scrollableHandle = GetImpl( p ).mScrollableObject.GetHandle();
 881   return scrollableHandle ? scrollableHandle.GetCurrentProperty< float >( GetImpl( p ).mPropertyScrollPosition ) : 0.0f;
 882 }
 883
 884 double ScrollBar::AccessibleImpl::GetMaximum()
 885 {
 886   auto p = Toolkit::ScrollBar::DownCast( self );
 887   Handle scrollableHandle = GetImpl( p ).mScrollableObject.GetHandle();
 888   return scrollableHandle ? scrollableHandle.GetCurrentProperty< float >( GetImpl( p ).mPropertyMaxScrollPosition ) : 1.0f;
 889 }
 890
 891 bool ScrollBar::AccessibleImpl::SetCurrent( double current )
 892 {
 893   if( current < GetMinimum() || current > GetMaximum() )
 894     return false;
 895
 896   auto value_before = GetCurrent();
 897
 898   auto p = Toolkit::ScrollBar::DownCast( self );
 899   Handle scrollableHandle = GetImpl( p ).mScrollableObject.GetHandle();
 900   if( !scrollableHandle )
 901     return false;
 902   scrollableHandle.SetProperty( GetImpl( p ).mPropertyScrollPosition, static_cast< float >( current ) );
 903
 904   auto value_after = GetCurrent();
 905
 906   if( ( current != value_before ) && ( value_before == value_after ) )
 907     return false;
 908
 909   return true;
 910 }
 911
 912 double ScrollBar::AccessibleImpl::GetMinimumIncrement() { return 1.0; }
 913
 914 } // namespace Internal
 915
 916 } // namespace Toolkit
 917
 918 } // namespace Dali