Package | mx.core |
Class | public class TextFieldAsset |
Inheritance | TextFieldAsset FlexTextField TextField InteractiveObject DisplayObject EventDispatcher Object |
Implements | IFlexAsset, IFlexDisplayObject |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
This class is included in Flex for completeness, so that any kind of symbol in a SWF file produced by Flash can be embedded in a Flex application. However, Flex applications do not typically use embedded TextFields. Refer to more commonly-used asset classes such as BitmapAsset for more information about how embedded assets work in Flex.
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
When set to true and the text field is not in focus, Flash Player highlights the
selection in the text field in gray. | TextField | ||
antiAliasType : String
The type of anti-aliasing used for this text field. | TextField | ||
autoSize : String
Controls automatic sizing and alignment of text fields. | TextField | ||
background : Boolean
Specifies whether the text field has a background fill. | TextField | ||
backgroundColor : uint
The color of the text field background. | TextField | ||
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. | TextField | ||
borderColor : uint
The color of the text field border. | TextField | ||
bottomScrollV : int [read-only]
An integer (1-based index) that indicates the bottommost line that is currently visible in
the specified text field. | TextField | ||
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]
The index of the insertion point (caret) position. | TextField | ||
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. | TextField | ||
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. | TextField | ||
displayAsPassword : Boolean
Specifies whether the text field is a password text field. | TextField | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
embedFonts : Boolean
Specifies whether to render by using embedded font outlines. | TextField | ||
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 | ||
gridFitType : String
The type of grid fitting used for this text field. | TextField | ||
height : Number
Indicates the height of the display object, in pixels. | DisplayObject | ||
htmlText : String
Contains the HTML representation of the text field contents. | TextField | ||
length : int [read-only]
The number of characters in a text field. | TextField | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
maxChars : int
The maximum number of characters that the text field can contain, as entered by a user. | TextField | ||
maxScrollH : int [read-only]
The maximum value of scrollH. | TextField | ||
maxScrollV : int [read-only]
The maximum value of scrollV. | TextField | ||
measuredHeight : Number [read-only]
The measured height of this object. | TextFieldAsset | ||
measuredWidth : Number [read-only]
The measured width of this object. | TextFieldAsset | ||
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 | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseWheelEnabled : Boolean
A Boolean value that indicates whether Flash Player automatically scrolls multiline
text fields when the user clicks a text field and rolls the mouse wheel. | TextField | ||
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
Indicates whether field is a multiline text field. | TextField | ||
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 | ||
numLines : int [read-only]
Defines the number of text lines in a multiline text field. | TextField | ||
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
Indicates the set of characters that a user can enter into the text field. | TextField | ||
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
The current horizontal scrolling position. | TextField | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
scrollV : int
The vertical position of text in a text field. | TextField | ||
selectable : Boolean
A Boolean value that indicates whether the text field is selectable. | TextField | ||
selectionBeginIndex : int [read-only]
The zero-based character index value of the first character in the current selection. | TextField | ||
selectionEndIndex : int [read-only]
The zero-based character index value of the last character in the current selection. | TextField | ||
sharpness : Number
The sharpness of the glyph edges in this text field. | TextField | ||
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 | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
styleSheet : StyleSheet
Attaches a style sheet to the text field. | TextField | ||
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. | TextField | ||
textColor : uint
The color of the text in a text field, in hexadecimal format. | TextField | ||
textHeight : Number [read-only]
The height of the text in pixels. | TextField | ||
textInteractionMode : String [read-only]
The interaction mode property, Default value is TextInteractionMode.NORMAL. | TextField | ||
textWidth : Number [read-only]
The width of the text in pixels. | TextField | ||
thickness : Number
The thickness of the glyph edges in this text field. | TextField | ||
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. | TextField | ||
useRichTextClipboard : Boolean
Specifies whether to copy and paste the text formatting along with the text. | TextField | ||
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. | TextField | ||
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. | TextFieldAsset | ||
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 | ||
Appends the string specified by the newText parameter to the end of the text
of the text field. | TextField | ||
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 | ||
Returns a rectangle that is the bounding box of the character. | TextField | ||
Returns the zero-based index value of the character at the point specified by the x
and y parameters. | TextField | ||
Given a character index, returns the index of the first character in the same paragraph. | TextField | ||
Returns a DisplayObject reference for the given id, for an image or SWF file
that has been added to an HTML-formatted text field by using an <img> tag. | TextField | ||
Returns the zero-based index value of the line at the point specified by the x
and y parameters. | TextField | ||
Returns the zero-based index value of the line containing the character specified
by the charIndex parameter. | TextField | ||
Returns the number of characters in a specific text line. | TextField | ||
Returns metrics information about a given text line. | TextField | ||
Returns the character index of the first character in the line that
the lineIndex parameter specifies. | TextField | ||
Returns the text of the line specified by the lineIndex parameter. | TextField | ||
Given a character index, returns the length of the paragraph containing the given character. | TextField | ||
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 | ||
Returns a TextFormat object that contains formatting information for the range of text that the
beginIndex and endIndex parameters specify. | TextField | ||
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 | ||
[static]
Returns true if an embedded font is available with the specified fontName and fontStyle
where Font.fontType is flash.text.FontType.EMBEDDED. | TextField | ||
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 | ||
Moves this object to the specified x and y coordinates. | TextFieldAsset | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Replaces the current selection with the contents of the value parameter. | TextField | ||
Replaces the range of characters that the beginIndex and
endIndex parameters specify with the contents
of the newText parameter. | TextField | ||
Raises a virtual keyboard. | InteractiveObject | ||
Sets the actual size of this object. | TextFieldAsset | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Sets as selected the text designated by the index values of the
first and last characters, which are specified with the beginIndex
and endIndex parameters. | TextField | ||
Applies the text formatting that the format parameter specifies to the specified text in a text field. | TextField | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexTextField | ||
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 |
measuredHeight | property |
measuredHeight:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The measured height of this object.
This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a measure()
method will be called at an appropriate time,
giving you an opportunity to compute a measuredHeight
.
Implementation
public function get measuredHeight():Number
measuredWidth | property |
measuredWidth:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The measured width of this object.
This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a measure()
method will be called at an appropriate time,
giving you an opportunity to compute a measuredHeight
.
Implementation
public function get measuredWidth():Number
TextFieldAsset | () | Constructor |
public function TextFieldAsset()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
move | () | method |
public function move(x:Number, y:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves this object to the specified x and y coordinates.
Parameters
x:Number — The new x-position for this object.
| |
y:Number — The new y-position for this object.
|
setActualSize | () | method |
public function setActualSize(newWidth:Number, newHeight:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the actual size of this object.
This method is mainly for use in implementing the
updateDisplayList()
method, which is where
you compute this object's actual size based on
its explicit size, parent-relative (percent) size,
and measured size.
You then apply this actual size to the object
by calling setActualSize()
.
In other situations, you should be setting properties
such as width
, height
,
percentWidth
, or percentHeight
rather than calling this method.
Parameters
newWidth:Number — The new width for this object.
| |
newHeight:Number — The new height for this object.
|
Wed Nov 21 2018, 06:34 AM -08:00