Basic IMF->KeyEvent and scrolling support
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-field-impl.cpp
index d687d51..3bf4e67 100644 (file)
 #include <dali-toolkit/internal/controls/text-controls/text-field-impl.h>
 
 // EXTERNAL INCLUDES
+#include <string>
 #include <dali/public-api/adaptor-framework/key.h>
+#include <dali/public-api/common/stage.h>
 #include <dali/public-api/images/resource-image.h>
 #include <dali/public-api/object/type-registry.h>
 #include <dali/public-api/object/type-registry-helper.h>
-#include <dali/public-api/common/stage.h>
+#include <dali/public-api/scripting/scripting.h>
 #include <dali/integration-api/debug.h>
+#include <dali/public-api/adaptor-framework/virtual-keyboard.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/public-api/text/rendering-backend.h>
 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
 #include <dali-toolkit/internal/text/rendering/text-backend.h>
+#include <dali-toolkit/internal/styling/style-manager-impl.h>
 
 using namespace Dali::Toolkit::Text;
 
-namespace
-{
-
-const unsigned int DEFAULT_RENDERING_BACKEND = 0;
-
-} // namespace
-
-
 namespace Dali
 {
 
@@ -51,6 +48,19 @@ namespace Internal
 
 namespace
 {
+  const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::Text::DEFAULT_RENDERING_BACKEND;
+}
+
+namespace
+{
+
+const Scripting::StringEnum< Toolkit::Text::LayoutEngine::Alignment > ALIGNMENT_STRING_TABLE[] =
+{
+  { "BEGIN",  Toolkit::Text::LayoutEngine::ALIGN_BEGIN  },
+  { "CENTER", Toolkit::Text::LayoutEngine::ALIGN_CENTER },
+  { "END",    Toolkit::Text::LayoutEngine::ALIGN_END    },
+};
+const unsigned int ALIGNMENT_STRING_TABLE_COUNT = sizeof( ALIGNMENT_STRING_TABLE ) / sizeof( ALIGNMENT_STRING_TABLE[0] );
 
 // Type registration
 BaseHandle Create()
@@ -67,7 +77,7 @@ DALI_PROPERTY_REGISTRATION( TextField, "text",                    STRING,    TEX
 DALI_PROPERTY_REGISTRATION( TextField, "font-family",             STRING,    FONT_FAMILY             )
 DALI_PROPERTY_REGISTRATION( TextField, "font-style",              STRING,    FONT_STYLE              )
 DALI_PROPERTY_REGISTRATION( TextField, "point-size",              FLOAT,     POINT_SIZE              )
-DALI_PROPERTY_REGISTRATION( TextField, "cursor-image",            STRING,    CURSOR_IMAGE            )
+DALI_PROPERTY_REGISTRATION( TextField, "exceed-policy",           INTEGER,   EXCEED_POLICY           )
 DALI_PROPERTY_REGISTRATION( TextField, "primary-cursor-color",    VECTOR4,   PRIMARY_CURSOR_COLOR    )
 DALI_PROPERTY_REGISTRATION( TextField, "secondary-cursor-color",  VECTOR4,   SECONDARY_CURSOR_COLOR  )
 DALI_PROPERTY_REGISTRATION( TextField, "enable-cursor-blink",     BOOLEAN,   ENABLE_CURSOR_BLINK     )
@@ -75,6 +85,7 @@ DALI_PROPERTY_REGISTRATION( TextField, "cursor-blink-interval",   FLOAT,     CUR
 DALI_PROPERTY_REGISTRATION( TextField, "cursor-blink-duration",   FLOAT,     CURSOR_BLINK_DURATION   )
 DALI_PROPERTY_REGISTRATION( TextField, "grab-handle-image",       STRING,    GRAB_HANDLE_IMAGE       )
 DALI_PROPERTY_REGISTRATION( TextField, "decoration bounding-box", RECTANGLE, DECORATION_BOUNDING_BOX )
+DALI_PROPERTY_REGISTRATION( TextField, "alignment",               STRING,    ALIGNMENT               )
 
 DALI_TYPE_REGISTRATION_END()
 
@@ -107,7 +118,7 @@ void TextField::SetProperty( BaseObject* object, Property::Index index, const Pr
     {
       case Toolkit::TextField::Property::RENDERING_BACKEND:
       {
-        unsigned int backend = value.Get< unsigned int >();
+        int backend = value.Get< int >();
 
         if( impl.mRenderingBackend != backend )
         {
@@ -132,16 +143,53 @@ void TextField::SetProperty( BaseObject* object, Property::Index index, const Pr
         }
         break;
       }
-      case Toolkit::TextField::Property::CURSOR_IMAGE:
+      case Toolkit::TextField::Property::FONT_FAMILY:
       {
-        ResourceImage image = ResourceImage::New( value.Get< std::string >() );
+        if( impl.mController )
+        {
+          std::string fontFamily = value.Get< std::string >();
 
-        if( impl.mDecorator )
+          if( impl.mController->GetDefaultFontFamily() != fontFamily )
+          {
+            impl.mController->SetDefaultFontFamily( fontFamily );
+            impl.RequestTextRelayout();
+          }
+        }
+        break;
+      }
+      case Toolkit::TextField::Property::FONT_STYLE:
+      {
+        if( impl.mController )
         {
-          impl.mDecorator->SetCursorImage( image );
+          std::string fontStyle = value.Get< std::string >();
+
+          if( impl.mController->GetDefaultFontStyle() != fontStyle )
+          {
+            impl.mController->SetDefaultFontStyle( fontStyle );
+            impl.RequestTextRelayout();
+          }
         }
         break;
       }
+      case Toolkit::TextField::Property::POINT_SIZE:
+      {
+        if( impl.mController )
+        {
+          float pointSize = value.Get< float >();
+
+          if( impl.mController->GetDefaultPointSize() != pointSize /*TODO - epsilon*/ )
+          {
+            impl.mController->SetDefaultPointSize( pointSize );
+            impl.RequestTextRelayout();
+          }
+        }
+        break;
+      }
+      case Toolkit::TextField::Property::EXCEED_POLICY:
+      {
+        impl.mExceedPolicy = value.Get< int >();
+        break;
+      }
       case Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR:
       {
         if( impl.mDecorator )
@@ -162,7 +210,7 @@ void TextField::SetProperty( BaseObject* object, Property::Index index, const Pr
       {
         if( impl.mController )
         {
-          //impl.mController->SetEnableCursorBlink( value.Get< bool >() ); TODO
+          impl.mController->SetEnableCursorBlink( value.Get< bool >() );
         }
         break;
       }
@@ -200,6 +248,20 @@ void TextField::SetProperty( BaseObject* object, Property::Index index, const Pr
         }
         break;
       }
+      case Toolkit::TextField::Property::ALIGNMENT:
+      {
+        LayoutEngine& engine = impl.mController->GetLayoutEngine();
+        const LayoutEngine::Alignment alignment = Scripting::GetEnumeration< Toolkit::Text::LayoutEngine::Alignment >( value.Get< std::string >().c_str(),
+                                                                                                                       ALIGNMENT_STRING_TABLE,
+                                                                                                                       ALIGNMENT_STRING_TABLE_COUNT );
+
+        if( engine.GetAlignment() != alignment )
+        {
+          engine.SetAlignment( alignment );
+          impl.RequestTextRelayout();
+        }
+        break;
+      }
     }
   }
 }
@@ -241,16 +303,9 @@ Property::Value TextField::GetProperty( BaseObject* object, Property::Index inde
         }
         break;
       }
-      case Toolkit::TextField::Property::CURSOR_IMAGE:
+      case Toolkit::TextField::Property::EXCEED_POLICY:
       {
-        if( impl.mDecorator )
-        {
-          ResourceImage image = ResourceImage::DownCast( impl.mDecorator->GetCursorImage() );
-          if( image )
-          {
-            value = image.GetUrl();
-          }
-        }
+        value = impl.mExceedPolicy;
         break;
       }
       case Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR:
@@ -271,7 +326,7 @@ Property::Value TextField::GetProperty( BaseObject* object, Property::Index inde
       }
       case Toolkit::TextField::Property::ENABLE_CURSOR_BLINK:
       {
-        //value = impl.mController->GetEnableCursorBlink(); TODO
+        value = impl.mController->GetEnableCursorBlink();
         break;
       }
       case Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL:
@@ -290,23 +345,21 @@ Property::Value TextField::GetProperty( BaseObject* object, Property::Index inde
         }
         break;
       }
-      case Toolkit::TextField::Property::GRAB_HANDLE_IMAGE:
+      case Toolkit::TextField::Property::DECORATION_BOUNDING_BOX:
       {
         if( impl.mDecorator )
         {
-          ResourceImage image = ResourceImage::DownCast( impl.mDecorator->GetCursorImage() );
-          if( image )
-          {
-            value = image.GetUrl();
-          }
+          value = impl.mDecorator->GetBoundingBox();
         }
         break;
       }
-      case Toolkit::TextField::Property::DECORATION_BOUNDING_BOX:
+      case Toolkit::TextField::Property::ALIGNMENT:
       {
-        if( impl.mDecorator )
+        if( impl.mController )
         {
-          value = impl.mDecorator->GetBoundingBox();
+          value = std::string( Scripting::GetEnumerationName< Toolkit::Text::LayoutEngine::Alignment >( impl.mController->GetLayoutEngine().GetAlignment(),
+                                                                                                        ALIGNMENT_STRING_TABLE,
+                                                                                                        ALIGNMENT_STRING_TABLE_COUNT ) );
         }
         break;
       }
@@ -329,6 +382,7 @@ void TextField::OnInitialize()
   // Forward input events to controller
   EnableGestureDetection(Gesture::Tap);
   GetTapGestureDetector().SetMaximumTapsRequired( 2 );
+  EnableGestureDetection(Gesture::Pan);
 
   // Set BoundingBox to stage size if not already set.
   if ( mDecorator->GetBoundingBox().IsEmpty() )
@@ -338,6 +392,11 @@ void TextField::OnInitialize()
   }
 }
 
+void TextField::OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change )
+{
+  GetImpl( styleManager ).ApplyThemeStyle( Toolkit::Control( GetOwner() ) );
+}
+
 Vector3 TextField::GetNaturalSize()
 {
   return mController->GetNaturalSize();
@@ -350,11 +409,12 @@ float TextField::GetHeightForWidth( float width )
 
 void TextField::OnRelayout( const Vector2& size, ActorSizeContainer& container )
 {
-  if( mController->Relayout( size ) )
+  if( mController->Relayout( size ) ||
+      !mRenderer )
   {
     if( mDecorator )
     {
-      mDecorator->Relayout( size );
+      mDecorator->Relayout( size, mController->GetScrollPosition() );
     }
 
     if( !mRenderer )
@@ -362,25 +422,95 @@ void TextField::OnRelayout( const Vector2& size, ActorSizeContainer& container )
       mRenderer = Backend::Get().NewRenderer( mRenderingBackend );
     }
 
+    RenderableActor renderableActor;
     if( mRenderer )
     {
-      Actor renderableActor = mRenderer->Render( mController->GetView() );
+      renderableActor = mRenderer->Render( mController->GetView() );
+    }
+
+    EnableClipping( (Dali::Toolkit::TextField::EXCEED_POLICY_CLIP == mExceedPolicy), size );
+
+    if( renderableActor != mRenderableActor )
+    {
+      UnparentAndReset( mRenderableActor );
+      mRenderableActor = renderableActor;
+    }
+
+    if( mRenderableActor )
+    {
+      const Vector2& scrollPosition = mController->GetScrollPosition();
+      mRenderableActor.SetPosition( scrollPosition.x, scrollPosition.y );
 
-      if( renderableActor )
+      // Make sure the actor is parented correctly with/without clipping
+      if( mClipper )
       {
-        Self().Add( renderableActor );
+        mClipper->GetRootActor().Add( mRenderableActor );
+      }
+      else
+      {
+        Self().Add( mRenderableActor );
       }
     }
   }
 }
 
