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

   1 /*
   2  * Copyright (c) 2017 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
 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.SetAnchorPoint( AnchorPoint::CENTER );
 231   mToolbarLayer.SetParentOrigin( 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.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 243   mTableOfButtons.SetAnchorPoint( 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.SetParentOrigin( ParentOrigin::TOP_LEFT );
 259       indicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 260       indicator.SetStyleName( "TextSelectionScrollIndicator" );
 261
 262       mScrollBar = Toolkit::ScrollBar::New( Toolkit::ScrollBar::Horizontal );
 263       mScrollBar.SetName( "Text popup scroll bar" );
 264       mScrollBar.SetStyleName( "TextSelectionScrollBar" );
 265       mScrollBar.SetParentOrigin( ParentOrigin::BOTTOM_LEFT );
 266       mScrollBar.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 267       mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 268       mScrollBar.SetResizePolicy( Dali::ResizePolicy::FIT_TO_CHILDREN, Dali::Dimension::WIDTH );
 269       mScrollBar.SetOrientation( 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   mTableOfButtons.SetSensitive( false );
 284 }
 285
 286 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
 287 {
 288   mTableOfButtons.SetSensitive( true );
 289 }
 290
 291 void TextSelectionToolbar::AddOption( Actor& option )
 292 {
 293   mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable )  );
 294   mTableOfButtons.SetFitWidth( mIndexInTable );
 295   mIndexInTable++;
 296 }
 297
 298 void TextSelectionToolbar::AddDivider( Actor& divider )
 299 {
 300   AddOption( divider );
 301   mDividerIndexes.PushBack( mIndexInTable - 1u );
 302 }
 303
 304 void TextSelectionToolbar::ResizeDividers( Size& size )
 305 {
 306   for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
 307   {
 308     Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
 309     divider.SetSize( size );
 310   }
 311   RelayoutRequest();
 312 }
 313
 314 void TextSelectionToolbar::RaiseAbove( Layer target )
 315 {
 316   mToolbarLayer.RaiseAbove( target );
 317 }
 318
 319 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
 320 {
 321   mScrollBarPadding = padding;
 322   if( mScrollBar )
 323   {
 324     mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 325   }
 326
 327   RelayoutRequest();
 328 }
 329
 330 void TextSelectionToolbar::ConfigureScrollview( const Property::Map& properties )
 331 {
 332   // Set any properties specified for the label by iterating through all property key-value pairs.
 333   for( unsigned int i = 0, mapCount = properties.Count(); i < mapCount; ++i )
 334   {
 335     const StringValuePair& propertyPair( properties.GetPair( i ) );
 336
 337     // Convert the property string to a property index.
 338     Property::Index setPropertyIndex = mScrollView.GetPropertyIndex( propertyPair.first );
 339     if( setPropertyIndex != Property::INVALID_INDEX )
 340     {
 341       // Convert the string representation of a color into a Vector4
 342       if( setPropertyIndex == Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR )
 343       {
 344         Vector4 color;
 345         if( ConvertPropertyToColor( propertyPair.second, color ) )
 346         {
 347           mScrollView.SetOvershootEffectColor( color );
 348         }
 349       }
 350       else
 351       {
 352         // If the conversion worked, we have a valid property index,
 353         // Set the property to the new value.
 354         mScrollView.SetProperty( setPropertyIndex, propertyPair.second );
 355       }
 356     }
 357   }
 358
 359   RelayoutRequest();
 360 }
 361
 362 const Vector2& TextSelectionToolbar::GetScrollBarPadding() const
 363 {
 364   return mScrollBarPadding;
 365 }
 366
 367 TextSelectionToolbar::TextSelectionToolbar()
 368 : Control( ControlBehaviour( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ) ),
 369   mMaxSize (),
 370   mScrollBarPadding( DEFAULT_SCROLL_BAR_PADDING ),
 371   mIndexInTable( 0 ),
 372   mDividerIndexes()
 373 {
 374 }
 375
 376 TextSelectionToolbar::~TextSelectionToolbar()
 377 {
 378   mRulerX.Reset();
 379 }
 380
 381 } // namespace Internal
 382
 383 } // namespace Toolkit
 384
 385 } // namespace Dali