2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h>
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/images/resource-image.h>
26 #include <dali/public-api/object/type-registry.h>
27 #include <dali/public-api/object/property-array.h>
28 #include <dali/devel-api/object/type-registry-helper.h>
29 #include <dali/integration-api/debug.h>
33 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
40 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
41 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
42 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
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);
50 * Indicator size constraint
51 * Indicator size depends on both indicator's parent size and the scroll content size
53 struct IndicatorSizeConstraint
55 IndicatorSizeConstraint()
61 * @param[in] current The current indicator size
62 * @param[in] parentSizeProperty The parent size of scroll indicator.
63 * @return The new scroll indicator size.
65 void operator()(Vector3& current, const PropertyInputContainer& inputs )
67 const Vector3& parentSize = inputs[0]->GetVector3();
68 const float contentSize = inputs[1]->GetFloat();
70 float height = contentSize > parentSize.height ?
71 parentSize.height * ( parentSize.height / contentSize ) :
72 parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height);
74 current.y = std::max(MINIMUM_INDICATOR_HEIGHT, height);
79 * Indicator position constraint
80 * Positions the indicator to reflect the current scroll position within the scroll domain.
82 struct IndicatorPositionConstraint
85 * @param[in] minPosition The minimum limit of scroll position
86 * @param[in] maxPosition the maximum limit of scroll position
88 IndicatorPositionConstraint()
94 * @param[in,out] current The current indicator position
95 * @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)
96 * @return The new indicator position is returned.
98 void operator()( Vector3& current, const PropertyInputContainer& inputs )
100 const Vector3& indicatorSize = inputs[0]->GetVector3();
101 const Vector3& parentSize = inputs[1]->GetVector3();
102 const float scrollPosition = -inputs[2]->GetFloat();
103 const float minScrollPosition = inputs[3]->GetFloat();
104 const float maxScrollPosition = inputs[4]->GetFloat();
106 float relativePosition = std::max( 0.0f, std::min( 1.0f, (scrollPosition - minScrollPosition) / (maxScrollPosition - minScrollPosition) ) );
107 current.y = ( parentSize.height - indicatorSize.height ) * relativePosition;
108 current.z = DEFAULT_SLIDER_DEPTH;
112 } // unnamed namespace
126 using namespace Dali;
130 return Toolkit::ScrollBar::New();
133 // Setup properties, signals and actions using the type-registry.
134 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ScrollBar, Toolkit::Control, Create );
136 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "scroll-direction", STRING, SCROLL_DIRECTION )
137 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-height-policy", STRING, INDICATOR_HEIGHT_POLICY )
138 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-fixed-height", FLOAT, INDICATOR_FIXED_HEIGHT )
139 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-show-duration", FLOAT, INDICATOR_SHOW_DURATION )
140 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-hide-duration", FLOAT, INDICATOR_HIDE_DURATION )
141 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "scroll-position-intervals", ARRAY, SCROLL_POSITION_INTERVALS )
143 DALI_SIGNAL_REGISTRATION( Toolkit, ScrollBar, "pan-finished", PAN_FINISHED_SIGNAL )
144 DALI_SIGNAL_REGISTRATION( Toolkit, ScrollBar, "scroll-position-interval-reached", SCROLL_POSITION_INTERVAL_REACHED_SIGNAL )
146 DALI_TYPE_REGISTRATION_END()
148 const char* SCROLL_DIRECTION_NAME[] = {"Vertical", "Horizontal"};
149 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
153 ScrollBar::ScrollBar(Toolkit::ScrollBar::Direction direction)
154 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS ) ),
155 mDirection(direction),
156 mScrollableObject(Handle()),
157 mPropertyScrollPosition(Property::INVALID_INDEX),
158 mPropertyMinScrollPosition(Property::INVALID_INDEX),
159 mPropertyMaxScrollPosition(Property::INVALID_INDEX),
160 mPropertyScrollContentSize(Property::INVALID_INDEX),
161 mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
162 mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
165 mCurrentScrollPosition(0.0f),
166 mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
167 mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT)
171 ScrollBar::~ScrollBar()
175 void ScrollBar::OnInitialize()
177 CreateDefaultIndicatorActor();
178 Self().SetDrawMode(DrawMode::OVERLAY_2D);
181 void ScrollBar::SetScrollPropertySource( Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize )
184 && propertyScrollPosition != Property::INVALID_INDEX
185 && propertyMinScrollPosition != Property::INVALID_INDEX
186 && propertyMaxScrollPosition != Property::INVALID_INDEX
187 && propertyScrollContentSize != Property::INVALID_INDEX )
189 mScrollableObject = handle;
190 mPropertyScrollPosition = propertyScrollPosition;
191 mPropertyMinScrollPosition = propertyMinScrollPosition;
192 mPropertyMaxScrollPosition = propertyMaxScrollPosition;
193 mPropertyScrollContentSize = propertyScrollContentSize;
199 DALI_LOG_ERROR("Can not set empty handle of source object or invalid source property index\n");
203 void ScrollBar::CreateDefaultIndicatorActor()
205 Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH );
206 ImageActor indicator = ImageActor::New( indicatorImage );
207 indicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
208 indicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
209 indicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
210 indicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
212 SetScrollIndicator(indicator);
215 void ScrollBar::SetScrollIndicator( Actor indicator )
217 // Don't allow empty handle
220 mIndicator = indicator;
221 Self().Add(mIndicator);
223 EnableGestureDetection(Gesture::Type(Gesture::Pan));
225 PanGestureDetector detector( GetPanGestureDetector() );
226 detector.DetachAll();
227 detector.Attach( mIndicator );
229 unsigned int childCount = mIndicator.GetChildCount();
230 for ( unsigned int index = 0; index < childCount; index++ )
232 Actor child = mIndicator.GetChildAt( index );
235 detector.Attach( child );
241 DALI_LOG_ERROR("Empty handle of scroll indicator\n");
245 Actor ScrollBar::GetScrollIndicator()
250 void ScrollBar::ApplyConstraints()
252 if( mScrollableObject )
254 if(mIndicatorSizeConstraint)
256 mIndicatorSizeConstraint.Remove();
259 // Set indicator height according to the indicator's height policy
260 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
262 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
266 mIndicatorSizeConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::SIZE, IndicatorSizeConstraint() );
267 mIndicatorSizeConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
268 mIndicatorSizeConstraint.AddSource( Source( mScrollableObject, mPropertyScrollContentSize ) );
269 mIndicatorSizeConstraint.Apply();
272 if(mIndicatorPositionConstraint)
274 mIndicatorPositionConstraint.Remove();
277 mIndicatorPositionConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::POSITION, IndicatorPositionConstraint() );
278 mIndicatorPositionConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
279 mIndicatorPositionConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
280 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyScrollPosition ) );
281 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyMinScrollPosition ) );
282 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyMaxScrollPosition ) );
283 mIndicatorPositionConstraint.Apply();
287 void ScrollBar::SetScrollPositionIntervals( const Dali::Vector<float>& positions )
289 mScrollPositionIntervals = positions;
291 if( mScrollableObject )
293 if( mPositionNotification )
295 mScrollableObject.RemovePropertyNotification(mPositionNotification);
298 mPositionNotification = mScrollableObject.AddPropertyNotification( mPropertyScrollPosition, VariableStepCondition(mScrollPositionIntervals) );
299 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionIntervalReached );
303 Dali::Vector<float> ScrollBar::GetScrollPositionIntervals() const
305 return mScrollPositionIntervals;
308 void ScrollBar::OnScrollPositionIntervalReached(PropertyNotification& source)
310 // Emit the signal to notify the scroll position crossing
311 if(mScrollableObject)
313 mScrollPositionIntervalReachedSignal.Emit(mScrollableObject.GetProperty<float>(mPropertyScrollPosition));
317 void ScrollBar::ShowIndicator()
319 // Cancel any animation
326 if(mIndicatorShowDuration > 0.0f)
328 mAnimation = Animation::New( mIndicatorShowDuration );
329 mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN );
334 mIndicator.SetOpacity(1.0f);
338 void ScrollBar::HideIndicator()
340 // Cancel any animation
347 if(mIndicatorHideDuration > 0.0f)
349 mAnimation = Animation::New( mIndicatorHideDuration );
350 mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN );
355 mIndicator.SetOpacity(0.0f);
359 bool ScrollBar::OnPanGestureProcessTick()
361 // Update the scroll position property.
362 if( mScrollableObject )
364 mScrollableObject.SetProperty(mPropertyScrollPosition, mCurrentScrollPosition);
370 void ScrollBar::OnPan( const PanGesture& gesture )
372 if(mScrollableObject)
374 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(mScrollableObject);
376 switch(gesture.state)
378 case Gesture::Started:
380 if( !mPanProcessTimer )
382 // Make sure the pan gesture is only being processed once per frame.
383 mPanProcessTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
384 mPanProcessTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
385 mPanProcessTimer.Start();
389 mScrollStart = mScrollableObject.GetProperty<float>(mPropertyScrollPosition);
390 mGestureDisplacement = Vector3::ZERO;
395 case Gesture::Continuing:
397 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
398 mGestureDisplacement+=delta;
400 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
401 float minScrollPosition = mScrollableObject.GetProperty<float>(mPropertyMinScrollPosition);
402 float maxScrollPosition = mScrollableObject.GetProperty<float>(mPropertyMaxScrollPosition);
403 float domainSize = maxScrollPosition - minScrollPosition;
405 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
406 mCurrentScrollPosition = 0.0f - std::min(maxScrollPosition, std::max(-mCurrentScrollPosition, minScrollPosition));
414 if( mPanProcessTimer )
416 // Destroy the timer when pan gesture is finished.
417 mPanProcessTimer.Stop();
418 mPanProcessTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
419 mPanProcessTimer.Reset();
424 // Refresh the ItemView cache with extra items
425 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
428 mPanFinishedSignal.Emit();
436 // Disable automatic refresh in ItemView during fast scrolling
437 GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
442 void ScrollBar::OnSizeSet( const Vector3& size )
444 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
446 mIndicator.SetSize(size.width, mIndicatorFixedHeight);
450 void ScrollBar::SetScrollDirection( Toolkit::ScrollBar::Direction direction )
452 mDirection = direction;
455 Toolkit::ScrollBar::Direction ScrollBar::GetScrollDirection() const
460 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
462 mIndicatorHeightPolicy = policy;
466 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy() const
468 return mIndicatorHeightPolicy;
471 void ScrollBar::SetIndicatorFixedHeight( float height )
473 mIndicatorFixedHeight = height;
475 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
477 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
481 float ScrollBar::GetIndicatorFixedHeight() const
483 return mIndicatorFixedHeight;
486 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
488 mIndicatorShowDuration = durationSeconds;
491 float ScrollBar::GetIndicatorShowDuration() const
493 return mIndicatorShowDuration;
496 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
498 mIndicatorHideDuration = durationSeconds;
501 float ScrollBar::GetIndicatorHideDuration() const
503 return mIndicatorHideDuration;
506 void ScrollBar::OnScrollDirectionPropertySet( Property::Value propertyValue )
508 std::string directionName( propertyValue.Get<std::string>() );
509 if(directionName == "Vertical")
511 SetScrollDirection(Toolkit::ScrollBar::Vertical);
513 else if(directionName == "Horizontal")
515 SetScrollDirection(Toolkit::ScrollBar::Horizontal);
519 DALI_ASSERT_ALWAYS( !"ScrollBar::OnScrollDirectionPropertySet(). Invalid Property value." );
523 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
525 std::string policyName( propertyValue.Get<std::string>() );
526 if(policyName == "Variable")
528 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
530 else if(policyName == "Fixed")
532 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
536 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
540 bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
542 Dali::BaseHandle handle( object );
544 bool connected( true );
545 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
547 if( 0 == strcmp( signalName.c_str(), PAN_FINISHED_SIGNAL ) )
549 scrollBar.PanFinishedSignal().Connect( tracker, functor );
551 else if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_INTERVAL_REACHED_SIGNAL ) )
553 scrollBar.ScrollPositionIntervalReachedSignal().Connect( tracker, functor );
557 // signalName does not match any signal
564 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
566 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
570 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
573 case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
575 scrollBarImpl.OnScrollDirectionPropertySet( value );
578 case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
580 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
583 case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
585 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
588 case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
590 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
593 case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
595 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
598 case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
600 Property::Array* array = value.GetArray();
603 Dali::Vector<float> positions;
604 size_t positionCount = array->Count();
605 positions.Resize( positionCount );
606 for( size_t i = 0; i != positionCount; ++i )
608 array->GetElementAt( i ).Get( positions[i] );
611 scrollBarImpl.SetScrollPositionIntervals(positions);
619 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
621 Property::Value value;
623 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
627 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
630 case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
632 value = SCROLL_DIRECTION_NAME[ scrollBarImpl.GetScrollDirection() ];
635 case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
637 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
640 case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
642 value = scrollBarImpl.GetIndicatorFixedHeight();
645 case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
647 value = scrollBarImpl.GetIndicatorShowDuration();
650 case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
652 value = scrollBarImpl.GetIndicatorHideDuration();
655 case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
657 Property::Value value( Property::ARRAY );
658 Property::Array* array = value.GetArray();
659 Dali::Vector<float> positions = scrollBarImpl.GetScrollPositionIntervals();
660 size_t positionCount( array->Count() );
661 for( size_t i( 0 ); i != positionCount; ++i )
663 array->PushBack( positions[i] );
672 Toolkit::ScrollBar ScrollBar::New(Toolkit::ScrollBar::Direction direction)
674 // Create the implementation, temporarily owned by this handle on stack
675 IntrusivePtr< ScrollBar > impl = new ScrollBar(direction);
677 // Pass ownership to CustomActor handle
678 Toolkit::ScrollBar handle( *impl );
680 // Second-phase init of the implementation
681 // This can only be done after the CustomActor connection has been made...
687 } // namespace Internal
689 } // namespace Toolkit