DroidScript Wiki

User Tools

Site Tools

Trace:
built_in:text

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
built_in:text [2014/09/17 18:20]
stevegarman 		built_in:text [2019/06/22 01:01] (current)
Line 1: Line 1:
 ====== Text control ====== ====== Text control ======
-===== Create ===== 
-Create Text objects using the **CreateText** method of the [[app]] object: 
  
 +//(Information and examples taken from the DroidScript documentation)//
 +
 +===== Description =====
 +Create Text objects using the **CreateText** method of the **[[app]]** object:
 <code>txt = app.CreateText( text, width, height, options );</code> <code>txt = app.CreateText( text, width, height, options );</code>
 You can use the **"Multiline"** option to allow multi-line text and the **"Left"** or **"Right"** options to align the text. The default is single line centered text. You can use the **"Multiline"** option to allow multi-line text and the **"Left"** or **"Right"** options to align the text. The default is single line centered text.
  
-Use the SetText and GetText functions of the Text object to set and get it's text.+Use the **SetText** and **GetText** functions of the Text object to set and get it's text. 
 + 
 +==== Example - Single line ==== 
 +<code javascript> 
 +function OnStart() 
 +{ 
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  txt = app.CreateText( "Hello" ); 
 +  txt.SetTextSize( 22 ); 
 +  lay.AddChild( txt ); 
 + 
 +  app.AddLayout( lay ); 
 +}  
 +</code> 
 +You can change the look of a Text using the **SetBackColor** and **SetTextColor** functions on the Text object. 
 + 
 +==== Example - Multi line ==== 
 +<code javascript> 
 +function OnStart() 
 +{ 
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  txt = app.CreateText( "Hello\nWorld", 0.8, 0.2, "Multiline" ); 
 +  txt.SetTextSize( 12 ); 
 +  txt.SetTextColor( "#ff6666ff" ); 
 +  txt.SetBackColor( "#ffffffff" ); 
 +  lay.AddChild( txt ); 
 + 
 +  app.AddLayout( lay ); 
 +} 
 +</code> 
 +You can also set a background image/pattern or background gradient for the Text using the **SetBackground** and **SetBackGradient** functions. See **[[built_in:layouts|Layouts]]** for examples of how to use these functions. 
 ===== Methods ===== ===== Methods =====
-^Method ^Description ^ +Some controls use the same methods.\\ 
-|txt.GetHeight| | +For examples of the **[[same methods]]** look here. 
-|txt.GetLineCount| | +^ Method                                                       ^ Description                                                                           ^ 
-|txt.GetLineStart| | +| Text.Destroy()                                               |                                                                                       | 
-|txt.GetLineTop| | +| Text.GetAbsHeight()                                          |                                                                                       | 
-|txt.GetMaxLines| | +| Text.GetAbsWidth()                                           |                                                                                       | 
-|txt.Gettxt| | +| Text.GetHeight()                                             |                                                                                       | 
-|txt.GetVisibility| | +| Text.GetLineCount()                                          |                                                                                       | 
-|txt.GetWidth| | +| Text.GetLineStart( line )                                    |                                                                                       | 
-|txt.Release| | +| Text.GetLineTop( line )                                      |                                                                                       | 
-|txt.SetBackColor| | +| Text.GetMaxLines()                                           |                                                                                       | 
-|txt.SetBackGradient| | +| Text.GetPosition()                                           |                                                                                       | 
-|txt.SetBackGradientRadial| | +| Text.GetText()                                               |                                                                                       | 
-|txt.SetBackground| | +| Text.GetTextSize( mode )                                     |                                                                                       | 
-|txt.SetHtml| | +| [[built_in:gettype|Text.GetType()]]                          | Returns "Text"                                                                        | 
-|txt.SetMargins| | +| Text.GetVisibility()                                         |                                                                                       | 
-|txt.SetOnLongTouch| | +| Text.GetWidth()                                              |                                                                                       | 
-|txt.SetOnTouch| | +| Text.Release()                                               |                                                                                       | 
-|txt.SetOnTouchDown| | +| Text.SetBackColor( color )                                   |                                                                                       | 
-|txt.SetOnTouchMove| | +| Text.SetBackGradient( color1,color2,color3,p4,p5,p6,p7 )     |                                                                                       | 
-|txt.SetOnTouchUp| | +| Text.SetBackGradientRadial( x,y,r,color1,color2,color3,p7 )  |                                                                                       | 
-|txt.SetPadding| | +| Text.SetBackground( imagefile,options )                      |                                                                                       | 
-|txt.SetPosition| | +| Text.SetEllipsize( mode )                                    | Shorten long text with "..."  mode="**Start**","**Middle**", "**End**" or "**marq**"  | 
-|txt.SetSize| | +| Text.SetFontFile( file )                                     |                                                                                       | 
-|txt.Settxt| | +| Text.SetHtml( html )                                         |                                                                                       | 
-|txt.SettxtColor| | +| Text.SetMargins( left,top,right,bottom )                     |                                                                                       | 
-|txt.SettxtSize| | +| Text.SetOnLongTouch( callback )                              |                                                                                       | 
-|txt.SetTouchable| | +| Text.SetOnTouch( callback )                                  |                                                                                       | 
-|txt.SetVisibility! !+| Text.SetOnTouchDown( callback )                              |                                                                                       | 
 +| Text.SetOnTouchMove( callback )                              |                                                                                       | 
 +| Text.SetOnTouchUp( callback )                                |                                                                                       | 
 +| Text.SetPadding( left,top,right,bottom )                     |                                                                                       | 
 +| Text.SetPosition( left,top,width,height )                    |                                                                                       | 
 +| Text.SetScale( x,y )                                         |                                                                                       | 
 +| Text.SetSize( width,height )                                 |                                                                                       | 
 +| Text.SetText( text )                                         |                                                                                       | 
 +| Text.SetTextColor( color )                                   |                                                                                       | 
 +| Text.SetTextShadow( radius,dx,dy,color )                     |                                                                                       | 
 +| Text.SetTextSize( size,mode )                                |                                                                                       | 
 +| Text.SetTouchable( touchable )                               |                                                                                       | 
 +| Text.SetVisibility( HideShow )                               |                                                                                       | 
 + 
 +===== Options ===== 
 + 
 +^ Option       ^ Description                                          ^ 
 +| AutoScale    | reduces text size to fit if needed                   | 
 +| Bold         | Write bold Text                                      | 
 +| FontAwesome  | Use this to display Icons \\ from this inbuilt font  | 
 +| Html         |                                                      | 
 +| Left         |                                                      | 
 +| Monospace    | use monospace font                                   | 
 +| Multiline    |                                                      | 
 +| Right        |                                                      | 
 +| NoWrap       |                                                      | 
 +| Log          | Log=='multiline,left,nowrap'                         | 
 + 
built_in/text.1410978042.txt.gz · Last modified: 2014/09/18 02:20 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki