Stage::GetCurrent().Add( label );
~~~
-~~~{.js}
-// JavaScript
-
-var label = new dali.TextLabel();
-
-label.text = "Hello World";
-label.anchorPoint = dali.TOP_LEFT;
-
-dali.stage.add( label );
-~~~
-
The label must also be added to the stage, or to an actor which is on the stage.
The position of the label on-screen is dependent on the parentOrigin and anchorPoint properties.
| | |
|--|--|
-| (ParentOrigin::TOP_LEFT, AnchorPoint::TOP_LEFT) | ![ ](../assets/img/text-controls/TextLabelTopLeft.png) ![ ](TextLabelTopLeft.png) |
+| (ParentOrigin::TOP_LEFT, AnchorPoint::TOP_LEFT) | ![ ](TextLabelTopLeft.png) |
### Font Selection
label.SetProperty( TextLabel::Property::MULTI_LINE, true );
~~~
-~~~{.js}
-// JavaScript
-
-label.mutliLine = true;
-~~~
-
The text can be either aligned horizontally to the beginning, end, or center of the available area:
~~~{.cpp}
label.SetProperty( TextLabel::Property::HORIZONTAL_ALIGNMENT, "BEGIN" ); // "CENTER" or "END"
~~~
-~~~{.js}
-// JavaScript
-
-label.HorizontalAlignment = "BEGIN"; // "CENTER" or "END"
-~~~
-
| | |
|--|--|
| Here is the "BEGIN" alignment shown for left-to-right (Latin) | right-to-left (Arabic) scripts |
-| ![ ](../assets/img/text-controls/LatinBegin.png) ![ ](LatinBegin.png) | ![ ](../assets/img/text-controls/ArabicBegin.png) ![ ](ArabicBegin.png) |
+| ![ ](LatinBegin.png) | ![ ](ArabicBegin.png) |
| Here is the "CENTER" alignment shown for left-to-right (Latin) | right-to-left (Arabic) scripts:|
-| ![ ](../assets/img/text-controls/LatinCenter.png) ![ ](LatinCenter.png) | ![ ](../assets/img/text-controls/ArabicCenter.png) ![ ](ArabicCenter.png) |
+| ![ ](LatinCenter.png) | ![ ](ArabicCenter.png) |
| Here is the "END" alignment shown for left-to-right (Latin) | right-to-left (Arabic) scripts:|
-| ![ ](../assets/img/text-controls/LatinEnd.png) ![ ](LatinEnd.png) | ![ ](../assets/img/text-controls/ArabicEnd.png) ![ ](ArabicEnd.png) |
+| ![ ](LatinEnd.png) | ![ ](ArabicEnd.png) |
label.SetProperty( Toolkit::DevelTextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION, true );
~~~
-~~~{.js}
-// JavaScript
-
-label.matchSystemLanguageDirection = true;
-~~~
-
| | |
|--|--|
| Current system language direction left-to-right | |
| MATCH_SYSTEM_LANGUAGE_DIRECTION set to TRUE. | MATCH_SYSTEM_LANGUAGE_DIRECTION set to FALSE (default). |
| BEGIN alignment | BEGIN alignment |
-| ![ ](../assets/img/text-controls/HelloWorld-System-BEGIN.png) ![ ](HelloWorld-System-BEGIN.png) | ![ ](../assets/img/text-controls/HelloWorld-Default-BEGIN.png) ![ ](HelloWorld-Default-BEGIN.png) |
+| ![ ](HelloWorld-System-BEGIN.png) | ![ ](HelloWorld-Default-BEGIN.png) |
| CENTER alignment | CENTER alignment |
-| ![ ](../assets/img/text-controls/HelloWorld-System-CENTER.png) ![ ](HelloWorld-System-CENTER.png) | ![ ](../assets/img/text-controls/HelloWorld-Default-CENTER.png) ![ ](HelloWorld-Default-CENTER.png) |
+| ![ ](HelloWorld-System-CENTER.png) | ![ ](HelloWorld-Default-CENTER.png) |
| END alignment | END alignment |
-| ![ ](../assets/img/text-controls/HelloWorld-System-END.png) ![ ](HelloWorld-System-END.png) | ![ ](../assets/img/text-controls/HelloWorld-Default-END.png) ![ ](HelloWorld-Default-END.png) |
+| ![ ](HelloWorld-System-END.png) | ![ ](HelloWorld-Default-END.png) |
| | |
|--|--|
| Current system language direction left-to-right | Current system language direction right-to-left |
-| ![ ](../assets/img/text-controls/LTR_order.png) ![ ](LTR_order.png) | ![ ](../assets/img/text-controls/RTL_order.png) ![ ](RTL_order.png) |
+| ![ ](LTR_order.png) | ![ ](RTL_order.png) |
The examples above assume that the TextLabel size greater than the minimum required.
Stage::GetCurrent().Add( label );
~~~
-~~~{.js}
-// JavaScript
-
-var label = new dali.Textlabel;
-label.text = "Hello World";
-label.anchorPoint = dali.TOP_LEFT;
-
-label.widthResizePolicy = "USE_NATURAL_SIZE";
-label.heightResizePolicy = "USE_NATURAL_SIZE";
-
-label.textColor = dali.COLOR_WHITE;
-// background color not available as it's currently not a property of control
-dali.stage.add( label );
-~~~
-
- ![ ](../assets/img/text-controls/HelloWorld-NaturalSize.png)
![ ](HelloWorld-NaturalSize.png)
parent.SetFitHeight( 2 );
~~~
- ![ ](../assets/img/text-controls/HelloWorld-HeightForWidth.png)
![ ](HelloWorld-HeightForWidth.png)
label.SetProperty( TextLabel::Property::TEXT_COLOR, Color::RED );
~~~
-~~~{.js}
-// JavaScript
-
-label.text = "Red Text";
-label.textColor = dali.COLOR_RED;
-~~~
-
- ![ ](../assets/img/text-controls/RedText.png)
![ ](RedText.png)
#### Drop Shadow
~~~
-~~~{.js}
-// JavaScript
-
-dali.stage.setBackgroundColor( dali.COLOR_BLUE );
-
-label1.text = "Plain Text";
-
-
-label2.text = "Text with Shadow";
-label2.shadow = "{\"offset\":\"1 1\",\"color\":\"black\"}";
-
-label3.text = "Text with Bigger Shadow";
-label3.shadow = "{\"offset\":\"2 2\",\"color\":\"black\"}";
-
-label4.SetProperty( TextLabel::Property::TEXT, "Text with Color Soft Shadow" );
-var shadow = {
- "offset" : [ 1.0, 1.0 ],
- "color" : dali.COLOR_RED;
- "blurRadius" : 2.0
-};
-label4.shadow = shadow;
-
-~~~
-
-
-![ ](../assets/img/text-controls/PlainText.png)
![ ](PlainText.png)
-![ ](../assets/img/text-controls/TextWithShadow.png)
![ ](TextWithShadow.png)
-![ ](../assets/img/text-controls/TextWithBiggerShadow.png)
![ ](TextWithBiggerShadow.png)
-![ ](../assets/img/text-controls/TextWithColorShadow.png)
![ ](TextWithColorShadow.png)
label2.SetProperty( TextLabel::Property::UNDERLINE_ENABLED, true );
label2.SetProperty( TextLabel::Property::UNDERLINE_COLOR, Color::GREEN );
~~~
-~~~{.js}
-// JavaScript
-label1.Text = "Text with Underline";
-label1.underlineEnabled = true;
-
-label2.Text = "Text with Color Underline";
-label2.underlineEnabled = true;
-label2.underlineColor = dali.COLOR_GREEN;
-~~~
-
-![ ](../assets/img/text-controls/TextWithUnderline.png)
![ ](TextWithUnderline.png)
-![ ](../assets/img/text-controls/TextWithColorUnderline.png)
![ ](TextWithColorUnderline.png)
By default the underline height will be taken from the font metrics, however this can be overridden using the UNDERLINE_HEIGHT property:
label1.SetProperty( TextLabel::Property::UNDERLINE_HEIGHT, 1.0f );
~~~
-~~~{.js}
-// JavaScript
-
-label1.underlineHeight = 1;
-~~~
-
-![ ](../assets/img/text-controls/TextWith1pxUnderline.png)
![ ](TextWith1pxUnderline.png)
### Auto Scrolling
-![ ](../assets/img/text-controls/AutoScroll.gif)
![ ](AutoScroll.gif)
The \link text-auto-scrolling Auto text scrolling \endlink section details how to scroll text automatically.
The properties used by TextLabel are listed [here](@ref TextLabelProperties)
-@class TextLabel
*/