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

   1 /*
   2  * Copyright (c) 2016 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
  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.SetSize( Vector2( 0.0f, barWidth ) );
 181   }
 182 }
 183
 184 void TextSelectionToolbar::OnStageConnection( int depth )
 185 {
 186   // Call the Control::OnStageConnection() to set the depth of the background.
 187   Control::OnStageConnection( depth );
 188
 189   // Texts are controls, they have their own OnStageConnection() implementation.
 190   // Icons are inside a TableView. It has it's own OnStageConnection() implementation.
 191 }
 192
 193 void TextSelectionToolbar::SetPopupMaxSize( const Size& maxSize )
 194 {
 195   mMaxSize = maxSize;
 196   if (mScrollView && mToolbarLayer )
 197   {
 198     mScrollView.SetMaximumSize( mMaxSize );
 199     mToolbarLayer.SetMaximumSize( mMaxSize );
 200   }
 201 }
 202
 203 const Dali::Vector2& TextSelectionToolbar::GetPopupMaxSize() const
 204 {
 205   return mMaxSize;
 206 }
 207
 208 void TextSelectionToolbar::SetUpScrollView()
 209 {
 210   mScrollView.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 211   mScrollView.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 212   mScrollView.SetAnchorPoint( AnchorPoint::CENTER_LEFT );
 213
 214   mScrollView.SetScrollingDirection( PanGestureDetector::DIRECTION_HORIZONTAL, Degree( 40.0f ) );
 215   mScrollView.SetAxisAutoLock( true );
 216   mScrollView.ScrollStartedSignal().Connect( this, &TextSelectionToolbar::OnScrollStarted );
 217   mScrollView.ScrollCompletedSignal().Connect( this, &TextSelectionToolbar::OnScrollCompleted );
 218
 219   mRulerX = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 220
 221   RulerPtr rulerY = new DefaultRuler();  // IntrusivePtr which is unreferenced when ScrollView is destroyed.
 222   rulerY->Disable();
 223   mScrollView.SetRulerY( rulerY );
 224
 225   mScrollView.SetOvershootEnabled( true );
 226 }
 227
 228 void TextSelectionToolbar::SetUp()
 229 {
 230   Actor self = Self();
 231
 232   self.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 233
 234   // Create Layer to house the toolbar.
 235   mToolbarLayer = Layer::New();
 236   mToolbarLayer.SetResizePolicy( ResizePolicy::FIT_TO_CHILDREN, Dimension::ALL_DIMENSIONS );
 237   mToolbarLayer.SetAnchorPoint( AnchorPoint::CENTER );
 238   mToolbarLayer.SetParentOrigin( ParentOrigin::CENTER );
 239
 240   if( !mScrollView )
 241   {
 242     mScrollView = Toolkit::ScrollView::New();
 243   }
 244   SetUpScrollView();
 245
 246   // Toolbar must start with at least one option, adding further options with increase it's size
 247   mTableOfButtons = Dali::Toolkit::TableView::New( 1, 1 );
 248   mTableOfButtons.SetFitHeight( 0 );
 249   mTableOfButtons.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 250   mTableOfButtons.SetAnchorPoint( AnchorPoint::CENTER_LEFT );
 251
 252   mScrollView.Add( mTableOfButtons );
 253   mToolbarLayer.Add( mScrollView );
 254
 255   self.Add( mToolbarLayer );
 256 }
 257
 258 void TextSelectionToolbar::SetUpScrollBar( bool enable )
 259 {
 260   if( enable )
 261   {
 262     if( ! mScrollBar )
 263     {
 264       Toolkit::ImageView indicator = Toolkit::ImageView::New();
 265       indicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
 266       indicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 267       indicator.SetStyleName( "TextSelectionScrollIndicator" );
 268
 269       mScrollBar = Toolkit::ScrollBar::New( Toolkit::ScrollBar::Horizontal );
 270       mScrollBar.SetName( "Text popup scroll bar" );
 271       mScrollBar.SetStyleName( "TextSelectionScrollBar" );
 272       mScrollBar.SetParentOrigin( ParentOrigin::BOTTOM_LEFT );
 273       mScrollBar.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 274       mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 275       mScrollBar.SetResizePolicy( Dali::ResizePolicy::FIT_TO_CHILDREN, Dali::Dimension::WIDTH );
 276       mScrollBar.SetOrientation( Quaternion( Radian( 1.5f * Math::PI ), Vector3::ZAXIS ) );
 277       mScrollBar.SetScrollIndicator( indicator );
 278       mScrollBar.GetPanGestureDetector().DetachAll();
 279       mScrollView.Add( mScrollBar );
 280     }
 281   }
 282   else
 283   {
 284     UnparentAndReset( mScrollBar );
 285   }
 286 }
 287
 288 void TextSelectionToolbar::OnScrollStarted( const Vector2& position )
 289 {
 290   mTableOfButtons.SetSensitive( false );
 291 }
 292
 293 void TextSelectionToolbar::OnScrollCompleted( const Vector2& position )
 294 {
 295   mTableOfButtons.SetSensitive( true );
 296 }
 297
 298 void TextSelectionToolbar::AddOption( Actor& option )
 299 {
 300   mTableOfButtons.AddChild( option, Toolkit::TableView::CellPosition( 0, mIndexInTable )  );
 301   mTableOfButtons.SetFitWidth( mIndexInTable );
 302   mIndexInTable++;
 303 }
 304
 305 void TextSelectionToolbar::AddDivider( Actor& divider )
 306 {
 307   AddOption( divider );
 308   mDividerIndexes.PushBack( mIndexInTable - 1u );
 309 }
 310
 311 void TextSelectionToolbar::ResizeDividers( Size& size )
 312 {
 313   for( unsigned int i = 0; i < mDividerIndexes.Count(); ++i )
 314   {
 315     Actor divider = mTableOfButtons.GetChildAt( Toolkit::TableView::CellPosition( 0, mDividerIndexes[ i ] ) );
 316     divider.SetSize( size );
 317   }
 318   RelayoutRequest();
 319 }
 320
 321 void TextSelectionToolbar::RaiseAbove( Layer target )
 322 {
 323   mToolbarLayer.RaiseAbove( target );
 324 }
 325
 326 void TextSelectionToolbar::ScrollTo( const Vector2& position )
 327 {
 328   mScrollView.ScrollTo( position, 0.f );
 329 }
 330
 331 void TextSelectionToolbar::SetScrollBarPadding( const Vector2& padding )
 332 {
 333   mScrollBarPadding = padding;
 334   if( mScrollBar )
 335   {
 336     mScrollBar.SetPosition( mScrollBarPadding.x, -mScrollBarPadding.y );
 337   }
 338
 339   RelayoutRequest();
 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       // If the conversion worked, we have a valid property index,
 354       // Set the property to the new value.
 355       mScrollView.SetProperty( setPropertyIndex, propertyPair.second );
 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