X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fscroll-bar%2Fscroll-bar-impl.cpp;h=2bcca2f5daec6cdd40fd337420114625c493ee49;hp=f9473b93d6d194ae9522d2616659d76ddc7b06e5;hb=df92f45e89c92ca9b2286d51116ff7b69e75c569;hpb=818994dc0acac601b0b27c0b715259b504ef4ceb diff --git a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp index f9473b9..2bcca2f 100755 --- a/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp +++ b/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp @@ -1,62 +1,58 @@ -// -// Copyright (c) 2014 Samsung Electronics Co., Ltd. -// -// Licensed under the Flora License, Version 1.0 (the License); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://floralicense.org/license/ -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an AS IS BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// +/* + * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +// CLASS HEADER #include +// EXTERNAL INCLUDES +#include // for strcmp +#include +#include +#include +#include +#include + +// INTERNAL INCLUDES +#include + using namespace Dali; namespace { const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png"; -const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(0.0f, 12.0f, 14.0f, 14.0f); +const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f); +const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border const float DEFAULT_SLIDER_DEPTH(1.0f); -const float INDICATOR_SHOW_TIME(0.5f); -const float INDICATOR_HIDE_TIME(0.5f); +const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f); +const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f); +const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame +const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f); /** - * Indicator size constraint * Indicator size depends on both indicator's parent size and the scroll content size */ -struct IndicatorSizeConstraint +Vector3 IndicatorSize( const Vector3& parentSize, float contentSize) { - /** - * @param[in] contentSize The size of scrollable content - */ - IndicatorSizeConstraint(float contentSize) - : mContentSize(contentSize) - { - } - - /** - * Constraint operator - * @param[in] current The current indicator size - * @param[in] parentSizeProperty The parent size of scroll indicator. - * @return The new scroll indicator size. - */ - Vector3 operator()(const Vector3& current, - const PropertyInput& parentSizeProperty) - { - const Vector3& parentSize = parentSizeProperty.GetVector3(); - float height = mContentSize > parentSize.height ? parentSize.height * ( parentSize.height / mContentSize ) : parentSize.height * ( (parentSize.height - mContentSize * 0.5f) / parentSize.height); - return Vector3( parentSize.width, height, parentSize.depth ); - } - - float mContentSize; ///< The size of scrollable content -}; + float height = contentSize > parentSize.height ? + parentSize.height * ( parentSize.height / contentSize ) : + parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height); + return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth ); +} /** * Indicator position constraint @@ -76,24 +72,21 @@ struct IndicatorPositionConstraint /** * Constraint operator - * @param[in] current The current indicator position - * @param[in] indicatorSizeProperty The size of indicator. - * @param[in] parentSizeProperty The parent size of indicator. - * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis) + * @param[in,out] current The current indicator position + * @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) * @return The new indicator position is returned. */ - Vector3 operator()(const Vector3& current, - const PropertyInput& indicatorSizeProperty, - const PropertyInput& parentSizeProperty, - const PropertyInput& scrollPositionProperty) + void operator()( Vector3& current, const PropertyInputContainer& inputs ) { - Vector3 indicatorSize = indicatorSizeProperty.GetVector3(); - Vector3 parentSize = parentSizeProperty.GetVector3(); - float scrollPosition = scrollPositionProperty.GetFloat(); + const Vector3& indicatorSize = inputs[0]->GetVector3(); + const Vector3& parentSize = inputs[1]->GetVector3(); + float scrollPosition = inputs[2]->GetFloat(); const float domainSize = fabs(mMaxPosition - mMinPosition); float relativePosition = (mMaxPosition - scrollPosition) / domainSize; - return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH); + + current.y = relativePosition * ( parentSize.height - indicatorSize.height ); + current.z = DEFAULT_SLIDER_DEPTH; } float mMinPosition; ///< The minimum scroll position @@ -118,16 +111,34 @@ using namespace Dali; BaseHandle Create() { - return BaseHandle(); + return Toolkit::ScrollBar::New(); } -TypeRegistration mType( typeid(Toolkit::ScrollBar), typeid(Toolkit::Control), Create ); +// Setup properties, signals and actions using the type-registry. +DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ScrollBar, Toolkit::ScrollComponent, Create ); + +DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-height-policy", STRING, INDICATOR_HEIGHT_POLICY ) +DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-fixed-height", FLOAT, INDICATOR_FIXED_HEIGHT ) +DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-show-duration", FLOAT, INDICATOR_SHOW_DURATION ) +DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicator-hide-duration", FLOAT, INDICATOR_HIDE_DURATION ) + +DALI_SIGNAL_REGISTRATION( Toolkit, ScrollBar, "scroll-position-notified", SCROLL_POSITION_NOTIFIED_SIGNAL ) + +DALI_TYPE_REGISTRATION_END() + +const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"}; } ScrollBar::ScrollBar() -: ControlImpl(true/*requires touch*/), - mScrollStart(0.0f) +: mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION), + mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION), + mScrollStart(0.0f), + mIsPanning(false), + mCurrentScrollPosition(0.0f), + mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable), + mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT), + mPropertyIndicatorPosition(Property::INVALID_INDEX) { } @@ -139,7 +150,7 @@ void ScrollBar::OnInitialize() { Actor self = Self(); - Image indicatorImage = Image::New( DEFAULT_INDICATOR_IMAGE_PATH ); + Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH ); mIndicator = ImageActor::New( indicatorImage ); mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER ); mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH ); @@ -153,43 +164,27 @@ void ScrollBar::OnInitialize() EnableGestureDetection(Gesture::Type(Gesture::Pan)); } -void ScrollBar::SetScrollConnector( Toolkit::ScrollConnector connector ) +void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector ) { - if(mScrollConnector) + if( oldConnector ) { - mScrollConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged); - } - - mScrollConnector = connector; - mScrollPositionObject = mScrollConnector.GetScrollPositionObject(); - - ApplyConstraints(); - mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged); -} + oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged); -void ScrollBar::SetBackgroundImage( Image image, const Vector4& border ) -{ - if (!mBackground ) - { - mBackground = ImageActor::New( image ); - mBackground.SetParentOrigin( ParentOrigin::TOP_LEFT ); - mBackground.SetAnchorPoint( AnchorPoint::TOP_LEFT ); - Self().Add(mBackground); + mScrollPositionObject.Reset(); } - else + + if( mScrollConnector ) { - mBackground.SetImage(image); - } + mScrollPositionObject = mScrollConnector.GetScrollPositionObject(); - mBackground.SetNinePatchBorder( border ); - mBackground.SetStyle( ImageActor::STYLE_NINE_PATCH ); + ApplyConstraints(); + mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged); + } } -void ScrollBar::SetIndicatorImage( Image image, const Vector4& border ) +void ScrollBar::SetIndicatorImage( Image image ) { mIndicator.SetImage(image); - mIndicator.SetNinePatchBorder( border ); - mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH ); } Actor ScrollBar::GetScrollIndicator() @@ -199,28 +194,28 @@ Actor ScrollBar::GetScrollIndicator() void ScrollBar::ApplyConstraints() { - mIndicator.RemoveConstraints(); - - Constraint constraint = Constraint::New( Actor::SIZE, - ParentSource( Actor::SIZE ), - IndicatorSizeConstraint( mScrollConnector.GetContentLength() ) ); - mIndicator.ApplyConstraint( constraint ); - - constraint = Constraint::New( Actor::POSITION, - LocalSource( Actor::SIZE ), - ParentSource( Actor::SIZE ), - Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ), - IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) ); - mIndicator.ApplyConstraint( constraint ); - - if( mBackground ) + if( mScrollConnector ) { - mBackground.RemoveConstraints(); + // Set indicator height according to the indicator's height policy + if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed) + { + mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight); + } + else + { + mIndicator.SetSize( IndicatorSize( Self().GetCurrentSize(), mScrollConnector.GetContentLength() ) ); + } + + if(mIndicatorPositionConstraint) + { + mIndicatorPositionConstraint.Remove(); + } - constraint = Constraint::New(Actor::SIZE, - ParentSource(Actor::SIZE), - EqualToConstraint()); - mBackground.ApplyConstraint(constraint); + mIndicatorPositionConstraint = Constraint::New( mIndicator, Actor::Property::POSITION, IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) ); + mIndicatorPositionConstraint.AddSource( LocalSource( Actor::Property::SIZE ) ); + mIndicatorPositionConstraint.AddSource( ParentSource( Actor::Property::SIZE ) ); + mIndicatorPositionConstraint.AddSource( Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ) ); + mIndicatorPositionConstraint.Apply(); } } @@ -240,11 +235,13 @@ void ScrollBar::SetPositionNotifications( const std::vector& positions ) void ScrollBar::OnScrollPositionNotified(PropertyNotification& source) { // Emit the signal to notify the scroll position crossing - mScrollPositionNotifiedSignal.Emit(mScrollPositionObject.GetProperty( Toolkit::ScrollConnector::SCROLL_POSITION )); + mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition()); } void ScrollBar::Show() { + Actor self = Self(); + // Cancel any animation if(mAnimation) { @@ -252,13 +249,22 @@ void ScrollBar::Show() mAnimation.Reset(); } - mAnimation = Animation::New( INDICATOR_SHOW_TIME ); - mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn ); - mAnimation.Play(); + if(mIndicatorShowDuration > 0.0f) + { + mAnimation = Animation::New( mIndicatorShowDuration ); + mAnimation.AnimateTo( Property( self, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN ); + mAnimation.Play(); + } + else + { + self.SetOpacity(1.0f); + } } void ScrollBar::Hide() { + Actor self = Self(); + // Cancel any animation if(mAnimation) { @@ -266,22 +272,52 @@ void ScrollBar::Hide() mAnimation.Reset(); } - mAnimation = Animation::New( INDICATOR_HIDE_TIME ); - mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn ); - mAnimation.Play(); + if(mIndicatorHideDuration > 0.0f) + { + mAnimation = Animation::New( mIndicatorHideDuration ); + mAnimation.AnimateTo( Property( self, Actor::Property::COLOR_ALPHA ), 0.0f, AlphaFunction::EASE_IN ); + mAnimation.Play(); + } + else + { + self.SetOpacity(0.0f); + } +} + +bool ScrollBar::OnPanGestureProcessTick() +{ + // Update the scroll position property. + if( mScrollConnector ) + { + mScrollConnector.SetScrollPosition(mCurrentScrollPosition); + } + + return true; } void ScrollBar::OnPan( PanGesture gesture ) { - if(mScrollPositionObject) + if(mScrollConnector) { + Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent()); + switch(gesture.state) { case Gesture::Started: { + if( !mTimer ) + { + // Make sure the pan gesture is only being processed once per frame. + mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME ); + mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick ); + mTimer.Start(); + } + Show(); - mScrollStart = mScrollPositionObject.GetProperty( Toolkit::ScrollConnector::SCROLL_POSITION ); + mScrollStart = mScrollConnector.GetScrollPosition(); mGestureDisplacement = Vector3::ZERO; + mIsPanning = true; + break; } case Gesture::Continuing: @@ -291,16 +327,46 @@ void ScrollBar::OnPan( PanGesture gesture ) Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize(); const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit()); - float position = mScrollStart - mGestureDisplacement.y * domainSize / span.y; - position = std::min(mScrollConnector.GetMaxLimit(), std::max(position, mScrollConnector.GetMinLimit())); - mScrollPositionObject.SetProperty( Toolkit::ScrollConnector::SCROLL_POSITION, position ); + mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y; + mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit())); + break; } default: { + mIsPanning = false; + + if( mTimer ) + { + // Destroy the timer when pan gesture is finished. + mTimer.Stop(); + mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick ); + mTimer.Reset(); + } + + if(itemView) + { + // Refresh the ItemView cache with extra items + GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true); + } + break; } } + + if(itemView) + { + // Disable automatic refresh in ItemView during fast scrolling + GetImpl(itemView).SetRefreshEnabled(!mIsPanning); + } + } +} + +void ScrollBar::OnControlSizeSet( const Vector3& size ) +{ + if(mIndicatorHeightPolicy != Toolkit::ScrollBar::Fixed && mScrollConnector) + { + mIndicator.SetSize( IndicatorSize( size, mScrollConnector.GetContentLength() ) ); } } @@ -310,6 +376,154 @@ void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, floa ApplyConstraints(); } +void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy ) +{ + mIndicatorHeightPolicy = policy; + ApplyConstraints(); +} + +Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy() +{ + return mIndicatorHeightPolicy; +} + +void ScrollBar::SetIndicatorFixedHeight( float height ) +{ + mIndicatorFixedHeight = height; + ApplyConstraints(); +} + +float ScrollBar::GetIndicatorFixedHeight() +{ + return mIndicatorFixedHeight; +} + +void ScrollBar::SetIndicatorShowDuration( float durationSeconds ) +{ + mIndicatorShowDuration = durationSeconds; +} + +float ScrollBar::GetIndicatorShowDuration() +{ + return mIndicatorShowDuration; +} + +void ScrollBar::SetIndicatorHideDuration( float durationSeconds ) +{ + mIndicatorHideDuration = durationSeconds; +} + +float ScrollBar::GetIndicatorHideDuration() +{ + return mIndicatorHideDuration; +} + +void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue ) +{ + std::string policyName( propertyValue.Get() ); + if(policyName == "Variable") + { + SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable); + } + else if(policyName == "Fixed") + { + SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed); + } + else + { + DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." ); + } +} + +bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ) +{ + Dali::BaseHandle handle( object ); + + bool connected( true ); + Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle ); + + if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_NOTIFIED_SIGNAL ) ) + { + scrollBar.ScrollPositionNotifiedSignal().Connect( tracker, functor ); + } + else + { + // signalName does not match any signal + connected = false; + } + + return connected; +} + +void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ) +{ + Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) ); + + if( scrollBar ) + { + ScrollBar& scrollBarImpl( GetImpl( scrollBar ) ); + switch( index ) + { + case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY: + { + scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value ); + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT: + { + scrollBarImpl.SetIndicatorFixedHeight(value.Get()); + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION: + { + scrollBarImpl.SetIndicatorShowDuration(value.Get()); + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION: + { + scrollBarImpl.SetIndicatorHideDuration(value.Get()); + break; + } + } + } +} + +Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index ) +{ + Property::Value value; + + Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) ); + + if( scrollBar ) + { + ScrollBar& scrollBarImpl( GetImpl( scrollBar ) ); + switch( index ) + { + case Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY: + { + value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ]; + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT: + { + value = scrollBarImpl.GetIndicatorFixedHeight(); + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION: + { + value = scrollBarImpl.GetIndicatorShowDuration(); + break; + } + case Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION: + { + value = scrollBarImpl.GetIndicatorHideDuration(); + break; + } + } + } + return value; +} + Toolkit::ScrollBar ScrollBar::New() { // Create the implementation, temporarily owned by this handle on stack