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();
180 void ScrollBar::SetScrollPropertySource( Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize )
183 && propertyScrollPosition != Property::INVALID_INDEX
184 && propertyMinScrollPosition != Property::INVALID_INDEX
185 && propertyMaxScrollPosition != Property::INVALID_INDEX
186 && propertyScrollContentSize != Property::INVALID_INDEX )
188 mScrollableObject = handle;
189 mPropertyScrollPosition = propertyScrollPosition;
190 mPropertyMinScrollPosition = propertyMinScrollPosition;
191 mPropertyMaxScrollPosition = propertyMaxScrollPosition;
192 mPropertyScrollContentSize = propertyScrollContentSize;
198 DALI_LOG_ERROR("Can not set empty handle of source object or invalid source property index\n");
202 void ScrollBar::CreateDefaultIndicatorActor()
204 Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH );
205 ImageActor indicator = ImageActor::New( indicatorImage );
206 indicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
207 indicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
208 indicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
209 indicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
211 SetScrollIndicator(indicator);
214 void ScrollBar::SetScrollIndicator( Actor indicator )
216 // Don't allow empty handle
219 mIndicator = indicator;
222 self.Add(mIndicator);
224 if( !mPanGestureDetector )
226 mPanGestureDetector = PanGestureDetector::New();
227 mPanGestureDetector.DetectedSignal().Connect(this, &ScrollBar::OnPan);
230 mPanGestureDetector.DetachAll();
231 mPanGestureDetector.Attach( mIndicator );
233 unsigned int childCount = mIndicator.GetChildCount();
234 for ( unsigned int index = 0; index < childCount; index++ )
236 Actor child = mIndicator.GetChildAt( index );
239 mPanGestureDetector.Attach( child );
245 DALI_LOG_ERROR("Empty handle of scroll indicator\n");
249 Actor ScrollBar::GetScrollIndicator()
254 void ScrollBar::ApplyConstraints()
256 if( mScrollableObject )
258 if(mIndicatorSizeConstraint)
260 mIndicatorSizeConstraint.Remove();
263 // Set indicator height according to the indicator's height policy
264 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
266 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
270 mIndicatorSizeConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::SIZE, IndicatorSizeConstraint() );
271 mIndicatorSizeConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
272 mIndicatorSizeConstraint.AddSource( Source( mScrollableObject, mPropertyScrollContentSize ) );
273 mIndicatorSizeConstraint.Apply();
276 if(mIndicatorPositionConstraint)
278 mIndicatorPositionConstraint.Remove();
281 mIndicatorPositionConstraint = Constraint::New<Vector3>( mIndicator, Actor::Property::POSITION, IndicatorPositionConstraint() );
282 mIndicatorPositionConstraint.AddSource( LocalSource( Actor::Property::SIZE ) );
283 mIndicatorPositionConstraint.AddSource( ParentSource( Actor::Property::SIZE ) );
284 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyScrollPosition ) );
285 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyMinScrollPosition ) );
286 mIndicatorPositionConstraint.AddSource( Source( mScrollableObject, mPropertyMaxScrollPosition ) );
287 mIndicatorPositionConstraint.Apply();
291 void ScrollBar::SetScrollPositionIntervals( const Dali::Vector<float>& positions )
293 mScrollPositionIntervals = positions;
295 if( mScrollableObject )
297 if( mPositionNotification )
299 mScrollableObject.RemovePropertyNotification(mPositionNotification);
302 mPositionNotification = mScrollableObject.AddPropertyNotification( mPropertyScrollPosition, VariableStepCondition(mScrollPositionIntervals) );
303 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionIntervalReached );
307 Dali::Vector<float> ScrollBar::GetScrollPositionIntervals() const
309 return mScrollPositionIntervals;
312 void ScrollBar::OnScrollPositionIntervalReached(PropertyNotification& source)
314 // Emit the signal to notify the scroll position crossing
315 if(mScrollableObject)
317 mScrollPositionIntervalReachedSignal.Emit(mScrollableObject.GetProperty<float>(mPropertyScrollPosition));
321 void ScrollBar::ShowIndicator()
323 // Cancel any animation
330 if(mIndicatorShowDuration > 0.0f)
332 mAnimation = Animation::New( mIndicatorShowDuration );
333 mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN );
338 mIndicator.SetOpacity(1.0f);
342 void ScrollBar::HideIndicator()
344 // Cancel any animation
351 if(mIndicatorHideDuration > 0.0f)
353 mAnimation = Animation::New( mIndicatorHideDuration );
354 mAnimation.AnimateTo( Property( mIndicator, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN );
359 mIndicator.SetOpacity(0.0f);
363 bool ScrollBar::OnPanGestureProcessTick()
365 // Update the scroll position property.
366 if( mScrollableObject )
368 mScrollableObject.SetProperty(mPropertyScrollPosition, mCurrentScrollPosition);
374 void ScrollBar::OnPan( Actor source, const PanGesture& gesture )
376 if(mScrollableObject)
378 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(mScrollableObject);
380 switch(gesture.state)
382 case Gesture::Started:
384 if( !mPanProcessTimer )
386 // Make sure the pan gesture is only being processed once per frame.
387 mPanProcessTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
388 mPanProcessTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
389 mPanProcessTimer.Start();
393 mScrollStart = mScrollableObject.GetProperty<float>(mPropertyScrollPosition);
394 mGestureDisplacement = Vector3::ZERO;
399 case Gesture::Continuing:
401 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
402 mGestureDisplacement+=delta;
404 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
405 float minScrollPosition = mScrollableObject.GetProperty<float>(mPropertyMinScrollPosition);
406 float maxScrollPosition = mScrollableObject.GetProperty<float>(mPropertyMaxScrollPosition);
407 float domainSize = maxScrollPosition - minScrollPosition;
409 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
410 mCurrentScrollPosition = 0.0f - std::min(maxScrollPosition, std::max(-mCurrentScrollPosition, minScrollPosition));
418 if( mPanProcessTimer )
420 // Destroy the timer when pan gesture is finished.
421 mPanProcessTimer.Stop();
422 mPanProcessTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
423 mPanProcessTimer.Reset();
428 // Refresh the ItemView cache with extra items
429 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
432 mPanFinishedSignal.Emit();
440 // Disable automatic refresh in ItemView during fast scrolling
441 GetImpl(itemView).SetRefreshEnabled(true);//!mIsPanning);
446 void ScrollBar::OnSizeSet( const Vector3& size )
448 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
450 mIndicator.SetSize(size.width, mIndicatorFixedHeight);
454 void ScrollBar::SetScrollDirection( Toolkit::ScrollBar::Direction direction )
456 mDirection = direction;
459 Toolkit::ScrollBar::Direction ScrollBar::GetScrollDirection() const
464 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
466 mIndicatorHeightPolicy = policy;
470 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy() const
472 return mIndicatorHeightPolicy;
475 void ScrollBar::SetIndicatorFixedHeight( float height )
477 mIndicatorFixedHeight = height;
479 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
481 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
485 float ScrollBar::GetIndicatorFixedHeight() const
487 return mIndicatorFixedHeight;
490 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
492 mIndicatorShowDuration = durationSeconds;
495 float ScrollBar::GetIndicatorShowDuration() const
497 return mIndicatorShowDuration;
500 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
502 mIndicatorHideDuration = durationSeconds;
505 float ScrollBar::GetIndicatorHideDuration() const
507 return mIndicatorHideDuration;
510 void ScrollBar::OnScrollDirectionPropertySet( Property::Value propertyValue )
512 std::string directionName( propertyValue.Get<std::string>() );
513 if(directionName == "Vertical")
515 SetScrollDirection(Toolkit::ScrollBar::Vertical);
517 else if(directionName == "Horizontal")
519 SetScrollDirection(Toolkit::ScrollBar::Horizontal);
523 DALI_ASSERT_ALWAYS( !"ScrollBar::OnScrollDirectionPropertySet(). Invalid Property value." );
527 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
529 std::string policyName( propertyValue.Get<std::string>() );
530 if(policyName == "Variable")
532 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
534 else if(policyName == "Fixed")
536 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
540 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
544 bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
546 Dali::BaseHandle handle( object );
548 bool connected( true );
549 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
551 if( 0 == strcmp( signalName.c_str(), PAN_FINISHED_SIGNAL ) )
553 scrollBar.PanFinishedSignal().Connect( tracker, functor );
555 else if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_INTERVAL_REACHED_SIGNAL ) )
557 scrollBar.ScrollPositionIntervalReachedSignal().Connect( tracker, functor );
561 // signalName does not match any signal
568 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
570 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
574 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
577 case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
579 scrollBarImpl.OnScrollDirectionPropertySet( value );
582 case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
584 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
587 case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
589 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
592 case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
594 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
597 case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
599 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
602 case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
604 Property::Array* array = value.GetArray();
607 Dali::Vector<float> positions;
608 size_t positionCount = array->Count();
609 positions.Resize( positionCount );
610 for( size_t i = 0; i != positionCount; ++i )
612 array->GetElementAt( i ).Get( positions[i] );
615 scrollBarImpl.SetScrollPositionIntervals(positions);
623 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
625 Property::Value value;
627 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
631 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
634 case Toolkit::ScrollBar::Property::SCROLL_DIRECTION:
636 value = SCROLL_DIRECTION_NAME[ scrollBarImpl.GetScrollDirection() ];
639 case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY:
641 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
644 case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT:
646 value = scrollBarImpl.GetIndicatorFixedHeight();
649 case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION:
651 value = scrollBarImpl.GetIndicatorShowDuration();
654 case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION:
656 value = scrollBarImpl.GetIndicatorHideDuration();
659 case Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS:
661 Property::Value value( Property::ARRAY );
662 Property::Array* array = value.GetArray();
663 Dali::Vector<float> positions = scrollBarImpl.GetScrollPositionIntervals();
664 size_t positionCount( array->Count() );
665 for( size_t i( 0 ); i != positionCount; ++i )
667 array->PushBack( positions[i] );
676 Toolkit::ScrollBar ScrollBar::New(Toolkit::ScrollBar::Direction direction)
678 // Create the implementation, temporarily owned by this handle on stack
679 IntrusivePtr< ScrollBar > impl = new ScrollBar(direction);
681 // Pass ownership to CustomActor handle
682 Toolkit::ScrollBar handle( *impl );
684 // Second-phase init of the implementation
685 // This can only be done after the CustomActor connection has been made...
691 } // namespace Internal
693 } // namespace Toolkit