docs/content/shared-javascript-and-cpp-documentation/text-field.md

   1 <!--
   2 /**-->
   3
   4 # Text Field {#text-field}
   5
   6 ## Overview
   7
   8 The Dali::Toolkit::TextField is a control which provides a single-line editable text field.
   9
  10 ### Basic usage
  11
  12 Before any text has been entered, the TextField can display some placeholder text.
  13 An alternative placeholder can be displayed when the TextField has keyboard focus.
  14 For example a TextField used to enter a username could initially show "Unknown Name", and then show "Enter Name." when the cursor is shown.
  15
  16 ~~~{.cpp}
  17 // C++
  18
  19 TextField field = TextField::New();
  20 field.SetProperty( TextField::Property::PLACEHOLDER_TEXT, "Unnamed Name" );
  21 field.SetProperty( TextField::Property::PLACEHOLDER_TEXT_FOCUSED, "Enter Name." );
  22
  23 Stage::GetCurrent().Add( field );
  24 ~~~
  25
  26 ~~~{.js}
  27 // JavaScript
  28
  29 var field = new dali.TextField();
  30 field.placeholderText = "Unnamed Name";
  31 field.placeholderTextFocused = "Enter Name.";
  32
  33 dali.stage.add( field );
  34 ~~~
  35
  36 When the TextField is tapped, it will automatically gain the keyboard focus. Key events will then result in text being inserted, and the placeholder text will be removed.
  37 After text has been entered, it can be retrieved from the TEXT property.
  38
  39 ~~~{.cpp}
  40 // C++
  41
  42 Property::Value fieldText = field.GetProperty( TextField::Property::TEXT );
  43 std::cout << "Received text: " << fieldText.Get< std::string >() << std::endl;
  44 ~~~
  45
  46 ~~~{.js}
  47 // JavaScript
  48
  49 console.log( field.text );
  50 ~~~
  51
  52 ### Font Selection
  53
  54 By default TextField will automatically select a suitable font from the platform. However, a different font could be selected. See the [Font Selection](@ref font-selection) section for more details.
  55
  56 ### Text Alignment
  57
  58 TextField displays a single-line of text, which will scroll if there is not enough room for the text displayed.
  59 If there is enough room, then the text can be aligned horizontally to the beginning, end, or center of the available area:
  60
  61 ~~~{.cpp}
  62 // C++
  63
  64 field.SetProperty( TextField::Property::HORIZONTAL_ALIGNMENT, "BEGIN" ); // "CENTER" or "END"
  65 ~~~
  66
  67 ~~~{.js}
  68 // JavaScript
  69
  70 field.HorizontalAlignment = "BEGIN"; // "CENTER" or "END"
  71 ~~~
  72
  73 ### Copy and Paste  (Selection)
  74
  75 Text can be selected by a long press or double tapping it.   Depending on certain conditions a popup could be shown giving options including [CUT][COPY][PASTE], [SELECT ALL] or [CLIPBOARD]. Below these conditions will be explained.
  76
  77 [CUT] or [COPY] send the selected text to the clipboard ready to be pasted directly or via the clipboard UI.   Pressing [PASTE] will paste the top item from the clipboard (what has just been copied, possibly from another application).  If the system supports a clipboard UI this can be displayed by pressing the [CLIPBOARD] button.
  78
  79 Empty text means the user has not inputted any text, a TextField containing special characters or purely whitespace is not empty.
  80
  81 Below shows how the popup will look depending on the state of the TextField
  82
  83 |  |  |
  84 |--|--|
  85 | Condition: Long press/double tap when empty text but clipboard has content  |  Condition: Long press/double tap when TextField contains text |
  86 |[PASTE][CLIPBOARD] buttons shown| [CUT][COPY], [SELECT ALL] unless all text selected and [PASTE][CLIPBOARD] if content to paste. |
  87 |    ![ ](../assets/img/text-controls/EmptyTextClipboardHasContent.png) ![ ](./EmptyTextClipboardHasContent.png) |   ![ ](../assets/img/text-controls/SelectingText.png) ![ ](./SelectingText.png) |
  88 | Condition: Long press/double tap popup when TextField contains just whitespace | Condition: Empty text & clipboard empty |
  89 | Whitespace treated as regular text, [CUT][COPY] shown and [PASTE][CLIPBOARD] if content to paste. As all text is selected there is no need for [SELECT ALL] |  No popup shown after longpress/double tap|
  90 |  ![ ](../assets/img/text-controls/SelectAllWhitespace.png) ![ ](./SelectAllWhitespace.png) | ![ ](../assets/img/text-controls/EmptyTextAndNoContentToPaste.png) ![ ](./EmptyTextAndNoContentToPaste.png)|
  91 | Condition: Longpress/(double tap) on whitespace which is following text | Condition: Tapping text or panning grab handle |
  92 | [PASTE][CLIPBOARD] shown if something to paste. [SELECT ALL] as more text to select | If content in clipboard [PASTE][CLIPBOARD] popup will be shown. |
  93 | ![ ](../assets/img/text-controls/SelectWhitespaceAfterText.png) ![ ](./SelectWhitespaceAfterText.png) | ![ ](../assets/img/text-controls/TapAfterCopyingText.png) ![ ](./TapAfterCopyingText.png) |
  94
  95 ### TextField Decorations
  96
  97 #### Color
  98
  99 To change the color of the text, the recommended way is to use the TEXT_COLOR property.
 100 An alternative color can be used for placeholder text by setting PLACEHOLDER_TEXT_COLOR.
 101 Note that unlike the Actor::COLOR property, these properties will not affect child Actors added to the TextField.
 102
 103 ~~~{.cpp}
 104 // C++
 105 field.SetProperty( TextField::Property::TEXT_COLOR, Color::CYAN );
 106 field.SetProperty( TextField::Property::PLACEHOLDER_TEXT_COLOR, Color::BLACK );
 107 ~~~
 108
 109 ~~~{.js}
 110 // JavaScript
 111
 112 field.textColor = dali.COLOR_CYAN;
 113 field.placeholderTextColor = dali.COLOR_BLACK;
 114 ~~~
 115
 116 ### Text Field Properties
 117
 118  Name (JavaScript)                 |  Name (C++)                          |  Type        | Writable     | Animatable
 119 -----------------------------------|--------------------------------------|--------------|--------------|-----------
 120  renderingBackend                  | RENDERING_BACKEND                    |  INTEGER     | O            | X
 121  text                              | TEXT                                 |  STRING      | O            | X
 122  placeholderText                   | PLACEHOLDER_TEXT                     |  STRING      | O            | X
 123  placeholderTextFocused            | PLACEHOLDER_TEXT_FOCUSED             |  STRING      | O            | X
 124  fontFamily                        | FONT_FAMILY                          |  STRING      | O            | X
 125  fontStyle                         | FONT_STYLE                           |  STRING      | O            | X
 126  pointSize                         | POINT_SIZE                           |  FLOAT       | O            | X
 127  maxLength                         | MAX_LENGTH                           |  INTEGER     | O            | X
 128  exceedPolicy                      | EXCEED_POLICY                        |  INTEGER     | O            | X
 129  horizontalAlignment               | HORIZONTAL_ALIGNMENT                 |  STRING      | O            | X
 130  verticalAlignment                 | VERTICAL_ALIGNMENT                   |  STRING      | O            | X
 131  textColor                         | TEXT_COLOR                           |  VECTOR4     | O            | X
 132  shadowOffset                      | SHADOW_OFFSET                        |  VECTOR2     | O            | X
 133  shadowColor                       | SHADOW_COLOR                         |  VECTOR4     | O            | X
 134  primaryCursorColor                | PRIMARY_CURSOR_COLOR                 |  VECTOR4     | O            | X
 135  secondaryCursorColor              | SECONDARY_CURSOR_COLOR               |  VECTOR4     | O            | X
 136  enableCursorBlink                 | ENABLE_CURSOR_BLINK                  |  BOOLEAN     | O            | X
 137  cursorBlinkInterval               | CURSOR_BLINK_INTERVAL                |  FLOAT       | O            | X
 138  cursorBlinkDuration               | CURSOR_BLINK_DURATION                |  FLOAT       | O            | X
 139  grabHandleImage                   | GRAB_HANDLE_IMAGE                    |  STRING      | O            | X
 140  grabHandlePressedImage            | GRAB_HANDLE_PRESSED_IMAGE            |  STRING      | O            | X
 141  scrollThreshold                   | SCROLL_THRESHOLD                     |  FLOAT       | O            | X
 142  scrollSpreed                      | SCROLL_SPEED                         |  FLOAT       | O            | X
 143  selectionHandleImageLeft          | SELECTION_HANDLE_IMAGE_LEFT          |  STRING      | O            | X
 144  selectionHandleImageRight         | SELECTION_HANDLE_IMAGE_RIGHT         |  STRING      | O            | X
 145  selectionHandlePressedImageLeft   | SELECTION_HANDLE_PRESSED_IMAGE_LEFT  |  STRING      | O            | X
 146  selectionHandlePressedImageRight  | SELECTION_HANDLE_PRESSED_IMAGE_RIGHT |  STRING      | O            | X
 147  selectionHighlightColor           | SELECTION_HIGHLIGHT_COLOR            |  VECTOR4     | O            | X
 148  decorationBoundingBox             | DECORATION_BOUNDING_BOX              |  RECTANGLE   | O            | X
 149  inputMethodSettings               | INPUT_METHOD_SETTINGS                |  MAP         | O            | X
 150
 151 @class TextField
 152
 153 */