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

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