| Package | mx.core |
| Class | public class FTETextField |
| Inheritance | FTETextField  Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFontContextComponent |
| Subclasses | UIFTETextField |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| alwaysShowSelection : Boolean
This property is not implemented in FTETextField
because FTETextField does not support selection. | FTETextField | ||
| antiAliasType : String
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField. | FTETextField | ||
| autoSize : String
Controls automatic sizing and alignment of text fields. | FTETextField | ||
| background : Boolean
Specifies whether the text field has a background fill. | FTETextField | ||
| backgroundColor : uint
The color of the text field background. | FTETextField | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| border : Boolean
Specifies whether the text field has a border. | FTETextField | ||
| borderColor : uint
The color of the text field border. | FTETextField | ||
| bottomScrollV : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| caretIndex : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support editing. | FTETextField | ||
| condenseWhite : Boolean
A Boolean value that specifies whether extra white space (spaces, line breaks, and so on)
in a text field with HTML text is removed. | FTETextField | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| defaultTextFormat : flash.text:TextFormat
Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the
replaceSelectedText() method. | FTETextField | ||
| direction : String
The directionality of the text displayed by the FTETextField. | FTETextField | ||
| displayAsPassword : Boolean
This property has not been implemented in FTETextField
because FTETextField does not support editing. | FTETextField | ||
| doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| embedFonts : Boolean
Specifies whether to render by using embedded font outlines. | FTETextField | ||
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| fontContext : IFlexModuleFactory
The IFlexModuleFactory instance that FTETextField
uses for creating TextLine objects. | FTETextField | ||
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| gridFitType : String
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField. | FTETextField | ||
| height : Number
Indicates the height of the display object, in pixels. | DisplayObject | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| htmlText : String
Contains the HTML representation of the text field contents. | FTETextField | ||
| length : int [read-only]
The number of characters in a text field. | FTETextField | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| locale : String
The locale of the text displayed by FTETextField. | FTETextField | ||
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxChars : int
This property has not been implemented in FTETextField
because FTETextField does not support editing. | FTETextField | ||
| maxScrollH : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| maxScrollV : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseWheelEnabled : Boolean
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| multiline : Boolean
This property has no effect in FTETextField
because FTETextField does not support editing. | FTETextField | ||
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| numLines : int [read-only]
Defines the number of text lines in a multiline text field. | FTETextField | ||
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | |
| restrict : String
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | |
| rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | |
| scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| scrollH : int
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollV : int
This property has not been implemented in FTETextField
because FTETextField does not support scrolling. | FTETextField | ||
| selectable : Boolean
Setting this property has no effect in FTETextField
because FTETextField does not support selection. | FTETextField | ||
| selectionBeginIndex : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support selection. | FTETextField | ||
| selectionEndIndex : int [read-only]
This property has not been implemented in FTETextField
because FTETextField does not support selection. | FTETextField | ||
| sharpness : Number
This property has no effect in FTETextField. | FTETextField | ||
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| styleSheet : StyleSheet
Attaches a style sheet to the text field. | FTETextField | ||
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| text : String
A string that is the current text in the text field. | FTETextField | ||
| textColor : uint
The color of the text in a text field, in hexadecimal format. | FTETextField | ||
| textHeight : Number [read-only]
The height of the text in pixels. | FTETextField | ||
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| textWidth : Number [read-only]
The width of the text in pixels. | FTETextField | ||
| thickness : Number
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField. | FTETextField | ||
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| type : String
The type of the text field. | FTETextField | ||
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| useRichTextClipboard : Boolean
This property is not implemented in FTETextField
because FTETextField does not support selection
or clipboard operations. | FTETextField | ||
| visible : Boolean
Whether or not the display object is visible. | DisplayObject | |
| width : Number
Indicates the width of the display object, in pixels. | DisplayObject | |
| wordWrap : Boolean
A Boolean value that indicates whether the text field has word wrap. | FTETextField | ||
| x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | |
| y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | |
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | FTETextField | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
Returns metrics information about a given text line. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
This method has been implemented in FTETextField
to simply return a copy of the defaultTextFormat,
because FTETextField does not support formatting a range. | FTETextField | ||
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
This method has not been implemented in FTETextField
because very few components use it in TextField. | FTETextField | ||
|
Raises a virtual keyboard. | InteractiveObject | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
This method has not been implemented in FTETextField
because FTETextField does not support selection. | FTETextField | ||
This method has no effect on a FTETextField if beginIndex
or endIndex does not equal -1
because FTETextField does not support formatting a range. | FTETextField | ||
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
alwaysShowSelection | property |
alwaysShowSelection:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property is not implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.
Implementation
public function get alwaysShowSelection():Boolean public function set alwaysShowSelection(value:Boolean):voidRelated API Elements
antiAliasType | property |
antiAliasType:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField.
Getting it will always return null
and setting it will do nothing.
Implementation
public function get antiAliasType():String public function set antiAliasType(value:String):voidRelated API Elements
autoSize | property |
autoSize:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Controls automatic sizing and alignment of text fields.
Acceptable values for the TextFieldAutoSize constants: TextFieldAutoSize.NONE (the default),
TextFieldAutoSize.LEFT, TextFieldAutoSize.RIGHT, and TextFieldAutoSize.CENTER.
If autoSize is set to TextFieldAutoSize.NONE (the default) no resizing occurs.
If autoSize is set to TextFieldAutoSize.LEFT, the text is
treated as left-justified text, meaning that the left margin of the text field remains fixed and any
resizing of a single line of the text field is on the right margin. If the text includes a line break
(for example, "\n" or "\r"), the bottom is also resized to fit the next
line of text. If wordWrap is also set to true, only the bottom
of the text field is resized and the right side remains fixed.
If autoSize is set to TextFieldAutoSize.RIGHT, the text is treated as
right-justified text, meaning that the right margin of the text field remains fixed and any resizing
of a single line of the text field is on the left margin. If the text includes a line break
(for example, "\n" or "\r"), the bottom is also resized to fit the next
line of text. If wordWrap is also set to true, only the bottom
of the text field is resized and the left side remains fixed.
If autoSize is set to TextFieldAutoSize.CENTER, the text is treated as
center-justified text, meaning that any resizing of a single line of the text field is equally distributed
to both the right and left margins. If the text includes a line break (for example, "\n" or
"\r"), the bottom is also resized to fit the next line of text. If wordWrap is also
set to true, only the bottom of the text field is resized and the left and
right sides remain fixed.
Implementation
public function get autoSize():String public function set autoSize(value:String):voidbackground | property |
background:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the text field has a background fill. If true, the text field has a
background fill. If false, the text field has no background fill.
Use the backgroundColor property to set the background color of a text field.
Implementation
public function get background():Boolean public function set background(value:Boolean):voidbackgroundColor | property |
backgroundColor:uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The color of the text field background. The default value is 0xFFFFFF (white).
This property can be retrieved or set, even if there currently is no background, but the
color is visible only if the text field has the background property set to
true.
Implementation
public function get backgroundColor():uint public function set backgroundColor(value:uint):voidborder | property |
border:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the text field has a border. If true, the text field has a border.
If false, the text field has no border. Use the borderColor property
to set the border color.
Implementation
public function get border():Boolean public function set border(value:Boolean):voidborderColor | property |
borderColor:uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The color of the text field border. The default value is 0x000000 (black).
This property can be retrieved or set, even if there currently is no border, but the
color is visible only if the text field has the border property set to
true.
Implementation
public function get borderColor():uint public function set borderColor(value:uint):voidbottomScrollV | property |
bottomScrollV:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get bottomScrollV():intRelated API Elements
caretIndex | property |
caretIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.
Implementation
public function get caretIndex():intRelated API Elements
condenseWhite | property |
condenseWhite:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A Boolean value that specifies whether extra white space (spaces, line breaks, and so on)
in a text field with HTML text is removed. The default value is false.
The condenseWhite property only affects text set with
the htmlText property, not the text property. If you set
text with the text property, condenseWhite is ignored.
If condenseWhite is set to true, use standard HTML commands such as
<BR> and <P> to place line breaks in the text field.
Set the condenseWhite property before setting the htmlText property.
Implementation
public function get condenseWhite():Boolean public function set condenseWhite(value:Boolean):voiddefaultTextFormat | property |
defaultTextFormat:flash.text:TextFormat| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the
replaceSelectedText() method.
Note: When selecting characters to be replaced with setSelection() and
replaceSelectedText(), the defaultTextFormat will be applied only if the
text has been selected up to and including the last character. Here is an example:
var my_txt:TextField new TextField();
my_txt.text = "Flash Macintosh version";
var my_fmt:TextFormat = new TextFormat();
my_fmt.color = 0xFF0000;
my_txt.defaultTextFormat = my_fmt;
my_txt.setSelection(6,15); // partial text selected - defaultTextFormat not applied
my_txt.setSelection(6,23); // text selected to end - defaultTextFormat applied
my_txt.replaceSelectedText("Windows version");
When you access the defaultTextFormat property, the returned TextFormat object has all
of its properties defined. No property is null.
Note: You can't set this property if a style sheet is applied to the text field.
Implementation
public function get defaultTextFormat():flash.text:TextFormat public function set defaultTextFormat(value:flash.text:TextFormat):voiddirection | property |
direction:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The directionality of the text displayed by the FTETextField.
The allowed values are "ltr" for left-to-right text,
as in Latin-style scripts,
and "rtl" for right-to-left text,
as in Arabic and Hebrew.
Note: This property does not exist in the flash.text.TextField API.
The default value is "ltr".
Implementation
public function get direction():String public function set direction(value:String):voiddisplayAsPassword | property |
displayAsPassword:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.
Implementation
public function get displayAsPassword():Boolean public function set displayAsPassword(value:Boolean):voidRelated API Elements
embedFonts | property |
embedFonts:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether to render by using embedded font outlines.
If false, Flash Player renders the text field by using
device fonts.
If you set the embedFonts property to true for a text field,
you must specify a font for that text by using the font property of
a TextFormat object applied to the text field.
If the specified font is not embedded in the SWF file, the text is not displayed.
Implementation
public function get embedFonts():Boolean public function set embedFonts(value:Boolean):voidfontContext | property |
fontContext:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. This is usually, but not always, an ISWFContext.
Set this if you need lines to be created in a different SWF context than the one containing the TLF code.
Note: This property does not exist in the flash.text.TextField API.
The default value is null.
Implementation
public function get fontContext():IFlexModuleFactory public function set fontContext(value:IFlexModuleFactory):voidgridFitType | property |
gridFitType:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField.
Getting it will always return null
and setting it will do nothing.
Implementation
public function get gridFitType():String public function set gridFitType(value:String):voidRelated API Elements
htmlText | property |
htmlText:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Contains the HTML representation of the text field contents.
Flash Player supports the following HTML tags:
| Tag | Description |
|---|---|
| Anchor tag |
The <a> tag creates a hypertext link and supports the following attributes:
|
| Bold tag |
The <b> tag renders text as bold. A bold typeface must be available for the font used.
|
| Break tag |
The <br> tag creates a line break in the text field. Set the text field to
be a multiline text field to use this tag.
|
| Font tag |
The <font> tag specifies a font or list of fonts to display the text.The font tag
supports the following attributes:
|
| Image tag |
The <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and
movie clips inside text fields. Text automatically flows around images you embed in text fields. You
must set the text field to be multiline to wrap text around an image.
The
Flash displays media embedded in a text field at full size. To specify the dimensions of the media
you are embedding, use the In general, an image embedded in a text field appears on the line following the
For AIR content in the application security sandbox, AIR ignores |
| Italic tag |
The <i> tag displays the tagged text in italics. An italic typeface must be available
for the font used.
|
| List item tag |
The <li> tag places a bullet in front of the text that it encloses.
Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol>
and <ul>, they do not modify how your list is rendered. All lists are unordered and all
list items use bullets.
|
| Paragraph tag |
The <p> tag creates a new paragraph. The text field must be set to be a multiline
text field to use this tag.
The <p> tag supports the following attributes:
|
| Span tag |
The <span> tag is available only for use with CSS text styles. It supports the
following attribute:
|
| Text format tag |
The The
|
| Underline tag |
The <u> tag underlines the tagged text.
|
Flash Player and AIR support the following HTML entities:
| Entity | Description |
|---|---|
| < | < (less than) |
| > | > (greater than) |
| & | & (ampersand) |
| " | " (double quotes) |
| ' | ' (apostrophe, single quote) |
Flash Player and AIR also support explicit character codes, such as & (ASCII ampersand) and € (Unicode € symbol).
Implementation
public function get htmlText():String public function set htmlText(value:String):voidlength | property |
locale | property |
locale:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The locale of the text displayed by FTETextField.
FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.
Implementation
public function get locale():String public function set locale(value:String):voidmaxChars | property |
maxChars:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.
Implementation
public function get maxChars():int public function set maxChars(value:int):voidRelated API Elements
maxScrollH | property |
maxScrollH:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get maxScrollH():intRelated API Elements
maxScrollV | property |
maxScrollV:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get maxScrollV():intRelated API Elements
mouseWheelEnabled | property |
mouseWheelEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField
because FTETextField does not support scrolling.
Getting it will always return false
and setting it will do nothing.
Implementation
public function get mouseWheelEnabled():Boolean public function set mouseWheelEnabled(value:Boolean):voidRelated API Elements
multiline | property |
multiline:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has no effect in FTETextField because FTETextField does not support editing. However, you can get and set it.
Implementation
public function get multiline():Boolean public function set multiline(value:Boolean):voidRelated API Elements
numLines | property |
numLines:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the number of text lines in a multiline text field.
If wordWrap property is set to true,
the number of lines increases when text wraps.
Implementation
public function get numLines():intrestrict | property |
restrict:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get restrict():String public function set restrict(value:String):voidRelated API Elements
scrollH | property |
scrollH:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get scrollH():int public function set scrollH(value:int):voidRelated API Elements
scrollV | property |
scrollV:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.
Implementation
public function get scrollV():int public function set scrollV(value:int):voidRelated API Elements
selectable | property |
selectable:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Setting this property has no effect in FTETextField
because FTETextField does not support selection.
If you get it, it will always be false.
Implementation
public function get selectable():Boolean public function set selectable(value:Boolean):voidRelated API Elements
selectionBeginIndex | property |
selectionBeginIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.
Implementation
public function get selectionBeginIndex():intRelated API Elements
selectionEndIndex | property |
selectionEndIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has not been implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.
Implementation
public function get selectionEndIndex():intRelated API Elements
sharpness | property |
sharpness:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has no effect in FTETextField.
because FTE uses a newer font renderer than TextField.
Getting it will always return NaN
and setting it will do nothing.
Implementation
public function get sharpness():Number public function set sharpness(value:Number):voidRelated API Elements
styleSheet | property |
styleSheet:StyleSheet| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Attaches a style sheet to the text field. For information on creating style sheets, see the StyleSheet class and the ActionScript 3.0 Developer's Guide.
You can change the style sheet associated with a text field at any time. If you change
the style sheet in use, the text field is redrawn with the new style sheet.
You can set the style sheet to null or undefined
to remove the style sheet. If the style sheet in use is removed, the text field is redrawn without a style sheet.
Note: If the style sheet is removed, the contents of both TextField.text and
TextField.htmlText change to incorporate the formatting previously applied by the style sheet. To preserve
the original TextField.htmlText contents without the formatting, save the value in a variable before
removing the style sheet.
Implementation
public function get styleSheet():StyleSheet public function set styleSheet(value:StyleSheet):voidRelated API Elements
text | property |
text:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A string that is the current text in the text field. Lines are separated by the carriage
return character ('\r', ASCII 13). This property contains unformatted text in the text
field, without HTML tags.
To get the text in HTML form, use the htmlText property.
Note: If a style sheet is applied to the text field the content
of the text property will be interpreted as HTML.
Implementation
public function get text():String public function set text(value:String):voidtextColor | property |
textColor:uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The color of the text in a text field, in hexadecimal format.
The hexadecimal color system uses six digits to represent
color values. Each digit has 16 possible values or characters. The characters range from
0-9 and then A-F. For example, black is 0x000000; white is
0xFFFFFF.
Implementation
public function get textColor():uint public function set textColor(value:uint):voidtextHeight | property |
textWidth | property |
thickness | property |
thickness:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property has no effect in FTETextField
because FTE uses a newer font renderer than TextField.
Getting it will always return NaN
and setting it will do nothing.
Implementation
public function get thickness():Number public function set thickness(value:Number):voidRelated API Elements
type | property |
type:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The type of the text field.
Either one of the following TextFieldType constants: TextFieldType.DYNAMIC,
which specifies a dynamic text field, which a user cannot edit, or TextFieldType.INPUT,
which specifies an input text field, which a user can edit.
Implementation
public function get type():String public function set type(value:String):voiduseRichTextClipboard | property |
useRichTextClipboard:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. Accessing it will throw a runtime error.
Implementation
public function get useRichTextClipboard():Boolean public function set useRichTextClipboard(value:Boolean):voidRelated API Elements
wordWrap | property |
wordWrap:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A Boolean value that indicates whether the text field has word wrap. If the value of
wordWrap is true, the text field has word wrap;
if the value is false, the text field does not have word wrap. The default
value is false.
Implementation
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):voidFTETextField | () | Constructor |
public function FTETextField()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
appendText | () | method |
public function appendText(newText:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
newText:String — n/a
|
Related API Elements
getCharBoundaries | () | method |
public function getCharBoundaries(charIndex:int):Rectangle| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
charIndex:int — n/a
|
Rectangle — n/a
|
Related API Elements
getCharIndexAtPoint | () | method |
public function getCharIndexAtPoint(x:Number, y:Number):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
x:Number — n/a
| |
y:Number — n/a
|
int — n/a
|
Related API Elements
getFirstCharInParagraph | () | method |
public function getFirstCharInParagraph(charIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
charIndex:int — n/a
|
int — n/a
|
Related API Elements
getImageReference | () | method |
public function getImageReference(id:String):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
id:String — n/a
|
DisplayObject — n/a
|
Related API Elements
getLineIndexAtPoint | () | method |
public function getLineIndexAtPoint(x:Number, y:Number):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
x:Number — n/a
| |
y:Number — n/a
|
int — n/a
|
Related API Elements
getLineIndexOfChar | () | method |
public function getLineIndexOfChar(charIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
charIndex:int — n/a
|
int — n/a
|
Related API Elements
getLineLength | () | method |
public function getLineLength(lineIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
lineIndex:int — n/a
|
int — n/a
|
Related API Elements
getLineMetrics | () | method |
public function getLineMetrics(lineIndex:int):flash.text:TextLineMetrics| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns metrics information about a given text line.
Parameters
lineIndex:int — The line number for which you want metrics information.
|
flash.text:TextLineMetrics — A TextLineMetrics object.
|
getLineOffset | () | method |
public function getLineOffset(lineIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
lineIndex:int — n/a
|
int — n/a
|
Related API Elements
getLineText | () | method |
public function getLineText(lineIndex:int):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
lineIndex:int — n/a
|
String — n/a
|
Related API Elements
getParagraphLength | () | method |
public function getParagraphLength(charIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
charIndex:int — n/a
|
int — n/a
|
Related API Elements
getTextFormat | () | method |
public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):flash.text:TextFormat| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has been implemented in FTETextField
to simply return a copy of the defaultTextFormat,
because FTETextField does not support formatting a range.
Parameters
beginIndex:int (default = -1) | |
endIndex:int (default = -1) |
flash.text:TextFormat — n/a
|
Related API Elements
replaceSelectedText | () | method |
public function replaceSelectedText(value:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
value:String — n/a
|
Related API Elements
replaceText | () | method |
public function replaceText(beginIndex:int, endIndex:int, newText:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.
Parameters
beginIndex:int — n/a
| |
endIndex:int — n/a
| |
newText:String — n/a
|
Related API Elements
setSelection | () | method |
public function setSelection(beginIndex:int, endIndex:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has not been implemented in FTETextField because FTETextField does not support selection. It will throw a runtime error if called.
Parameters
beginIndex:int — n/a
| |
endIndex:int — n/a
|
Related API Elements
setTextFormat | () | method |
public function setTextFormat(format:flash.text:TextFormat, beginIndex:int = -1, endIndex:int = -1):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method has no effect on a FTETextField if beginIndex
or endIndex does not equal -1
because FTETextField does not support formatting a range.
Parameters
format:flash.text:TextFormat — n/a
| |
beginIndex:int (default = -1) | |
endIndex:int (default = -1) |
Related API Elements
Mon Apr 10 2017, 12:28 PM -07:00