2 * Copyright (c) 2020 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/text-controls/text-selection-toolbar-impl.h>
23 #include <dali/public-api/math/vector2.h>
24 #include <dali/public-api/math/vector4.h>
25 #include <dali/public-api/object/property-map.h>
26 #include <dali/public-api/object/type-registry-helper.h>
29 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
31 #include <dali-toolkit/internal/helpers/color-conversion.h>
45 const Dali::Vector2 DEFAULT_SCROLL_BAR_PADDING( 8.0f, 6.0f );
49 return Toolkit::TextSelectionToolbar::New();
52 // Setup properties, signals and actions using the type-registry.
54 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextSelectionToolbar, Toolkit::Control, Create );
56 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "maxSize", VECTOR2, MAX_SIZE )
57 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "enableOvershoot", BOOLEAN, ENABLE_OVERSHOOT )
58 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "enableScrollBar", BOOLEAN, ENABLE_SCROLL_BAR )
59 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "scrollBarPadding", VECTOR2, SCROLL_BAR_PADDING )
60 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "scrollView", MAP, SCROLL_VIEW )
62 DALI_TYPE_REGISTRATION_END()
66 Dali::Toolkit::TextSelectionToolbar TextSelectionToolbar::New()
68 // Create the implementation, temporarily owned by this handle on stack
69 IntrusivePtr< TextSelectionToolbar > impl = new TextSelectionToolbar();
71 // Pass ownership to CustomActor handle
72 Dali::Toolkit::TextSelectionToolbar handle( *impl );
74 // Second-phase init of the implementation
75 // This can only be done after the CustomActor connection has been made...
81 void TextSelectionToolbar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
83 Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
87 TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
91 case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
93 impl.SetPopupMaxSize( value.Get< Vector2 >() );
96 case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
98 if( !impl.mScrollView )
100 impl.mScrollView = Toolkit::ScrollView::New();
102 impl.mScrollView.SetOvershootEnabled( value.Get< bool >() );
105 case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
107 impl.SetUpScrollBar( value.Get< bool >() );
110 case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
112 impl.SetScrollBarPadding( value.Get< Vector2 >() );
115 case Toolkit::TextSelectionToolbar::Property::SCROLL_VIEW:
117 // Get a Property::Map from the property if possible.
118 Property::Map setPropertyMap;
119 if( value.Get( setPropertyMap ) )
121 impl.ConfigureScrollview( setPropertyMap );
126 } // TextSelectionToolbar
129 Property::Value TextSelectionToolbar::GetProperty( BaseObject* object, Property::Index index )
131 Property::Value value;
133 Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
137 TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
141 case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
143 value = impl.GetPopupMaxSize();
146 case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
148 value = impl.mScrollView.IsOvershootEnabled();
151 case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
153 value = impl.mScrollBar ? true : false;
156 case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
158 value = impl.GetScrollBarPadding();
166 void TextSelectionToolbar::OnInitialize()
171 void TextSelectionToolbar::OnRelayout( const Vector2& size, RelayoutContainer& container )
173 float width = std::max ( mTableOfButtons.GetNaturalSize().width, size.width );
174 mRulerX->SetDomain( RulerDomain( 0.0, width, true ) );
175 mScrollView.SetRulerX( mRulerX );
179 float barWidth = std::min( mTableOfButtons.GetNaturalSize().width, size.width ) - 2.f * mScrollBarPadding.x;
180 mScrollBar.SetProperty( Actor::Property::SIZE, Vector2( 0.0f, barWidth ) );
184 void TextSelectionToolbar::SetPopupMaxSize( const Size& maxSize )
187 if (mScrollView && mToolbarLayer )
189 mScrollView.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
190 mToolbarLayer.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
194 const Dali::Vector2& TextSelectionToolbar::GetPopupMaxSize() const
199 void TextSelectionToolbar::SetUpScrollView()
201 mScrollView.SetProperty( Dali::Actor::Property::NAME,"TextSelectionScrollView");
202 mScrollView.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
203 mScrollView.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER_LEFT );
204 mScrollView.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER_LEFT );
206 mScrollView.SetScrollingDirection( PanGestureDetector::DIRECTION_HORIZONTAL, Degree( 40.0f ) );
207 mScrollView.SetAxisAutoLock( true );
208 mScrollView.ScrollStartedSignal().Connect( this, &TextSelectionToolbar::OnScrollStarted );
209 mScrollView.ScrollCompletedSignal().Connect( this, &TextSelectionToolbar::OnScrollCompleted );
210 mScrollView.SetProperty( Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX ); // In a new layer, so clip to scroll-view's bounding box
212 mRulerX = new DefaultRuler(); // IntrusivePtr which is unreferenced when ScrollView is destroyed.
214 RulerPtr rulerY = new DefaultRuler(); // IntrusivePtr which is unreferenced when ScrollView is destroyed.
216 mScrollView.SetRulerY( rulerY );
218 mScrollView.SetOvershootEnabled( true );
221 void TextSelectionToolbar::SetUp()
225 self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
227 // Create Layer to house the toolbar.
228 mToolbarLayer = Layer::New();
229 mToolbarLayer.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
230 mToolbarLayer.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
231 mToolbarLayer.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
235 mScrollView = Toolkit::ScrollView::New();
239 // Toolbar must start with at least one option, adding further options with increase it's size
240 mTableOfButtons = Dali::Toolkit::TableView::New( 1, 1 );
241 mTableOfButtons.SetFitHeight( 0 );
242 mTableOfButtons.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER_LEFT );
243 mTableOfButtons.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER_LEFT );
245 mScrollView.Add( mTableOfButtons );
246 mToolbarLayer.Add( mScrollView );
248 self.Add( mToolbarLayer );
251 void TextSelectionToolbar::SetUpScrollBar( bool enable )
257 Toolkit::ImageView indicator = Toolkit::ImageView::New();
258 indicator.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT );
259 indicator.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT );
260 indicator.SetStyleName( "TextSelectionScrollIndicator" );
262 mScrollBar = Toolkit::ScrollBar::New( Toolkit::ScrollBar::Horizontal );
263 mScrollBar.SetProperty( Dali::Actor::Property::NAME, "Text popup scroll bar" );
264 mScrollBar.SetStyleName( "TextSelectionScrollBar" );
265 mScrollBar.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::BOTTOM_LEFT );
266 mScrollBar.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT );
267 mScrollBar.SetProperty( Actor::Property::POSITION, Vector2( mScrollBarPadding.x, -mScrollBarPadding.y ));
268 mScrollBar.SetResizePolicy( Dali::ResizePolicy::FIT_TO_CHILDREN, Dali::Dimension::WIDTH );
269 mScrollBar.SetProperty( Actor::Property::ORIENTATION, Quaternion( Quaternion( Radian( 1.5f * Math::PI ), Vector3::ZAXIS ) ) );
270 mScrollBar.SetScrollIndicator( indicator );
271 mScrollBar.GetPanGestureDetector().DetachAll();
272 mScrollView.Add( mScrollBar );
277 UnparentAndReset( mScrollBar );
281 void TextSelectionToolbar::OnScrollStarted( const Vector2& position )
283 if( mFirstScrollEnd )
285 mScrollView.SetOvershootEnabled( true );
287 mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, false );
290 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
292 mFirstScrollEnd = true;
293 mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, true );
296 void TextSelectionToolbar::AddOption( Actor& option )
298 mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable ) );
299 mTableOfButtons.SetFitWidth( mIndexInTable );
303 void TextSelectionToolbar::AddDivider( Actor& divider )
305 AddOption( divider );
306 mDividerIndexes.PushBack( mIndexInTable - 1u );
309 void TextSelectionToolbar::ResizeDividers( Size& size )
311 for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
313 Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
314 divider.SetProperty( Actor::Property::SIZE, size );
319 void TextSelectionToolbar::RaiseAbove( Layer target )
321 mToolbarLayer.RaiseAbove( target );
324 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
326 mScrollBarPadding = padding;
329 mScrollBar.SetProperty( Actor::Property::POSITION, Vector2( mScrollBarPadding.x, -mScrollBarPadding.y ));
335 void TextSelectionToolbar::ScrollTo( const Vector2& position )
337 mFirstScrollEnd = false;
338 mScrollView.SetOvershootEnabled( false );
339 mScrollView.ScrollTo( position, 0.f );
342 void TextSelectionToolbar::ConfigureScrollview( const Property::Map& properties )
344 // Set any properties specified for the label by iterating through all property key-value pairs.
345 for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
347 const StringValuePair& propertyPair( properties.GetPair( i ) );
349 // Convert the property string to a property index.
350 Property::Index setPropertyIndex = mScrollView.GetPropertyIndex( propertyPair.first );
351 if( setPropertyIndex != Property::INVALID_INDEX )
353 // Convert the string representation of a color into a Vector4
354 if( setPropertyIndex == Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR )
357 if( ConvertPropertyToColor( propertyPair.second, color ) )
359 mScrollView.SetOvershootEffectColor( color );
364 // If the conversion worked, we have a valid property index,
365 // Set the property to the new value.
366 mScrollView.SetProperty( setPropertyIndex, propertyPair.second );
374 const Vector2& TextSelectionToolbar::GetScrollBarPadding() const
376 return mScrollBarPadding;
379 TextSelectionToolbar::TextSelectionToolbar()
380 : Control( ControlBehaviour( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ) ),
382 mScrollBarPadding( DEFAULT_SCROLL_BAR_PADDING ),
385 mFirstScrollEnd( false )
389 TextSelectionToolbar::~TextSelectionToolbar()
394 } // namespace Internal
396 } // namespace Toolkit