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>
32 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
46 const Dali::Vector2 DEFAULT_SCROLL_BAR_PADDING( 8.0f, 6.0f );
50 return Toolkit::TextSelectionToolbar::New();
53 // Setup properties, signals and actions using the type-registry.
55 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextSelectionToolbar, Toolkit::Control, Create );
57 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "maxSize", VECTOR2, MAX_SIZE )
58 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "enableOvershoot", BOOLEAN, ENABLE_OVERSHOOT )
59 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "enableScrollBar", BOOLEAN, ENABLE_SCROLL_BAR )
60 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "scrollBarPadding", VECTOR2, SCROLL_BAR_PADDING )
61 DALI_PROPERTY_REGISTRATION( Toolkit, TextSelectionToolbar, "scrollView", MAP, SCROLL_VIEW )
63 DALI_TYPE_REGISTRATION_END()
67 Dali::Toolkit::TextSelectionToolbar TextSelectionToolbar::New()
69 // Create the implementation, temporarily owned by this handle on stack
70 IntrusivePtr< TextSelectionToolbar > impl = new TextSelectionToolbar();
72 // Pass ownership to CustomActor handle
73 Dali::Toolkit::TextSelectionToolbar handle( *impl );
75 // Second-phase init of the implementation
76 // This can only be done after the CustomActor connection has been made...
82 void TextSelectionToolbar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
84 Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
88 TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
92 case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
94 impl.SetPopupMaxSize( value.Get< Vector2 >() );
97 case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
99 if( !impl.mScrollView )
101 impl.mScrollView = Toolkit::ScrollView::New();
103 impl.mScrollView.SetOvershootEnabled( value.Get< bool >() );
106 case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
108 impl.SetUpScrollBar( value.Get< bool >() );
111 case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
113 impl.SetScrollBarPadding( value.Get< Vector2 >() );
116 case Toolkit::TextSelectionToolbar::Property::SCROLL_VIEW:
118 // Get a Property::Map from the property if possible.
119 Property::Map setPropertyMap;
120 if( value.Get( setPropertyMap ) )
122 impl.ConfigureScrollview( setPropertyMap );
127 } // TextSelectionToolbar
130 Property::Value TextSelectionToolbar::GetProperty( BaseObject* object, Property::Index index )
132 Property::Value value;
134 Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
138 TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
142 case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
144 value = impl.GetPopupMaxSize();
147 case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
149 value = impl.mScrollView.IsOvershootEnabled();
152 case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
154 value = impl.mScrollBar ? true : false;
157 case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
159 value = impl.GetScrollBarPadding();
167 void TextSelectionToolbar::OnInitialize()
171 DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
172 return std::unique_ptr< Dali::Accessibility::Accessible >(
173 new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::TOOL_BAR ));
177 void TextSelectionToolbar::OnRelayout( const Vector2& size, RelayoutContainer& container )
179 float width = std::max ( mTableOfButtons.GetNaturalSize().width, size.width );
180 mRulerX->SetDomain( RulerDomain( 0.0, width, true ) );
181 mScrollView.SetRulerX( mRulerX );
185 float barWidth = std::min( mTableOfButtons.GetNaturalSize().width, size.width ) - 2.f * mScrollBarPadding.x;
186 mScrollBar.SetProperty( Actor::Property::SIZE, Vector2( 0.0f, barWidth ) );
190 void TextSelectionToolbar::SetPopupMaxSize( const Size& maxSize )
193 if( mScrollView && mToolbarActor )
195 mScrollView.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
196 mToolbarActor.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
200 const Dali::Vector2& TextSelectionToolbar::GetPopupMaxSize() const
205 void TextSelectionToolbar::SetUpScrollView()
207 mScrollView.SetProperty( Dali::Actor::Property::NAME,"TextSelectionScrollView");
208 mScrollView.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
209 mScrollView.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER_LEFT );
210 mScrollView.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER_LEFT );
212 mScrollView.SetScrollingDirection( PanGestureDetector::DIRECTION_HORIZONTAL, Degree( 40.0f ) );
213 mScrollView.SetAxisAutoLock( true );
214 mScrollView.ScrollStartedSignal().Connect( this, &TextSelectionToolbar::OnScrollStarted );
215 mScrollView.ScrollCompletedSignal().Connect( this, &TextSelectionToolbar::OnScrollCompleted );
216 mScrollView.SetProperty( Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX ); // In a new layer, so clip to scroll-view's bounding box
218 mRulerX = new DefaultRuler(); // IntrusivePtr which is unreferenced when ScrollView is destroyed.
220 RulerPtr rulerY = new DefaultRuler(); // IntrusivePtr which is unreferenced when ScrollView is destroyed.
222 mScrollView.SetRulerY( rulerY );
224 mScrollView.SetOvershootEnabled( true );
227 void TextSelectionToolbar::SetUp()
231 self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
233 // Create Actor to house the toolbar.
234 mToolbarActor = Actor::New();
235 mToolbarActor.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
236 mToolbarActor.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
237 mToolbarActor.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
241 mScrollView = Toolkit::ScrollView::New();
245 // Toolbar must start with at least one option, adding further options with increase it's size
246 mTableOfButtons = Dali::Toolkit::TableView::New( 1, 1 );
247 mTableOfButtons.SetFitHeight( 0 );
248 mTableOfButtons.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER_LEFT );
249 mTableOfButtons.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER_LEFT );
251 mScrollView.Add( mTableOfButtons );
252 mToolbarActor.Add( mScrollView );
254 self.Add( mToolbarActor );
257 void TextSelectionToolbar::SetUpScrollBar( bool enable )
263 Toolkit::ImageView indicator = Toolkit::ImageView::New();
264 indicator.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT );
265 indicator.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT );
266 indicator.SetStyleName( "TextSelectionScrollIndicator" );
268 mScrollBar = Toolkit::ScrollBar::New( Toolkit::ScrollBar::HORIZONTAL );
269 mScrollBar.SetProperty( Dali::Actor::Property::NAME, "Text popup scroll bar" );
270 mScrollBar.SetStyleName( "TextSelectionScrollBar" );
271 mScrollBar.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::BOTTOM_LEFT );
272 mScrollBar.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT );
273 mScrollBar.SetProperty( Actor::Property::POSITION, Vector2( mScrollBarPadding.x, -mScrollBarPadding.y ));
274 mScrollBar.SetResizePolicy( Dali::ResizePolicy::FIT_TO_CHILDREN, Dali::Dimension::WIDTH );
275 mScrollBar.SetProperty( Actor::Property::ORIENTATION, Quaternion( Quaternion( Radian( 1.5f * Math::PI ), Vector3::ZAXIS ) ) );
276 mScrollBar.SetScrollIndicator( indicator );
277 mScrollBar.GetPanGestureDetector().DetachAll();
278 mScrollView.Add( mScrollBar );
283 UnparentAndReset( mScrollBar );
287 void TextSelectionToolbar::OnScrollStarted( const Vector2& position )
289 if( mFirstScrollEnd )
291 mScrollView.SetOvershootEnabled( true );
293 mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, false );
296 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
298 mFirstScrollEnd = true;
299 mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, true );
302 void TextSelectionToolbar::AddOption( Actor& option )
304 mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable ) );
305 mTableOfButtons.SetFitWidth( mIndexInTable );
309 void TextSelectionToolbar::AddDivider( Actor& divider )
311 AddOption( divider );
312 mDividerIndexes.PushBack( mIndexInTable - 1u );
315 void TextSelectionToolbar::ResizeDividers( Size& size )
317 for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
319 Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
320 divider.SetProperty( Actor::Property::SIZE, size );
325 void TextSelectionToolbar::RaiseAbove( Actor target )
327 mToolbarActor.RaiseAbove( target );
330 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
332 mScrollBarPadding = padding;
335 mScrollBar.SetProperty( Actor::Property::POSITION, Vector2( mScrollBarPadding.x, -mScrollBarPadding.y ));
341 void TextSelectionToolbar::ScrollTo( const Vector2& position )
343 mFirstScrollEnd = false;
344 mScrollView.SetOvershootEnabled( false );
345 mScrollView.ScrollTo( position, 0.f );
348 void TextSelectionToolbar::ConfigureScrollview( const Property::Map& properties )
350 // Set any properties specified for the label by iterating through all property key-value pairs.
351 for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
353 const StringValuePair& propertyPair( properties.GetPair( i ) );
355 // Convert the property string to a property index.
356 Property::Index setPropertyIndex = mScrollView.GetPropertyIndex( propertyPair.first );
357 if( setPropertyIndex != Property::INVALID_INDEX )
359 // Convert the string representation of a color into a Vector4
360 if( setPropertyIndex == Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR )
363 if( ConvertPropertyToColor( propertyPair.second, color ) )
365 mScrollView.SetOvershootEffectColor( color );
370 // If the conversion worked, we have a valid property index,
371 // Set the property to the new value.
372 mScrollView.SetProperty( setPropertyIndex, propertyPair.second );
380 const Vector2& TextSelectionToolbar::GetScrollBarPadding() const
382 return mScrollBarPadding;
385 TextSelectionToolbar::TextSelectionToolbar()
386 : Control( ControlBehaviour( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ) ),
388 mScrollBarPadding( DEFAULT_SCROLL_BAR_PADDING ),
391 mFirstScrollEnd( false )
395 TextSelectionToolbar::~TextSelectionToolbar()
400 } // namespace Internal
402 } // namespace Toolkit