+void TextField::OnKeyInputFocusGained()
+{
+  VirtualKeyboard::StatusChangedSignal().Connect( this, &TextField::KeyboardStatusChanged );
+
+  ImfManager imfManager = ImfManager::Get();
+
+  if ( imfManager )
+  {
+    imfManager.EventReceivedSignal().Connect( this, &TextField::OnImfEvent );
+
+    // Notify that the text editing start.
+    imfManager.Activate();
+
+    // When window gain lost focus, the imf manager is deactivated. Thus when window gain focus again, the imf manager must be activated.
+    imfManager.SetRestoreAfterFocusLost( true );
+  }
+
+  mController->KeyboardFocusGainEvent();
+}
+
+void TextField::OnKeyInputFocusLost()
+{
+  VirtualKeyboard::StatusChangedSignal().Disconnect( this, &TextField::KeyboardStatusChanged );
+
+  ImfManager imfManager = ImfManager::Get();
+  if ( imfManager )
+  {
+    // The text editing is finished. Therefore the imf manager don't have restore activation.
+    imfManager.SetRestoreAfterFocusLost( false );
+
+    // Notify that the text editing finish.
+    imfManager.Deactivate();
+
+    imfManager.EventReceivedSignal().Disconnect( this, &TextField::OnImfEvent );
+  }
+
+  mController->KeyboardFocusLostEvent();
+}
+
 void TextField::OnTap( const TapGesture& gesture )
 {
+  // Show the keyboard if it was hidden.
+  if (!VirtualKeyboard::IsVisible())
+  {
+    VirtualKeyboard::Show();
+  }
+
   SetKeyInputFocus();
 
   mController->TapEvent( gesture.numberOfTaps, gesture.localPoint.x, gesture.localPoint.y );
 }
 
