dali-toolkit/internal/controls/text-controls/text-editor-impl.cpp

   1 /*
   2  * Copyright (c) 2022 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-editor-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/actors/actor-devel.h>
  23 #include <dali/devel-api/common/stage.h>
  24 #include <dali/devel-api/object/property-helper-devel.h>
  25 #include <dali/integration-api/adaptor-framework/adaptor.h>
  26 #include <dali/integration-api/debug.h>
  27 #include <dali/public-api/actors/layer.h>
  28 #include <dali/public-api/adaptor-framework/key.h>
  29 #include <dali/public-api/common/dali-common.h>
  30 #include <dali/public-api/math/math-utils.h>
  31 #include <dali/public-api/object/type-registry-helper.h>
  32 #include <cstring>
  33 #include <limits>
  34
  35 // INTERNAL INCLUDES
  36 #include <dali-toolkit/devel-api/controls/control-devel.h>
  37 #include <dali-toolkit/devel-api/text/rendering-backend.h>
  38 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  39 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  40 #include <dali-toolkit/internal/controls/text-controls/text-editor-property-handler.h>
  41 #include <dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.h>
  42 #include <dali-toolkit/internal/styling/style-manager-impl.h>
  43 #include <dali-toolkit/internal/text/rendering/text-backend.h>
  44 #include <dali-toolkit/internal/text/text-effects-style.h>
  45 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
  46 #include <dali-toolkit/internal/text/text-font-style.h>
  47 #include <dali-toolkit/internal/text/text-view.h>
  48 #include <dali-toolkit/public-api/text/text-enumerations.h>
  49 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
  50 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  51
  52 using namespace Dali::Toolkit::Text;
  53
  54 #if defined(DEBUG_ENABLED)
  55 Debug::Filter* gTextEditorLogFilter = Debug::Filter::New(Debug::Concise, true, "LOG_TEXT_CONTROLS");
  56 #endif
  57
  58 namespace Dali
  59 {
  60 namespace Toolkit
  61 {
  62 namespace Internal
  63 {
  64 namespace // unnamed namespace
  65 {
  66 const unsigned int DEFAULT_RENDERING_BACKEND = Dali::Toolkit::DevelText::DEFAULT_RENDERING_BACKEND;
  67 const float        DEFAULT_SCROLL_SPEED      = 1200.f; ///< The default scroll speed for the text editor in pixels/second.
  68 } // unnamed namespace
  69
  70 namespace
  71 {
  72 const char* const SCROLL_BAR_POSITION("sourcePosition");
  73 const char* const SCROLL_BAR_POSITION_MIN("sourcePositionMin");
  74 const char* const SCROLL_BAR_POSITION_MAX("sourcePositionMax");
  75 const char* const SCROLL_BAR_CONTENT_SIZE("sourceContentSize");
  76
  77 // Type registration
  78 BaseHandle Create()
  79 {
  80   return Toolkit::TextEditor::New();
  81 }
  82
  83 // clang-format off
  84 // Setup properties, signals and actions using the type-registry.
  85 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::TextEditor, Toolkit::Control, Create);
  86
  87 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "text",                                 STRING,    TEXT                                )
  88 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "textColor",                            VECTOR4,   TEXT_COLOR                          )
  89 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "fontFamily",                           STRING,    FONT_FAMILY                         )
  90 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "fontStyle",                            MAP,       FONT_STYLE                          )
  91 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "pointSize",                            FLOAT,     POINT_SIZE                          )
  92 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "horizontalAlignment",                  STRING,    HORIZONTAL_ALIGNMENT                )
  93 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollThreshold",                      FLOAT,     SCROLL_THRESHOLD                    )
  94 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollSpeed",                          FLOAT,     SCROLL_SPEED                        )
  95 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "primaryCursorColor",                   VECTOR4,   PRIMARY_CURSOR_COLOR                )
  96 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "secondaryCursorColor",                 VECTOR4,   SECONDARY_CURSOR_COLOR              )
  97 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableCursorBlink",                    BOOLEAN,   ENABLE_CURSOR_BLINK                 )
  98 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorBlinkInterval",                  FLOAT,     CURSOR_BLINK_INTERVAL               )
  99 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorBlinkDuration",                  FLOAT,     CURSOR_BLINK_DURATION               )
 100 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "cursorWidth",                          INTEGER,   CURSOR_WIDTH                        )
 101 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "grabHandleImage",                      STRING,    GRAB_HANDLE_IMAGE                   )
 102 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "grabHandlePressedImage",               STRING,    GRAB_HANDLE_PRESSED_IMAGE           )
 103 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleImageLeft",             MAP,       SELECTION_HANDLE_IMAGE_LEFT         )
 104 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleImageRight",            MAP,       SELECTION_HANDLE_IMAGE_RIGHT        )
 105 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandlePressedImageLeft",      MAP,       SELECTION_HANDLE_PRESSED_IMAGE_LEFT )
 106 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandlePressedImageRight",     MAP,       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT)
 107 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleMarkerImageLeft",       MAP,       SELECTION_HANDLE_MARKER_IMAGE_LEFT  )
 108 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHandleMarkerImageRight",      MAP,       SELECTION_HANDLE_MARKER_IMAGE_RIGHT )
 109 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "selectionHighlightColor",              VECTOR4,   SELECTION_HIGHLIGHT_COLOR           )
 110 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "decorationBoundingBox",                RECTANGLE, DECORATION_BOUNDING_BOX             )
 111 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableMarkup",                         BOOLEAN,   ENABLE_MARKUP                       )
 112 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputColor",                           VECTOR4,   INPUT_COLOR                         )
 113 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputFontFamily",                      STRING,    INPUT_FONT_FAMILY                   )
 114 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputFontStyle",                       MAP,       INPUT_FONT_STYLE                    )
 115 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputPointSize",                       FLOAT,     INPUT_POINT_SIZE                    )
 116 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "lineSpacing",                          FLOAT,     LINE_SPACING                        )
 117 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputLineSpacing",                     FLOAT,     INPUT_LINE_SPACING                  )
 118 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "underline",                            MAP,       UNDERLINE                           )
 119 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputUnderline",                       MAP,       INPUT_UNDERLINE                     )
 120 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "shadow",                               MAP,       SHADOW                              )
 121 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputShadow",                          MAP,       INPUT_SHADOW                        )
 122 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "emboss",                               MAP,       EMBOSS                              )
 123 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputEmboss",                          MAP,       INPUT_EMBOSS                        )
 124 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "outline",                              MAP,       OUTLINE                             )
 125 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "inputOutline",                         MAP,       INPUT_OUTLINE                       )
 126 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "smoothScroll",                         BOOLEAN,   SMOOTH_SCROLL                       )
 127 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "smoothScrollDuration",                 FLOAT,     SMOOTH_SCROLL_DURATION              )
 128 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableScrollBar",                      BOOLEAN,   ENABLE_SCROLL_BAR                   )
 129 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollBarShowDuration",                FLOAT,     SCROLL_BAR_SHOW_DURATION            )
 130 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "scrollBarFadeDuration",                FLOAT,     SCROLL_BAR_FADE_DURATION            )
 131 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "pixelSize",                            FLOAT,     PIXEL_SIZE                          )
 132 DALI_PROPERTY_REGISTRATION_READ_ONLY(Toolkit,       TextEditor, "lineCount",                            INTEGER,   LINE_COUNT                          )
 133 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "enableSelection",                      BOOLEAN,   ENABLE_SELECTION                    )
 134 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "placeholder",                          MAP,       PLACEHOLDER                         )
 135 DALI_PROPERTY_REGISTRATION(Toolkit,                 TextEditor, "lineWrapMode",                         INTEGER,   LINE_WRAP_MODE                      )
 136 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "placeholderText",                      STRING,    PLACEHOLDER_TEXT                    )
 137 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "placeholderTextColor",                 VECTOR4,   PLACEHOLDER_TEXT_COLOR              )
 138 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableShiftSelection",                 BOOLEAN,   ENABLE_SHIFT_SELECTION              )
 139 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableGrabHandle",                     BOOLEAN,   ENABLE_GRAB_HANDLE                  )
 140 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "matchSystemLanguageDirection",         BOOLEAN,   MATCH_SYSTEM_LANGUAGE_DIRECTION     )
 141 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "renderingBackend",                     INTEGER,   RENDERING_BACKEND                   )
 142 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "maxLength",                            INTEGER,   MAX_LENGTH                          )
 143 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectedTextStart",                    INTEGER,   SELECTED_TEXT_START                 )
 144 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectedTextEnd",                      INTEGER,   SELECTED_TEXT_END                   )
 145 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "horizontalScrollPosition",             FLOAT,     HORIZONTAL_SCROLL_POSITION          )
 146 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "verticalScrollPosition",               INTEGER,   VERTICAL_SCROLL_POSITION            )
 147 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableEditing",                        BOOLEAN,   ENABLE_EDITING                      )
 148 DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY(Toolkit, TextEditor, "selectedText",                         STRING,    SELECTED_TEXT                       )
 149 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "fontSizeScale",                        FLOAT,     FONT_SIZE_SCALE                     )
 150 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableFontSizeScale",                  BOOLEAN,   ENABLE_FONT_SIZE_SCALE              )
 151 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "primaryCursorPosition",                INTEGER,   PRIMARY_CURSOR_POSITION             )
 152 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "grabHandleColor",                      VECTOR4,   GRAB_HANDLE_COLOR                   )
 153 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "enableGrabHandlePopup",                BOOLEAN,   ENABLE_GRAB_HANDLE_POPUP            )
 154 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputMethodSettings",                  MAP,       INPUT_METHOD_SETTINGS               )
 155 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputFilter",                          MAP,       INPUT_FILTER                        )
 156 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "ellipsis",                             BOOLEAN,   ELLIPSIS                            )
 157 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "ellipsisPosition",                     INTEGER,   ELLIPSIS_POSITION                   )
 158 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "minLineSize",                          FLOAT,     MIN_LINE_SIZE                       )
 159 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "strikethrough",                        MAP,       STRIKETHROUGH                       )
 160 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "inputStrikethrough",                   MAP,       INPUT_STRIKETHROUGH                 )
 161 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "characterSpacing",                     FLOAT,     CHARACTER_SPACING                   )
 162 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "relativeLineSize",                     FLOAT,     RELATIVE_LINE_SIZE                  )
 163 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "verticalAlignment",                    STRING,    VERTICAL_ALIGNMENT                  )
 164 DALI_DEVEL_PROPERTY_REGISTRATION(Toolkit,           TextEditor, "selectionPopupStyle",                  MAP,       SELECTION_POPUP_STYLE               )
 165
 166 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "textChanged",           SIGNAL_TEXT_CHANGED           )
 167 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputStyleChanged",     SIGNAL_INPUT_STYLE_CHANGED    )
 168 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "maxLengthReached",      SIGNAL_MAX_LENGTH_REACHED     )
 169 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "anchorClicked",         SIGNAL_ANCHOR_CLICKED         )
 170 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "inputFiltered",         SIGNAL_INPUT_FILTERED         )
 171 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "cursorPositionChanged", SIGNAL_CURSOR_POSITION_CHANGED)
 172 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionChanged",      SIGNAL_SELECTION_CHANGED      )
 173 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionCleared",      SIGNAL_SELECTION_CLEARED      )
 174 DALI_SIGNAL_REGISTRATION(Toolkit, TextEditor, "selectionStarted",      SIGNAL_SELECTION_STARTED      )
 175
 176 DALI_TYPE_REGISTRATION_END()
 177 // clang-format on
 178
 179 Toolkit::TextEditor::InputStyle::Mask ConvertInputStyle(Text::InputStyle::Mask inputStyleMask)
 180 {
 181   Toolkit::TextEditor::InputStyle::Mask editorInputStyleMask = Toolkit::TextEditor::InputStyle::NONE;
 182
 183   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_COLOR))
 184   {
 185     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::COLOR);
 186   }
 187   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_FAMILY))
 188   {
 189     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_FAMILY);
 190   }
 191   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_POINT_SIZE))
 192   {
 193     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::POINT_SIZE);
 194   }
 195   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WEIGHT))
 196   {
 197     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 198   }
 199   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_WIDTH))
 200   {
 201     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 202   }
 203   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_FONT_SLANT))
 204   {
 205     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::FONT_STYLE);
 206   }
 207   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_LINE_SPACING))
 208   {
 209     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::LINE_SPACING);
 210   }
 211   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_UNDERLINE))
 212   {
 213     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::UNDERLINE);
 214   }
 215   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_SHADOW))
 216   {
 217     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::SHADOW);
 218   }
 219   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_EMBOSS))
 220   {
 221     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::EMBOSS);
 222   }
 223   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_OUTLINE))
 224   {
 225     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::OUTLINE);
 226   }
 227   if(InputStyle::NONE != static_cast<InputStyle::Mask>(inputStyleMask & InputStyle::INPUT_STRIKETHROUGH))
 228   {
 229     editorInputStyleMask = static_cast<Toolkit::TextEditor::InputStyle::Mask>(editorInputStyleMask | Toolkit::TextEditor::InputStyle::STRIKETHROUGH);
 230   }
 231
 232   return editorInputStyleMask;
 233 }
 234
 235 } // namespace
 236
 237 Toolkit::TextEditor TextEditor::New(ControlBehaviour additionalBehaviour)
 238 {
 239   // Create the implementation, temporarily owned by this handle on stack
 240   IntrusivePtr<TextEditor> impl = new TextEditor(additionalBehaviour);
 241
 242   // Pass ownership to CustomActor handle
 243   Toolkit::TextEditor handle(*impl);
 244
 245   // Second-phase init of the implementation
 246   // This can only be done after the CustomActor connection has been made...
 247   impl->Initialize();
 248
 249   return handle;
 250 }
 251
 252 void TextEditor::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
 253 {
 254   Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
 255
 256   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor SetProperty\n");
 257
 258   if(textEditor)
 259   {
 260     PropertyHandler::SetProperty(textEditor, index, value);
 261   }
 262 }
 263
 264 Property::Value TextEditor::GetProperty(BaseObject* object, Property::Index index)
 265 {
 266   Property::Value value;
 267
 268   Toolkit::TextEditor textEditor = Toolkit::TextEditor::DownCast(Dali::BaseHandle(object));
 269
 270   if(textEditor)
 271   {
 272     value = PropertyHandler::GetProperty(textEditor, index);
 273   }
 274   return value;
 275 }
 276
 277 void TextEditor::SelectWholeText()
 278 {
 279   if(mController && mController->IsShowingRealText())
 280   {
 281     mController->SelectWholeText();
 282     SetKeyInputFocus();
 283   }
 284 }
 285
 286 void TextEditor::SelectNone()
 287 {
 288   if(mController && mController->IsShowingRealText())
 289   {
 290     mController->SelectNone();
 291   }
 292 }
 293
 294 void TextEditor::SelectText(const uint32_t start, const uint32_t end)
 295 {
 296   if(mController && mController->IsShowingRealText())
 297   {
 298     mController->SelectText(start, end);
 299     SetKeyInputFocus();
 300   }
 301 }
 302
 303 string TextEditor::CopyText()
 304 {
 305   string copiedText = "";
 306   if(mController && mController->IsShowingRealText())
 307   {
 308     copiedText = mController->CopyText();
 309   }
 310   return copiedText;
 311 }
 312
 313 string TextEditor::CutText()
 314 {
 315   string cutText = "";
 316   if(mController && mController->IsShowingRealText())
 317   {
 318     cutText = mController->CutText();
 319   }
 320   return cutText;
 321 }
 322
 323 void TextEditor::PasteText()
 324 {
 325   if(mController)
 326   {
 327     SetKeyInputFocus(); //Giving focus to the editor that was passed to the PasteText in case the passed editor (current editor) doesn't have focus.
 328     mController->PasteText();
 329   }
 330 }
 331
 332 void TextEditor::ScrollBy(Vector2 scroll)
 333 {
 334   if(mController && mController->IsShowingRealText())
 335   {
 336     mController->ScrollBy(scroll);
 337   }
 338 }
 339
 340 float TextEditor::GetHorizontalScrollPosition()
 341 {
 342   if(mController && mController->IsShowingRealText())
 343   {
 344     return mController->GetHorizontalScrollPosition();
 345   }
 346   return 0;
 347 }
 348
 349 float TextEditor::GetVerticalScrollPosition()
 350 {
 351   if(mController && mController->IsShowingRealText())
 352   {
 353     return mController->GetVerticalScrollPosition();
 354   }
 355   return 0;
 356 }
 357
 358 Vector<Vector2> TextEditor::GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const
 359 {
 360   return mController->GetTextSize(startIndex, endIndex);
 361 }
 362
 363 Vector<Vector2> TextEditor::GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const
 364 {
 365   return mController->GetTextPosition(startIndex, endIndex);
 366 }
 367
 368 Rect<float> TextEditor::GetLineBoundingRectangle(const uint32_t lineIndex) const
 369 {
 370   return mController->GetLineBoundingRectangle(lineIndex);
 371 }
 372
 373 Rect<float> TextEditor::GetCharacterBoundingRectangle(const uint32_t charIndex) const
 374 {
 375   return mController->GetCharacterBoundingRectangle(charIndex);
 376 }
 377
 378 int TextEditor::GetCharacterIndexAtPosition(float visualX, float visualY) const
 379 {
 380   return mController->GetCharacterIndexAtPosition(visualX, visualY);
 381 }
 382
 383 Rect<> TextEditor::GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const
 384 {
 385   return mController->GetTextBoundingRectangle(startIndex, endIndex);
 386 }
 387
 388 void TextEditor::SetSpannedText(const Text::Spanned& spannedText)
 389 {
 390   mController->SetSpannedText(spannedText);
 391 }
 392
 393 string TextEditor::GetSelectedText() const
 394 {
 395   string selectedText = "";
 396   if(mController && mController->IsShowingRealText())
 397   {
 398     selectedText = mController->GetSelectedText();
 399   }
 400   return selectedText;
 401 }
 402
 403 InputMethodContext TextEditor::GetInputMethodContext()
 404 {
 405   return mInputMethodContext;
 406 }
 407
 408 DevelTextEditor::MaxLengthReachedSignalType& TextEditor::MaxLengthReachedSignal()
 409 {
 410   return mMaxLengthReachedSignal;
 411 }
 412
 413 DevelTextEditor::AnchorClickedSignalType& TextEditor::AnchorClickedSignal()
 414 {
 415   return mAnchorClickedSignal;
 416 }
 417
 418 DevelTextEditor::CursorPositionChangedSignalType& TextEditor::CursorPositionChangedSignal()
 419 {
 420   return mCursorPositionChangedSignal;
 421 }
 422
 423 DevelTextEditor::InputFilteredSignalType& TextEditor::InputFilteredSignal()
 424 {
 425   return mInputFilteredSignal;
 426 }
 427
 428 DevelTextEditor::SelectionChangedSignalType& TextEditor::SelectionChangedSignal()
 429 {
 430   return mSelectionChangedSignal;
 431 }
 432
 433 DevelTextEditor::SelectionClearedSignalType& TextEditor::SelectionClearedSignal()
 434 {
 435   return mSelectionClearedSignal;
 436 }
 437
 438 DevelTextEditor::SelectionStartedSignalType& TextEditor::SelectionStartedSignal()
 439 {
 440   return mSelectionStartedSignal;
 441 }
 442
 443 Text::ControllerPtr TextEditor::GetTextController()
 444 {
 445   return mController;
 446 }
 447
 448 bool TextEditor::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
 449 {
 450   Dali::BaseHandle handle(object);
 451
 452   bool                connected(true);
 453   Toolkit::TextEditor editor = Toolkit::TextEditor::DownCast(handle);
 454
 455   if(0 == strcmp(signalName.c_str(), SIGNAL_TEXT_CHANGED))
 456   {
 457     editor.TextChangedSignal().Connect(tracker, functor);
 458   }
 459   else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_STYLE_CHANGED))
 460   {
 461     editor.InputStyleChangedSignal().Connect(tracker, functor);
 462   }
 463   else if(0 == strcmp(signalName.c_str(), SIGNAL_MAX_LENGTH_REACHED))
 464   {
 465     if(editor)
 466     {
 467       Internal::TextEditor& editorImpl(GetImpl(editor));
 468       editorImpl.MaxLengthReachedSignal().Connect(tracker, functor);
 469     }
 470   }
 471   else if(0 == strcmp(signalName.c_str(), SIGNAL_ANCHOR_CLICKED))
 472   {
 473     if(editor)
 474     {
 475       Internal::TextEditor& editorImpl(GetImpl(editor));
 476       editorImpl.AnchorClickedSignal().Connect(tracker, functor);
 477     }
 478   }
 479   else if(0 == strcmp(signalName.c_str(), SIGNAL_CURSOR_POSITION_CHANGED))
 480   {
 481     if(editor)
 482     {
 483       Internal::TextEditor& editorImpl(GetImpl(editor));
 484       editorImpl.CursorPositionChangedSignal().Connect(tracker, functor);
 485     }
 486   }
 487   else if(0 == strcmp(signalName.c_str(), SIGNAL_INPUT_FILTERED))
 488   {
 489     if(editor)
 490     {
 491       Internal::TextEditor& editorImpl(GetImpl(editor));
 492       editorImpl.InputFilteredSignal().Connect(tracker, functor);
 493     }
 494   }
 495   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CHANGED))
 496   {
 497     if(editor)
 498     {
 499       Internal::TextEditor& editorImpl(GetImpl(editor));
 500       editorImpl.SelectionChangedSignal().Connect(tracker, functor);
 501     }
 502   }
 503   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_CLEARED))
 504   {
 505     if(editor)
 506     {
 507       Internal::TextEditor& editorImpl(GetImpl(editor));
 508       editorImpl.SelectionClearedSignal().Connect(tracker, functor);
 509     }
 510   }
 511   else if(0 == strcmp(signalName.c_str(), SIGNAL_SELECTION_STARTED))
 512   {
 513     if(editor)
 514     {
 515       Internal::TextEditor& editorImpl(GetImpl(editor));
 516       editorImpl.SelectionStartedSignal().Connect(tracker, functor);
 517     }
 518   }
 519   else
 520   {
 521     // signalName does not match any signal
 522     connected = false;
 523   }
 524
 525   return connected;
 526 }
 527
 528 Toolkit::TextEditor::TextChangedSignalType& TextEditor::TextChangedSignal()
 529 {
 530   return mTextChangedSignal;
 531 }
 532
 533 Toolkit::TextEditor::InputStyleChangedSignalType& TextEditor::InputStyleChangedSignal()
 534 {
 535   return mInputStyleChangedSignal;
 536 }
 537
 538 Toolkit::TextEditor::ScrollStateChangedSignalType& TextEditor::ScrollStateChangedSignal()
 539 {
 540   return mScrollStateChangedSignal;
 541 }
 542
 543 void TextEditor::OnAccessibilityStatusChanged()
 544 {
 545   CommonTextUtils::SynchronizeTextAnchorsInParent(Self(), mController, mAnchorActors);
 546 }
 547
 548 void TextEditor::OnInitialize()
 549 {
 550   Actor self = Self();
 551
 552   mController = Text::Controller::New(this, this, this, this);
 553
 554   mDecorator = Text::Decorator::New(*mController,
 555                                     *mController);
 556
 557   mInputMethodContext = InputMethodContext::New(self);
 558
 559   mController->GetLayoutEngine().SetLayout(Layout::Engine::MULTI_LINE_BOX);
 560
 561   // Enables the text input.
 562   mController->EnableTextInput(mDecorator, mInputMethodContext);
 563
 564   // Enables the vertical scrolling after the text input has been enabled.
 565   mController->SetVerticalScrollEnabled(true);
 566
 567   // Disables the horizontal scrolling.
 568   mController->SetHorizontalScrollEnabled(false);
 569
 570   // Sets the maximum number of characters.
 571   mController->SetMaximumNumberOfCharacters(std::numeric_limits<Length>::max());
 572
 573   // Enable the smooth handle panning.
 574   mController->SetSmoothHandlePanEnabled(true);
 575
 576   mController->SetNoTextDoubleTapAction(Controller::NoTextTap::HIGHLIGHT);
 577   mController->SetNoTextLongPressAction(Controller::NoTextTap::HIGHLIGHT);
 578
 579   // Sets layoutDirection value
 580   Dali::Stage                 stage           = Dali::Stage::GetCurrent();
 581   Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(stage.GetRootLayer().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
 582   mController->SetLayoutDirection(layoutDirection);
 583
 584   self.LayoutDirectionChangedSignal().Connect(this, &TextEditor::OnLayoutDirectionChanged);
 585
 586   // Forward input events to controller
 587   EnableGestureDetection(static_cast<GestureType::Value>(GestureType::TAP | GestureType::PAN | GestureType::LONG_PRESS));
 588   GetTapGestureDetector().SetMaximumTapsRequired(2);
 589   GetTapGestureDetector().ReceiveAllTapEvents(true);
 590
 591   self.TouchedSignal().Connect(this, &TextEditor::OnTouched);
 592
 593   // Set BoundingBox to stage size if not already set.
 594   Rect<int> boundingBox;
 595   mDecorator->GetBoundingBox(boundingBox);
 596
 597   if(boundingBox.IsEmpty())
 598   {
 599     Vector2 stageSize = Dali::Stage::GetCurrent().GetSize();
 600     mDecorator->SetBoundingBox(Rect<int>(0.0f, 0.0f, stageSize.width, stageSize.height));
 601   }
 602
 603   // Whether to flip the selection handles as soon as they cross.
 604   mDecorator->FlipSelectionHandlesOnCrossEnabled(true);
 605
 606   // Set the default scroll speed.
 607   mDecorator->SetScrollSpeed(DEFAULT_SCROLL_SPEED);
 608
 609   // Fill-parent area by default
 610   self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::WIDTH);
 611   self.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
 612   self.OnSceneSignal().Connect(this, &TextEditor::OnSceneConnect);
 613
 614   DevelControl::SetInputMethodContext(*this, mInputMethodContext);
 615
 616   // Creates an extra control to be used as stencil buffer.
 617   mStencil = Control::New();
 618   mStencil.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
 619   mStencil.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
 620
 621   // Creates a background visual. Even if the color is transparent it updates the stencil.
 622   mStencil.SetProperty(Toolkit::Control::Property::BACKGROUND,
 623                        Property::Map().Add(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR).Add(ColorVisual::Property::MIX_COLOR, Color::TRANSPARENT));
 624
 625   // Enable the clipping property.
 626   mStencil.SetProperty(Actor::Property::CLIPPING_MODE, ClippingMode::CLIP_TO_BOUNDING_BOX);
 627   mStencil.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
 628
 629   self.Add(mStencil);
 630
 631   // Accessibility
 632   self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::ENTRY);
 633   self.SetProperty(DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true);
 634
 635   Accessibility::Bridge::EnabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
 636   Accessibility::Bridge::DisabledSignal().Connect(this, &TextEditor::OnAccessibilityStatusChanged);
 637 }
 638
 639 DevelControl::ControlAccessible* TextEditor::CreateAccessibleObject()
 640 {
 641   return new TextEditorAccessible(Self());
 642 }
 643
 644 void TextEditor::OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change)
 645 {
 646   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange\n");
 647
 648   switch(change)
 649   {
 650     case StyleChange::DEFAULT_FONT_CHANGE:
 651     {
 652       DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnStyleChange DEFAULT_FONT_CHANGE\n");
 653       const std::string& newFont = GetImpl(styleManager).GetDefaultFontFamily();
 654       // Property system did not set the font so should update it.
 655       mController->UpdateAfterFontChange(newFont);
 656       RelayoutRequest();
 657       break;
 658     }
 659
 660     case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
 661     {
 662       GetImpl(styleManager).ApplyThemeStyle(Toolkit::Control(GetOwner()));
 663       RelayoutRequest();
 664       break;
 665     }
 666     case StyleChange::THEME_CHANGE:
 667     {
 668       // Nothing to do, let control base class handle this
 669       break;
 670     }
 671   }
 672
 673   // Up call to Control
 674   Control::OnStyleChange(styleManager, change);
 675 }
 676
 677 Vector3 TextEditor::GetNaturalSize()
 678 {
 679   Extents padding;
 680   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 681
 682   Vector3 naturalSize = mController->GetNaturalSize();
 683   naturalSize.width += (padding.start + padding.end);
 684   naturalSize.height += (padding.top + padding.bottom);
 685
 686   return naturalSize;
 687 }
 688
 689 float TextEditor::GetHeightForWidth(float width)
 690 {
 691   Extents padding;
 692   padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 693   return mController->GetHeightForWidth(width) + padding.top + padding.bottom;
 694 }
 695
 696 void TextEditor::ResizeActor(Actor& actor, const Vector2& size)
 697 {
 698   if(actor.GetProperty<Vector3>(Dali::Actor::Property::SIZE).GetVectorXY() != size)
 699   {
 700     actor.SetProperty(Actor::Property::SIZE, size);
 701   }
 702 }
 703
 704 void TextEditor::OnPropertySet(Property::Index index, const Property::Value& propertyValue)
 705 {
 706   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnPropertySet index[%d]\n", index);
 707
 708   switch(index)
 709   {
 710     case DevelActor::Property::USER_INTERACTION_ENABLED:
 711     {
 712       const bool enabled = propertyValue.Get<bool>();
 713       mController->SetUserInteractionEnabled(enabled);
 714       if(mStencil)
 715       {
 716         float opacity = enabled ? 1.0f : mController->GetDisabledColorOpacity();
 717         mStencil.SetProperty(Actor::Property::OPACITY, opacity);
 718       }
 719       break;
 720     }
 721     default:
 722     {
 723       Control::OnPropertySet(index, propertyValue); // up call to control for non-handled properties
 724       break;
 725     }
 726   }
 727 }
 728
 729 void TextEditor::OnRelayout(const Vector2& size, RelayoutContainer& container)
 730 {
 731   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor OnRelayout\n");
 732
 733   Actor self = Self();
 734
 735   Extents padding;
 736   padding = self.GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 737
 738   Vector2 contentSize(size.x - (padding.start + padding.end), size.y - (padding.top + padding.bottom));
 739
 740   // Support Right-To-Left of padding
 741   Dali::LayoutDirection::Type layoutDirection = mController->GetLayoutDirection(self);
 742
 743   if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
 744   {
 745     std::swap(padding.start, padding.end);
 746   }
 747
 748   if(mStencil)
 749   {
 750     mStencil.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
 751     ResizeActor(mStencil, contentSize);
 752   }
 753   if(mActiveLayer)
 754   {
 755     mActiveLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
 756     ResizeActor(mActiveLayer, contentSize);
 757   }
 758   if(mCursorLayer)
 759   {
 760     mCursorLayer.SetProperty(Actor::Property::POSITION, Vector2(padding.start, padding.top));
 761     ResizeActor(mCursorLayer, contentSize);
 762   }
 763
 764   // If there is text changed, callback is called.
 765   if(mTextChanged)
 766   {
 767     EmitTextChangedSignal();
 768   }
 769
 770   const Text::Controller::UpdateTextType updateTextType = mController->Relayout(contentSize, layoutDirection);
 771
 772   if((Text::Controller::NONE_UPDATED != updateTextType) ||
 773      !mRenderer)
 774   {
 775     DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnRelayout %p Displaying new contents\n", mController.Get());
 776
 777     if(mDecorator &&
 778        (Text::Controller::NONE_UPDATED != (Text::Controller::DECORATOR_UPDATED & updateTextType)))
 779     {
 780       mDecorator->Relayout(contentSize);
 781     }
 782
 783     if(!mRenderer)
 784     {
 785       mRenderer = Backend::Get().NewRenderer(mRenderingBackend);
 786     }
 787
 788     RenderText(updateTextType);
 789   }
 790
 791   if(mCursorPositionChanged)
 792   {
 793     EmitCursorPositionChangedSignal();
 794   }
 795
 796   if(mSelectionStarted)
 797   {
 798     EmitSelectionStartedSignal();
 799   }
 800
 801   if(mSelectionChanged)
 802   {
 803     EmitSelectionChangedSignal();
 804   }
 805
 806   if(mSelectionCleared)
 807   {
 808     EmitSelectionClearedSignal();
 809   }
 810
 811   // The text-editor emits signals when the input style changes. These changes of style are
 812   // detected during the relayout process (size negotiation), i.e after the cursor has been moved. Signals
 813   // can't be emitted during the size negotiation as the callbacks may update the UI.
 814   // The text-editor adds an idle callback to the adaptor to emit the signals after the size negotiation.
 815   if(!mController->IsInputStyleChangedSignalsQueueEmpty())
 816   {
 817     if(Adaptor::IsAvailable())
 818     {
 819       Adaptor& adaptor = Adaptor::Get();
 820
 821       if(NULL == mIdleCallback)
 822       {
 823         // @note: The callback manager takes the ownership of the callback object.
 824         mIdleCallback = MakeCallback(this, &TextEditor::OnIdleSignal);
 825         adaptor.AddIdle(mIdleCallback, false);
 826       }
 827     }
 828   }
 829 }
 830
 831 void TextEditor::RenderText(Text::Controller::UpdateTextType updateTextType)
 832 {
 833   CommonTextUtils::RenderText(Self(), mRenderer, mController, mDecorator, mAlignmentOffset, mRenderableActor, mBackgroundActor, mCursorLayer, mStencil, mClippingDecorationActors, mAnchorActors, updateTextType);
 834   if(mRenderableActor)
 835   {
 836     ApplyScrollPosition();
 837   }
 838   UpdateScrollBar();
 839 }
 840
 841 void TextEditor::OnKeyInputFocusGained()
 842 {
 843   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyInputFocusGained %p\n", mController.Get());
 844   if(mInputMethodContext && IsEditable())
 845   {
 846     // All input panel properties, such as layout, return key type, and input hint, should be set before input panel activates (or shows).
 847     mInputMethodContext.ApplyOptions(mInputMethodOptions);
 848     mInputMethodContext.NotifyTextInputMultiLine(true);
 849
 850     mInputMethodContext.StatusChangedSignal().Connect(this, &TextEditor::KeyboardStatusChanged);
 851
 852     mInputMethodContext.EventReceivedSignal().Connect(this, &TextEditor::OnInputMethodContextEvent);
 853
 854     // Notify that the text editing start.
 855     mInputMethodContext.Activate();
 856
 857     // When window gain lost focus, the InputMethodContext is deactivated. Thus when window gain focus again, the InputMethodContext must be activated.
 858     mInputMethodContext.SetRestoreAfterFocusLost(true);
 859   }
 860   ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
 861
 862   if(notifier)
 863   {
 864     notifier.ContentSelectedSignal().Connect(this, &TextEditor::OnClipboardTextSelected);
 865   }
 866
 867   if(IsEditable() && mController->IsUserInteractionEnabled())
 868   {
 869     mController->KeyboardFocusGainEvent(); // Called in the case of no virtual keyboard to trigger this event
 870   }
 871
 872   EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
 873 }
 874
 875 void TextEditor::OnKeyInputFocusLost()
 876 {
 877   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor:OnKeyInputFocusLost %p\n", mController.Get());
 878   if(mInputMethodContext)
 879   {
 880     mInputMethodContext.StatusChangedSignal().Disconnect(this, &TextEditor::KeyboardStatusChanged);
 881
 882     // The text editing is finished. Therefore the InputMethodContext don't have restore activation.
 883     mInputMethodContext.SetRestoreAfterFocusLost(false);
 884
 885     // Notify that the text editing finish.
 886     mInputMethodContext.Deactivate();
 887
 888     mInputMethodContext.EventReceivedSignal().Disconnect(this, &TextEditor::OnInputMethodContextEvent);
 889   }
 890   ClipboardEventNotifier notifier(ClipboardEventNotifier::Get());
 891
 892   if(notifier)
 893   {
 894     notifier.ContentSelectedSignal().Disconnect(this, &TextEditor::OnClipboardTextSelected);
 895   }
 896
 897   mController->KeyboardFocusLostEvent();
 898
 899   EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
 900 }
 901
 902 bool TextEditor::OnAccessibilityActivated()
 903 {
 904   SetKeyInputFocus();
 905   return true;
 906 }
 907
 908 void TextEditor::OnTap(const TapGesture& gesture)
 909 {
 910   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnTap %p\n", mController.Get());
 911   if(mInputMethodContext && IsEditable())
 912   {
 913     mInputMethodContext.Activate();
 914   }
 915   // Deliver the tap before the focus event to controller; this allows us to detect when focus is gained due to tap-gestures
 916   Extents padding;
 917   padding                   = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 918   const Vector2& localPoint = gesture.GetLocalPoint();
 919   mController->TapEvent(gesture.GetNumberOfTaps(), localPoint.x - padding.start, localPoint.y - padding.top);
 920   mController->AnchorEvent(localPoint.x - padding.start, localPoint.y - padding.top);
 921
 922   Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
 923   if(keyboardFocusManager)
 924   {
 925     keyboardFocusManager.SetCurrentFocusActor(Self());
 926   }
 927   SetKeyInputFocus();
 928 }
 929
 930 void TextEditor::OnPan(const PanGesture& gesture)
 931 {
 932   mController->PanEvent(gesture.GetState(), gesture.GetDisplacement());
 933   if(gesture.GetState() == GestureState::STARTED && !mController->IsScrollable(gesture.GetDisplacement()))
 934   {
 935     Dali::DevelActor::SetNeedGesturePropagation(Self(), true);
 936   }
 937 }
 938
 939 void TextEditor::OnLongPress(const LongPressGesture& gesture)
 940 {
 941   if(mInputMethodContext && IsEditable())
 942   {
 943     mInputMethodContext.Activate();
 944   }
 945   Extents padding;
 946   padding                   = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
 947   const Vector2& localPoint = gesture.GetLocalPoint();
 948   mController->LongPressEvent(gesture.GetState(), localPoint.x - padding.start, localPoint.y - padding.top);
 949
 950   SetKeyInputFocus();
 951 }
 952
 953 bool TextEditor::OnKeyEvent(const KeyEvent& event)
 954 {
 955   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnKeyEvent %p keyCode %d\n", mController.Get(), event.GetKeyCode());
 956
 957   if(Dali::DALI_KEY_ESCAPE == event.GetKeyCode() && mController->ShouldClearFocusOnEscape())
 958   {
 959     // Make sure ClearKeyInputFocus when only key is up
 960     if(event.GetState() == KeyEvent::UP)
 961     {
 962       Dali::Toolkit::KeyboardFocusManager keyboardFocusManager = Dali::Toolkit::KeyboardFocusManager::Get();
 963       if(keyboardFocusManager)
 964       {
 965         keyboardFocusManager.ClearFocus();
 966       }
 967       ClearKeyInputFocus();
 968     }
 969
 970     return true;
 971   }
 972
 973   return mController->KeyEvent(event);
 974 }
 975
 976 void TextEditor::RequestTextRelayout()
 977 {
 978   RelayoutRequest();
 979 }
 980
 981 void TextEditor::TextInserted(unsigned int position, unsigned int length, const std::string& content)
 982 {
 983   GetAccessibleObject()->EmitTextInserted(position, length, content);
 984 }
 985
 986 void TextEditor::TextDeleted(unsigned int position, unsigned int length, const std::string& content)
 987 {
 988   GetAccessibleObject()->EmitTextDeleted(position, length, content);
 989 }
 990
 991 void TextEditor::CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition)
 992 {
 993   GetAccessibleObject()->EmitTextCursorMoved(newPosition);
 994
 995   if((oldPosition != newPosition) && !mCursorPositionChanged)
 996   {
 997     mCursorPositionChanged = true;
 998     mOldPosition           = oldPosition;
 999   }
1000 }
1001
1002 void TextEditor::TextChanged(bool immediate)
1003 {
1004   if(immediate) // Emits TextChangedSignal immediately
1005   {
1006     EmitTextChangedSignal();
1007   }
1008   else
1009   {
1010     mTextChanged = true;
1011   }
1012 }
1013
1014 void TextEditor::EmitTextChangedSignal()
1015 {
1016   Dali::Toolkit::TextEditor handle(GetOwner());
1017   mTextChangedSignal.Emit(handle);
1018   mTextChanged = false;
1019 }
1020
1021 void TextEditor::MaxLengthReached()
1022 {
1023   Dali::Toolkit::TextEditor handle(GetOwner());
1024   mMaxLengthReachedSignal.Emit(handle);
1025 }
1026
1027 void TextEditor::InputStyleChanged(Text::InputStyle::Mask inputStyleMask)
1028 {
1029   Dali::Toolkit::TextEditor handle(GetOwner());
1030   mInputStyleChangedSignal.Emit(handle, ConvertInputStyle(inputStyleMask));
1031 }
1032
1033 void TextEditor::AnchorClicked(const std::string& href)
1034 {
1035   Dali::Toolkit::TextEditor handle(GetOwner());
1036   mAnchorClickedSignal.Emit(handle, href.c_str(), href.length());
1037 }
1038
1039 void TextEditor::EmitCursorPositionChangedSignal()
1040 {
1041   Dali::Toolkit::TextEditor handle(GetOwner());
1042   mCursorPositionChanged = false;
1043   mCursorPositionChangedSignal.Emit(handle, mOldPosition);
1044 }
1045
1046 void TextEditor::InputFiltered(Toolkit::InputFilter::Property::Type type)
1047 {
1048   Dali::Toolkit::TextEditor handle(GetOwner());
1049   mInputFilteredSignal.Emit(handle, type);
1050 }
1051
1052 void TextEditor::EmitSelectionChangedSignal()
1053 {
1054   Dali::Toolkit::TextEditor handle(GetOwner());
1055   mSelectionChangedSignal.Emit(handle, mOldSelectionStart, mOldSelectionEnd);
1056   mSelectionChanged = false;
1057 }
1058
1059 void TextEditor::EmitSelectionClearedSignal()
1060 {
1061   Dali::Toolkit::TextEditor handle(GetOwner());
1062   mSelectionClearedSignal.Emit(handle);
1063   mSelectionCleared = false;
1064 }
1065
1066 void TextEditor::EmitSelectionStartedSignal()
1067 {
1068   Dali::Toolkit::TextEditor handle(GetOwner());
1069   mSelectionStartedSignal.Emit(handle);
1070   mSelectionStarted = false;
1071 }
1072
1073 void TextEditor::SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd)
1074 {
1075   if(((oldStart != newStart) || (oldEnd != newEnd)) && !mSelectionChanged)
1076   {
1077     if(newStart == newEnd)
1078     {
1079       mSelectionCleared = true;
1080     }
1081     else
1082     {
1083       if(oldStart == oldEnd)
1084       {
1085         mSelectionStarted = true;
1086       }
1087     }
1088
1089     mSelectionChanged  = true;
1090     mOldSelectionStart = oldStart;
1091     mOldSelectionEnd   = oldEnd;
1092
1093     if(mOldSelectionStart > mOldSelectionEnd)
1094     {
1095       //swap
1096       uint32_t temp      = mOldSelectionStart;
1097       mOldSelectionStart = mOldSelectionEnd;
1098       mOldSelectionEnd   = temp;
1099     }
1100   }
1101 }
1102
1103 void TextEditor::AddDecoration(Actor& actor, DecorationType type, bool needsClipping)
1104 {
1105   if(actor)
1106   {
1107     if(needsClipping)
1108     {
1109       mClippingDecorationActors.push_back(actor);
1110     }
1111
1112     // If the actor is a layer type, add it.
1113     if(type == DecorationType::ACTIVE_LAYER)
1114     {
1115       AddLayer(mActiveLayer, actor);
1116     }
1117     else if(type == DecorationType::CURSOR_LAYER)
1118     {
1119       AddLayer(mCursorLayer, actor);
1120     }
1121   }
1122 }
1123
1124 void TextEditor::AddLayer(Actor& layer, Actor& actor)
1125 {
1126   actor.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_LEFT);
1127   actor.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_LEFT);
1128   Self().Add(actor);
1129   layer = actor;
1130 }
1131
1132 void TextEditor::SetTextSelectionRange(const uint32_t* start, const uint32_t* end)
1133 {
1134   if(mController && mController->IsShowingRealText())
1135   {
1136     mController->SetTextSelectionRange(start, end);
1137     SetKeyInputFocus();
1138   }
1139 }
1140
1141 Uint32Pair TextEditor::GetTextSelectionRange() const
1142 {
1143   Uint32Pair range(0, 0);
1144   if(mController && mController->IsShowingRealText())
1145   {
1146     range = mController->GetTextSelectionRange();
1147   }
1148   return range;
1149 }
1150
1151 void TextEditor::GetControlBackgroundColor(Vector4& color) const
1152 {
1153   Property::Value propValue = Self().GetProperty(Toolkit::Control::Property::BACKGROUND);
1154   Property::Map*  resultMap = propValue.GetMap();
1155
1156   Property::Value* colorValue = nullptr;
1157   if(resultMap && (colorValue = resultMap->Find(ColorVisual::Property::MIX_COLOR)))
1158   {
1159     colorValue->Get(color);
1160   }
1161 }
1162
1163 void TextEditor::UpdateScrollBar()
1164 {
1165   using namespace Dali;
1166
1167   float scrollPosition;
1168   float controlSize;
1169   float layoutSize;
1170   bool  latestScrolled;
1171
1172   if(!mScrollBarEnabled)
1173   {
1174     return;
1175   }
1176   latestScrolled = mController->GetTextScrollInfo(scrollPosition, controlSize, layoutSize);
1177   if(!latestScrolled || controlSize > layoutSize)
1178   {
1179     return;
1180   }
1181
1182   CustomActor self = Self();
1183   if(!mScrollBar)
1184   {
1185     mScrollBar = Toolkit::ScrollBar::New(Toolkit::ScrollBar::VERTICAL);
1186     mScrollBar.SetIndicatorHeightPolicy(Toolkit::ScrollBar::VARIABLE);
1187     mScrollBar.SetProperty(Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_RIGHT);
1188     mScrollBar.SetProperty(Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_RIGHT);
1189     mScrollBar.SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::HEIGHT);
1190     mScrollBar.SetResizePolicy(ResizePolicy::FIT_TO_CHILDREN, Dimension::WIDTH);
1191
1192     // Register the scroll position property
1193     Property::Index propertyScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION, scrollPosition);
1194     // Register the minimum scroll position property
1195     Property::Index propertyMinScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MIN, 0.0f);
1196     // Register the maximum scroll position property
1197     Property::Index propertyMaxScrollPosition = self.RegisterProperty(SCROLL_BAR_POSITION_MAX, (layoutSize - controlSize));
1198     // Register the scroll content size property
1199     Property::Index propertyScrollContentSize = self.RegisterProperty(SCROLL_BAR_CONTENT_SIZE, layoutSize);
1200
1201     mScrollBar.SetScrollPropertySource(self, propertyScrollPosition, propertyMinScrollPosition, propertyMaxScrollPosition, propertyScrollContentSize);
1202
1203     // Set style name of ScrollBar for styling
1204     mScrollBar.SetStyleName("TextEditorScrollBar");
1205     Toolkit::Control scrollIndicator = Toolkit::Control::DownCast(mScrollBar.GetScrollIndicator());
1206     if(scrollIndicator)
1207     {
1208       // Set style name of ScrollBarIndicator for styling
1209       scrollIndicator.SetStyleName("TextEditorScrollBarIndicator");
1210     }
1211
1212     self.Add(mScrollBar);
1213   }
1214   else
1215   {
1216     Property::Index propertyScrollPosition    = self.GetPropertyIndex(SCROLL_BAR_POSITION);
1217     Property::Index propertyMaxScrollPosition = self.GetPropertyIndex(SCROLL_BAR_POSITION_MAX);
1218     Property::Index propertyScrollContentSize = self.GetPropertyIndex(SCROLL_BAR_CONTENT_SIZE);
1219
1220     self.SetProperty(propertyScrollPosition, scrollPosition);
1221     self.SetProperty(propertyMaxScrollPosition, (layoutSize - controlSize));
1222     self.SetProperty(propertyScrollContentSize, layoutSize);
1223   }
1224
1225   // If scrolling is not started, start scrolling and emit ScrollStateChangedSignal
1226   if(!mScrollStarted)
1227   {
1228     mScrollStarted = true;
1229     Dali::Toolkit::TextEditor handle(GetOwner());
1230     mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::STARTED);
1231   }
1232
1233   Actor indicator = mScrollBar.GetScrollIndicator();
1234   if(mAnimation)
1235   {
1236     mAnimation.Stop(); // Cancel any animation
1237   }
1238   else
1239   {
1240     mAnimation = Animation::New(mAnimationPeriod.durationSeconds);
1241   }
1242   indicator.SetProperty(Actor::Property::OPACITY, 1.0f);
1243   mAnimation.AnimateTo(Property(indicator, Actor::Property::COLOR_ALPHA), 0.0f, AlphaFunction::EASE_IN, mAnimationPeriod);
1244   mAnimation.Play();
1245   mAnimation.FinishedSignal().Connect(this, &TextEditor::OnScrollIndicatorAnimationFinished);
1246 }
1247
1248 void TextEditor::OnScrollIndicatorAnimationFinished(Animation& animation)
1249 {
1250   // If animation is successfully ended, then emit ScrollStateChangedSignal
1251   if(Dali::EqualsZero(animation.GetCurrentProgress()))
1252   {
1253     mScrollStarted = false;
1254     Dali::Toolkit::TextEditor handle(GetOwner());
1255     mScrollStateChangedSignal.Emit(handle, Toolkit::TextEditor::Scroll::FINISHED);
1256   }
1257 }
1258
1259 void TextEditor::OnSceneConnect(Dali::Actor actor)
1260 {
1261   if(mHasBeenStaged)
1262   {
1263     RenderText(static_cast<Text::Controller::UpdateTextType>(Text::Controller::MODEL_UPDATED | Text::Controller::DECORATOR_UPDATED));
1264   }
1265   else
1266   {
1267     mHasBeenStaged = true;
1268   }
1269 }
1270
1271 InputMethodContext::CallbackData TextEditor::OnInputMethodContextEvent(Dali::InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
1272 {
1273   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::OnInputMethodContextEvent %p eventName %d\n", mController.Get(), inputMethodContextEvent.eventName);
1274   return mController->OnInputMethodContextEvent(inputMethodContext, inputMethodContextEvent);
1275 }
1276
1277 void TextEditor::GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType)
1278 {
1279   if(mDecorator)
1280   {
1281     Property::Map map;
1282     map[TextEditor::PropertyHandler::IMAGE_MAP_FILENAME_STRING] = mDecorator->GetHandleImage(handleType, handleImageType);
1283
1284     value = map;
1285   }
1286 }
1287
1288 void TextEditor::OnClipboardTextSelected(ClipboardEventNotifier& clipboard)
1289 {
1290   mController->PasteClipboardItemEvent();
1291 }
1292
1293 void TextEditor::KeyboardStatusChanged(bool keyboardShown)
1294 {
1295   DALI_LOG_INFO(gTextEditorLogFilter, Debug::Verbose, "TextEditor::KeyboardStatusChanged %p keyboardShown %d\n", mController.Get(), keyboardShown);
1296
1297   // Just hide the grab handle when keyboard is hidden.
1298   if(!keyboardShown)
1299   {
1300     mController->KeyboardFocusLostEvent();
1301   }
1302   else
1303   {
1304     mController->KeyboardFocusGainEvent(); // Initially called by OnKeyInputFocusGained
1305   }
1306 }
1307
1308 void TextEditor::OnSceneConnection(int depth)
1309 {
1310   // Sets the depth to the visuals inside the text's decorator.
1311   mDecorator->SetTextDepth(depth);
1312
1313   // The depth of the text renderer is set in the RenderText() called from OnRelayout().
1314
1315   // Call the Control::OnSceneConnection() to set the depth of the background.
1316   Control::OnSceneConnection(depth);
1317 }
1318
1319 bool TextEditor::OnTouched(Actor actor, const TouchEvent& touch)
1320 {
1321   return false;
1322 }
1323
1324 void TextEditor::OnIdleSignal()
1325 {
1326   // Emits the change of input style signals.
1327   mController->ProcessInputStyleChangedSignals();
1328
1329   // Set the pointer to null as the callback manager deletes the callback after execute it.
1330   mIdleCallback = NULL;
1331 }
1332
1333 void TextEditor::ApplyScrollPosition()
1334 {
1335   const Vector2& scrollOffset = mController->GetTextModel()->GetScrollPosition();
1336   float          scrollAmount = 0.0f;
1337
1338   if(mScrollAnimationEnabled)
1339   {
1340     scrollAmount = mController->GetScrollAmountByUserInput();
1341   }
1342   if(mTextVerticalScroller)
1343   {
1344     mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1345   }
1346   else if(Equals(scrollAmount, 0.0f, Math::MACHINE_EPSILON_1))
1347   {
1348     mRenderableActor.SetProperty(Actor::Property::POSITION, Vector2(scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount));
1349   }
1350   else
1351   {
1352     mTextVerticalScroller = Text::TextVerticalScroller::New();
1353     if(!Equals(mScrollAnimationDuration, 0.0f, Math::MACHINE_EPSILON_1))
1354     {
1355       mTextVerticalScroller->SetDuration(mScrollAnimationDuration);
1356     }
1357     mTextVerticalScroller->CheckStartAnimation(mRenderableActor, scrollOffset.x + mAlignmentOffset, scrollOffset.y - scrollAmount, scrollAmount);
1358   }
1359 }
1360
1361 bool TextEditor::IsEditable() const
1362 {
1363   return mController->IsEditable();
1364 }
1365
1366 void TextEditor::SetEditable(bool editable)
1367 {
1368   mController->SetEditable(editable);
1369   if(mInputMethodContext && !editable)
1370   {
1371     mInputMethodContext.Deactivate();
1372   }
1373 }
1374
1375 void TextEditor::OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type)
1376 {
1377   mController->ChangedLayoutDirection();
1378 }
1379
1380 TextEditor::TextEditor(ControlBehaviour additionalBehaviour)
1381 : Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
1382   mAnimationPeriod(0.0f, 0.0f),
1383   mIdleCallback(NULL),
1384   mAlignmentOffset(0.f),
1385   mScrollAnimationDuration(0.f),
1386   mLineSpacing(0.f),
1387   mRenderingBackend(DEFAULT_RENDERING_BACKEND),
1388   mHasBeenStaged(false),
1389   mScrollAnimationEnabled(false),
1390   mScrollBarEnabled(false),
1391   mScrollStarted(false),
1392   mTextChanged(false),
1393   mCursorPositionChanged(false),
1394   mSelectionChanged(false),
1395   mSelectionCleared(false),
1396   mOldPosition(0u),
1397   mOldSelectionStart(0u),
1398   mOldSelectionEnd(0u),
1399   mSelectionStarted(false)
1400 {
1401 }
1402
1403 TextEditor::~TextEditor()
1404 {
1405   UnparentAndReset(mStencil);
1406
1407   if((NULL != mIdleCallback) && Adaptor::IsAvailable())
1408   {
1409     // Removes the callback from the callback manager in case the text-editor is destroyed before the callback is executed.
1410     Adaptor::Get().RemoveIdle(mIdleCallback);
1411   }
1412 }
1413
1414 std::string TextEditor::TextEditorAccessible::GetName() const
1415 {
1416   return GetWholeText();
1417 }
1418
1419 const std::vector<Toolkit::TextAnchor>& TextEditor::TextEditorAccessible::GetTextAnchors() const
1420 {
1421   auto self = Toolkit::TextEditor::DownCast(Self());
1422
1423   return Toolkit::GetImpl(self).mAnchorActors;
1424 }
1425
1426 Toolkit::Text::ControllerPtr TextEditor::TextEditorAccessible::GetTextController() const
1427 {
1428   auto self = Toolkit::TextEditor::DownCast(Self());
1429
1430   return Toolkit::GetImpl(self).GetTextController();
1431 }
1432
1433 void TextEditor::TextEditorAccessible::RequestTextRelayout()
1434 {
1435   auto  self     = Toolkit::TextEditor::DownCast(Self());
1436   auto& selfImpl = Toolkit::GetImpl(self);
1437
1438   selfImpl.RequestTextRelayout();
1439 }
1440
1441 } // namespace Internal
1442
1443 } // namespace Toolkit
1444
1445 } // namespace Dali