dali-toolkit/internal/controls/text-controls/text-selection-toolbar-impl.cpp

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/controls/text-controls/text-selection-toolbar-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <cfloat>
  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>
  27
  28 // INTERNAL INCLUDES
  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
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace
  43 {
  44
  45 const Dali::Vector2 DEFAULT_SCROLL_BAR_PADDING( 8.0f, 6.0f );
  46
  47 BaseHandle Create()
  48 {
  49   return Toolkit::TextSelectionToolbar::New();
  50 }
  51
  52 // Setup properties, signals and actions using the type-registry.
  53
  54 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextSelectionToolbar, Toolkit::Control, Create );
  55
  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 )
  61
  62 DALI_TYPE_REGISTRATION_END()
  63
  64 } // namespace
  65
  66 Dali::Toolkit::TextSelectionToolbar TextSelectionToolbar::New()
  67 {
  68   // Create the implementation, temporarily owned by this handle on stack
  69   IntrusivePtr< TextSelectionToolbar > impl = new TextSelectionToolbar();
  70
  71   // Pass ownership to CustomActor handle
  72   Dali::Toolkit::TextSelectionToolbar handle( *impl );
  73
  74   // Second-phase init of the implementation
  75   // This can only be done after the CustomActor connection has been made...
  76   impl->Initialize();
  77
  78   return handle;
  79 }
  80
  81 void TextSelectionToolbar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
  82 {
  83   Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
  84
  85   if( selectionPopup )
  86   {
  87     TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
  88
  89     switch( index )
  90     {
  91       case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
  92       {
  93        impl.SetPopupMaxSize( value.Get< Vector2 >() );
  94        break;
  95       }
  96       case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
  97       {
  98         if( !impl.mScrollView )
  99         {
 100           impl.mScrollView  = Toolkit::ScrollView::New();
 101         }
 102         impl.mScrollView.SetOvershootEnabled( value.Get< bool >() );
 103         break;
 104       }
 105       case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
 106       {
 107         impl.SetUpScrollBar( value.Get< bool >() );
 108         break;
 109       }
 110       case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
 111       {
 112         impl.SetScrollBarPadding( value.Get< Vector2 >() );
 113         break;
 114       }
 115       case Toolkit::TextSelectionToolbar::Property::SCROLL_VIEW:
 116       {
 117         // Get a Property::Map from the property if possible.
 118         Property::Map setPropertyMap;
 119         if( value.Get( setPropertyMap ) )
 120         {
 121           impl.ConfigureScrollview( setPropertyMap );
 122         }
 123         break;
 124       }
 125     } // switch
 126   } // TextSelectionToolbar
 127 }
 128
 129 Property::Value TextSelectionToolbar::GetProperty( BaseObject* object, Property::Index index )
 130 {
 131   Property::Value value;
 132
 133   Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
 134
 135   if( selectionPopup )
 136   {
 137     TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
 138
 139     switch( index )
 140     {
 141       case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
 142       {
 143         value = impl.GetPopupMaxSize();
 144         break;
 145       }
 146       case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
 147       {
 148         value = impl.mScrollView.IsOvershootEnabled();
 149         break;
 150       }
 151       case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
 152       {
 153         value = impl.mScrollBar ? true : false;
 154         break;
 155       }
 156       case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
 157       {
 158         value = impl.GetScrollBarPadding();
 159         break;
 160       }
 161     } // switch
 162   }
 163   return value;
 164 }
 165
 166 void TextSelectionToolbar::OnInitialize()
 167 {
 168   SetUp();
 169 }
 170
 171 void TextSelectionToolbar::OnRelayout( const Vector2& size, RelayoutContainer& container )
 172 {
 173   float width = std::max ( mTableOfButtons.GetNaturalSize().width, size.width );
 174   mRulerX->SetDomain( RulerDomain( 0.0, width, true ) );
 175   mScrollView.SetRulerX( mRulerX );
 176
 177   if( mScrollBar )
 178   {
 179     float barWidth = std::min( mTableOfButtons.GetNaturalSize().width, size.width ) - 2.f * mScrollBarPadding.x;
 180     mScrollBar.SetProperty( Actor::Property::SIZE, Vector2( 0.0f, barWidth ) );
 181   }
 182 }
 183
 184 void TextSelectionToolbar::SetPopupMaxSize( const Size& maxSize )
 185 {
 186   mMaxSize = maxSize;
 187   if (mScrollView && mToolbarLayer )
 188   {
 189     mScrollView.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
 190     mToolbarLayer.SetProperty( Actor::Property::MAXIMUM_SIZE, mMaxSize );
 191   }
 192 }
 193
 194 const Dali::Vector2& TextSelectionToolbar::GetPopupMaxSize() const
 195 {
 196   return mMaxSize;
 197 }
 198
 199 void TextSelectionToolbar::SetUpScrollView()
 200 {
 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 );
 205
 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
 211
 212   mRulerX = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 213
 214   RulerPtr rulerY = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 215   rulerY->Disable();
 216   mScrollView.SetRulerY( rulerY );
 217
 218   mScrollView.SetOvershootEnabled( true );
 219 }
 220
 221 void TextSelectionToolbar::SetUp()
 222 {
 223   Actor self = Self();
 224
 225   self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 226
 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 );
 232
 233   if( !mScrollView )
 234   {
 235     mScrollView = Toolkit::ScrollView::New();
 236   }
 237   SetUpScrollView();
 238
 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 );
 244
 245   mScrollView.Add( mTableOfButtons );
 246   mToolbarLayer.Add( mScrollView );
 247
 248   self.Add( mToolbarLayer );
 249 }
 250
 251 void TextSelectionToolbar::SetUpScrollBar( bool enable )
 252 {
 253   if( enable )
 254   {
 255     if( ! mScrollBar )
 256     {
 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" );
 261
 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 );
 273     }
 274   }
 275   else
 276   {
 277     UnparentAndReset( mScrollBar );
 278   }
 279 }
 280
 281 void TextSelectionToolbar::OnScrollStarted( const Vector2& position )
 282 {
 283   if( mFirstScrollEnd )
 284   {
 285     mScrollView.SetOvershootEnabled( true );
 286   }
 287   mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, false );
 288 }
 289
 290 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
 291 {
 292   mFirstScrollEnd = true;
 293   mTableOfButtons.SetProperty( Actor::Property::SENSITIVE, true );
 294 }
 295
 296 void TextSelectionToolbar::AddOption( Actor& option )
 297 {
 298   mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable )  );
 299   mTableOfButtons.SetFitWidth( mIndexInTable );
 300   mIndexInTable++;
 301 }
 302
 303 void TextSelectionToolbar::AddDivider( Actor& divider )
 304 {
 305   AddOption( divider );
 306   mDividerIndexes.PushBack( mIndexInTable - 1u );
 307 }
 308
 309 void TextSelectionToolbar::ResizeDividers( Size& size )
 310 {
 311   for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
 312   {
 313     Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
 314     divider.SetProperty( Actor::Property::SIZE, size );
 315   }
 316   RelayoutRequest();
 317 }
 318
 319 void TextSelectionToolbar::RaiseAbove( Layer target )
 320 {
 321   mToolbarLayer.RaiseAbove( target );
 322 }
 323
 324 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
 325 {
 326   mScrollBarPadding = padding;
 327   if( mScrollBar )
 328   {
 329     mScrollBar.SetProperty( Actor::Property::POSITION, Vector2( mScrollBarPadding.x, -mScrollBarPadding.y ));
 330   }
 331
 332   RelayoutRequest();
 333 }
 334
 335 void TextSelectionToolbar::ScrollTo( const Vector2& position )
 336 {
 337   mFirstScrollEnd = false;
 338   mScrollView.SetOvershootEnabled( false );
 339   mScrollView.ScrollTo( position, 0.f );
 340 }
 341
 342 void TextSelectionToolbar::ConfigureScrollview( const Property::Map& properties )
 343 {
 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 )
 346   {
 347     const StringValuePair& propertyPair( properties.GetPair( i ) );
 348
 349     // Convert the property string to a property index.
 350     Property::Index setPropertyIndex = mScrollView.GetPropertyIndex( propertyPair.first );
 351     if( setPropertyIndex != Property::INVALID_INDEX )
 352     {
 353       // Convert the string representation of a color into a Vector4
 354       if( setPropertyIndex == Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR )
 355       {
 356         Vector4 color;
 357         if( ConvertPropertyToColor( propertyPair.second, color ) )
 358         {
 359           mScrollView.SetOvershootEffectColor( color );
 360         }
 361       }
 362       else
 363       {
 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 );
 367       }
 368     }
 369   }
 370
 371   RelayoutRequest();
 372 }
 373
 374 const Vector2& TextSelectionToolbar::GetScrollBarPadding() const
 375 {
 376   return mScrollBarPadding;
 377 }
 378
 379 TextSelectionToolbar::TextSelectionToolbar()
 380 : Control( ControlBehaviour( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ) ),
 381   mMaxSize (),
 382   mScrollBarPadding( DEFAULT_SCROLL_BAR_PADDING ),
 383   mIndexInTable( 0 ),
 384   mDividerIndexes(),
 385   mFirstScrollEnd( false )
 386 {
 387 }
 388
 389 TextSelectionToolbar::~TextSelectionToolbar()
 390 {
 391   mRulerX.Reset();
 392 }
 393
 394 } // namespace Internal
 395
 396 } // namespace Toolkit
 397
 398 } // namespace Dali