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

   1 /*
   2  * Copyright (c) 2018 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/images/buffer-image.h>
  24 #include <dali/public-api/math/vector2.h>
  25 #include <dali/public-api/math/vector4.h>
  26 #include <dali/public-api/object/property-map.h>
  27 #include <dali/public-api/object/type-registry-helper.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  31 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  32 #include <dali-toolkit/internal/helpers/color-conversion.h>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Internal
  41 {
  42
  43 namespace
  44 {
  45
  46 const Dali::Vector2 DEFAULT_SCROLL_BAR_PADDING( 8.0f, 6.0f );
  47
  48 BaseHandle Create()
  49 {
  50   return Toolkit::TextSelectionToolbar::New();
  51 }
  52
  53 // Setup properties, signals and actions using the type-registry.
  54
  55 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::TextSelectionToolbar, Toolkit::Control, Create );
  56
  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 )
  62
  63 DALI_TYPE_REGISTRATION_END()
  64
  65 } // namespace
  66
  67 Dali::Toolkit::TextSelectionToolbar TextSelectionToolbar::New()
  68 {
  69   // Create the implementation, temporarily owned by this handle on stack
  70   IntrusivePtr< TextSelectionToolbar > impl = new TextSelectionToolbar();
  71
  72   // Pass ownership to CustomActor handle
  73   Dali::Toolkit::TextSelectionToolbar handle( *impl );
  74
  75   // Second-phase init of the implementation
  76   // This can only be done after the CustomActor connection has been made...
  77   impl->Initialize();
  78
  79   return handle;
  80 }
  81
  82 void TextSelectionToolbar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
  83 {
  84   Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
  85
  86   if( selectionPopup )
  87   {
  88     TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
  89
  90     switch( index )
  91     {
  92       case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
  93       {
  94        impl.SetPopupMaxSize( value.Get< Vector2 >() );
  95        break;
  96       }
  97       case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
  98       {
  99         if( !impl.mScrollView )
 100         {
 101           impl.mScrollView  = Toolkit::ScrollView::New();
 102         }
 103         impl.mScrollView.SetOvershootEnabled( value.Get< bool >() );
 104         break;
 105       }
 106       case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
 107       {
 108         impl.SetUpScrollBar( value.Get< bool >() );
 109         break;
 110       }
 111       case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
 112       {
 113         impl.SetScrollBarPadding( value.Get< Vector2 >() );
 114         break;
 115       }
 116       case Toolkit::TextSelectionToolbar::Property::SCROLL_VIEW:
 117       {
 118         // Get a Property::Map from the property if possible.
 119         Property::Map setPropertyMap;
 120         if( value.Get( setPropertyMap ) )
 121         {
 122           impl.ConfigureScrollview( setPropertyMap );
 123         }
 124         break;
 125       }
 126     } // switch
 127   } // TextSelectionToolbar
 128 }
 129
 130 Property::Value TextSelectionToolbar::GetProperty( BaseObject* object, Property::Index index )
 131 {
 132   Property::Value value;
 133
 134   Toolkit::TextSelectionToolbar selectionPopup = Toolkit::TextSelectionToolbar::DownCast( Dali::BaseHandle( object ) );
 135
 136   if( selectionPopup )
 137   {
 138     TextSelectionToolbar& impl( GetImpl( selectionPopup ) );
 139
 140     switch( index )
 141     {
 142       case Toolkit::TextSelectionToolbar::Property::MAX_SIZE:
 143       {
 144         value = impl.GetPopupMaxSize();
 145         break;
 146       }
 147       case Toolkit::TextSelectionToolbar::Property::ENABLE_OVERSHOOT:
 148       {
 149         value = impl.mScrollView.IsOvershootEnabled();
 150         break;
 151       }
 152       case Toolkit::TextSelectionToolbar::Property::ENABLE_SCROLL_BAR:
 153       {
 154         value = impl.mScrollBar ? true : false;
 155         break;
 156       }
 157       case Toolkit::TextSelectionToolbar::Property::SCROLL_BAR_PADDING:
 158       {
 159         value = impl.GetScrollBarPadding();
 160         break;
 161       }
 162     } // switch
 163   }
 164   return value;
 165 }
 166
 167 void TextSelectionToolbar::OnInitialize()
 168 {
 169   SetUp();
 170 }
 171
 172 void TextSelectionToolbar::OnRelayout( const Vector2& size, RelayoutContainer& container )
 173 {
 174   float width = std::max ( mTableOfButtons.GetNaturalSize().width, size.width );
 175   mRulerX->SetDomain( RulerDomain( 0.0, width, true ) );
 176   mScrollView.SetRulerX( mRulerX );
 177
 178   if( mScrollBar )
 179   {
 180     float barWidth = std::min( mTableOfButtons.GetNaturalSize().width, size.width ) - 2.f * mScrollBarPadding.x;
 181     mScrollBar.SetSize( Vector2( 0.0f, barWidth ) );
 182   }
 183 }
 184
 185 void TextSelectionToolbar::SetPopupMaxSize( const Size& maxSize )
 186 {
 187   mMaxSize = maxSize;
 188   if (mScrollView && mToolbarLayer )
 189   {
 190     mScrollView.SetMaximumSize( mMaxSize );
 191     mToolbarLayer.SetMaximumSize( mMaxSize );
 192   }
 193 }
 194
 195 const Dali::Vector2& TextSelectionToolbar::GetPopupMaxSize() const
 196 {
 197   return mMaxSize;
 198 }
 199
 200 void TextSelectionToolbar::SetUpScrollView()
 201 {
 202   mScrollView.SetName("TextSelectionScrollView");
 203   mScrollView.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 204   mScrollView.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 205   mScrollView.SetAnchorPoint( AnchorPoint::CENTER_LEFT );
 206
 207   mScrollView.SetScrollingDirection( PanGestureDetector::DIRECTION_HORIZONTAL, Degree( 40.0f ) );
 208   mScrollView.SetAxisAutoLock( true );
 209   mScrollView.ScrollStartedSignal().Connect( this, &TextSelectionToolbar::OnScrollStarted );
 210   mScrollView.ScrollCompletedSignal().Connect( this, &TextSelectionToolbar::OnScrollCompleted );
 211   mScrollView.SetProperty( Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX ); // In a new layer, so clip to scroll-view's bounding box
 212
 213   mRulerX = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 214
 215   RulerPtr rulerY = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 216   rulerY->Disable();
 217   mScrollView.SetRulerY( rulerY );
 218
 219   mScrollView.SetOvershootEnabled( true );
 220 }
 221
 222 void TextSelectionToolbar::SetUp()
 223 {
 224   Actor self = Self();
 225
 226   self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 227
 228   // Create Layer to house the toolbar.
 229   mToolbarLayer = Layer::New();
 230   mToolbarLayer.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 231   mToolbarLayer.SetAnchorPoint( AnchorPoint::CENTER );
 232   mToolbarLayer.SetParentOrigin( ParentOrigin::CENTER );
 233
 234   if( !mScrollView )
 235   {
 236     mScrollView = Toolkit::ScrollView::New();
 237   }
 238   SetUpScrollView();
 239
 240   // Toolbar must start with at least one option, adding further options with increase it's size
 241   mTableOfButtons = Dali::Toolkit::TableView::New( 1, 1 );
 242   mTableOfButtons.SetFitHeight( 0 );
 243   mTableOfButtons.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 244   mTableOfButtons.SetAnchorPoint( AnchorPoint::CENTER_LEFT );
 245
 246   mScrollView.Add( mTableOfButtons );
 247   mToolbarLayer.Add( mScrollView );
 248
 249   self.Add( mToolbarLayer );
 250 }
 251
 252 void TextSelectionToolbar::SetUpScrollBar( bool enable )
 253 {
 254   if( enable )
 255   {
 256     if( ! mScrollBar )
 257     {
 258       Toolkit::ImageView indicator = Toolkit::ImageView::New();
 259       indicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
 260       indicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 261       indicator.SetStyleName( "TextSelectionScrollIndicator" );
 262
 263       mScrollBar = Toolkit::ScrollBar::New( Toolkit::ScrollBar::Horizontal );
 264       mScrollBar.SetName( "Text popup scroll bar" );
 265       mScrollBar.SetStyleName( "TextSelectionScrollBar" );
 266       mScrollBar.SetParentOrigin( ParentOrigin::BOTTOM_LEFT );
 267       mScrollBar.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 268       mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 269       mScrollBar.SetResizePolicy( Dali::ResizePolicy::FIT_TO_CHILDREN, Dali::Dimension::WIDTH );
 270       mScrollBar.SetOrientation( Quaternion( Radian( 1.5f * Math::PI ), Vector3::ZAXIS ) );
 271       mScrollBar.SetScrollIndicator( indicator );
 272       mScrollBar.GetPanGestureDetector().DetachAll();
 273       mScrollView.Add( mScrollBar );
 274     }
 275   }
 276   else
 277   {
 278     UnparentAndReset( mScrollBar );
 279   }
 280 }
 281
 282 void TextSelectionToolbar::OnScrollStarted( const Vector2& position )
 283 {
 284   if( mFirstScrollEnd )
 285   {
 286     mScrollView.SetOvershootEnabled( true );
 287   }
 288   mTableOfButtons.SetSensitive( false );
 289 }
 290
 291 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
 292 {
 293   mFirstScrollEnd = true;
 294   mTableOfButtons.SetSensitive( true );
 295 }
 296
 297 void TextSelectionToolbar::AddOption( Actor& option )
 298 {
 299   mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable )  );
 300   mTableOfButtons.SetFitWidth( mIndexInTable );
 301   mIndexInTable++;
 302 }
 303
 304 void TextSelectionToolbar::AddDivider( Actor& divider )
 305 {
 306   AddOption( divider );
 307   mDividerIndexes.PushBack( mIndexInTable - 1u );
 308 }
 309
 310 void TextSelectionToolbar::ResizeDividers( Size& size )
 311 {
 312   for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
 313   {
 314     Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
 315     divider.SetSize( size );
 316   }
 317   RelayoutRequest();
 318 }
 319
 320 void TextSelectionToolbar::RaiseAbove( Layer target )
 321 {
 322   mToolbarLayer.RaiseAbove( target );
 323 }
 324
 325 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
 326 {
 327   mScrollBarPadding = padding;
 328   if( mScrollBar )
 329   {
 330     mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 331   }
 332
 333   RelayoutRequest();
 334 }
 335
 336 void TextSelectionToolbar::ScrollTo( const Vector2& position )
 337 {
 338   mFirstScrollEnd = false;
 339   mScrollView.SetOvershootEnabled( false );
 340   mScrollView.ScrollTo( position, 0.f );
 341 }
 342
 343 void TextSelectionToolbar::ConfigureScrollview( const Property::Map& properties )
 344 {
 345   // Set any properties specified for the label by iterating through all property key-value pairs.
 346   for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
 347   {
 348     const StringValuePair& propertyPair( properties.GetPair( i ) );
 349
 350     // Convert the property string to a property index.
 351     Property::Index setPropertyIndex = mScrollView.GetPropertyIndex( propertyPair.first );
 352     if( setPropertyIndex != Property::INVALID_INDEX )
 353     {
 354       // Convert the string representation of a color into a Vector4
 355       if( setPropertyIndex == Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR )
 356       {
 357         Vector4 color;
 358         if( ConvertPropertyToColor( propertyPair.second, color ) )
 359         {
 360           mScrollView.SetOvershootEffectColor( color );
 361         }
 362       }
 363       else
 364       {
 365         // If the conversion worked, we have a valid property index,
 366         // Set the property to the new value.
 367         mScrollView.SetProperty( setPropertyIndex, propertyPair.second );
 368       }
 369     }
 370   }
 371
 372   RelayoutRequest();
 373 }
 374
 375 const Vector2& TextSelectionToolbar::GetScrollBarPadding() const
 376 {
 377   return mScrollBarPadding;
 378 }
 379
 380 TextSelectionToolbar::TextSelectionToolbar()
 381 : Control( ControlBehaviour( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ) ),
 382   mMaxSize (),
 383   mScrollBarPadding( DEFAULT_SCROLL_BAR_PADDING ),
 384   mIndexInTable( 0 ),
 385   mDividerIndexes(),
 386   mFirstScrollEnd( false )
 387 {
 388 }
 389
 390 TextSelectionToolbar::~TextSelectionToolbar()
 391 {
 392   mRulerX.Reset();
 393 }
 394
 395 } // namespace Internal
 396
 397 } // namespace Toolkit
 398
 399 } // namespace Dali