+void TextField::OnPan( const PanGesture& gesture )
+{
+  mController->PanEvent( gesture.state, gesture.displacement );
+}
+
 bool TextField::OnKeyEvent( const KeyEvent& event )
 {
   if( Dali::DALI_KEY_ESCAPE == event.keyCode )
@@ -391,19 +521,80 @@ bool TextField::OnKeyEvent( const KeyEvent& event )
   return mController->KeyEvent( event );
 }
 
+ImfManager::ImfCallbackData TextField::OnImfEvent( Dali::ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
+{
+  switch ( imfEvent.eventName )
+  {
+    case ImfManager::COMMIT:
+    {
+      KeyEvent event( "", imfEvent.predictiveString, 0, 0, 0, KeyEvent::Down );
+      mController->KeyEvent( event );
+      break;
+    }
+    case ImfManager::PREEDIT: // fall through
+    case ImfManager::DELETESURROUNDING:
+    case ImfManager::GETSURROUNDING:
+    case ImfManager::VOID:
+    {
+      // do nothing
+    }
+  } // end switch
+
+  return ImfManager::ImfCallbackData();
+}
+
 void TextField::RequestTextRelayout()
 {
   RelayoutRequest();
 }
 
+void TextField::EnableClipping( bool clipping, const Vector2& size )
+{
+  if( clipping )
+  {
+    // Not worth to created clip actor if width or height is equal to zero.
+    if( size.width > Math::MACHINE_EPSILON_1000 && size.height > Math::MACHINE_EPSILON_1000 )
+    {
+      if( !mClipper )
+      {
+        Actor self = Self();
+
+        mClipper = Clipper::New( size );
+        self.Add( mClipper->GetRootActor() );
+        self.Add( mClipper->GetImageActor() );
+      }
+      else if ( mClipper )
+      {
+        mClipper->Refresh( size );
+      }
+    }
+  }
+  else
+  {
+    // Note - this will automatically remove the root & image actors
+    mClipper.Reset();
+  }
+}
+
+void TextField::KeyboardStatusChanged(bool keyboardShown)
+{
+  // Just hide the grab handle when keyboard is hidden.
+  if (!keyboardShown )
+  {
+    mController->KeyboardFocusLostEvent();
+  }
+}
+
 TextField::TextField()
-: Control( ControlBehaviour( CONTROL_BEHAVIOUR_NONE ) ),
-  mRenderingBackend( DEFAULT_RENDERING_BACKEND )
+: Control( ControlBehaviour( REQUIRES_STYLE_CHANGE_SIGNALS ) ),
+  mRenderingBackend( DEFAULT_RENDERING_BACKEND ),
+  mExceedPolicy( Dali::Toolkit::TextField::EXCEED_POLICY_CLIP )
 {
 }
 
 TextField::~TextField()
 {
+  mClipper.Reset();
 }
 
 } // namespace Internal