ITextInput - Referencia de la API de Adobe ActionScript® 3 (AS3 Flex)

Paquete	mx.core
Interfaz	public interface ITextInput extends IDataRenderer , IDropInListItemRenderer , IFocusManagerComponent , IFontContextComponent , IIMESupport , IListItemRenderer , IUIComponent , IInvalidating , IStyleClient , IEventDispatcher , IFlexDisplayObject , ILayoutManagerClient , ISimpleStyleClient , IFlexDisplayObject , ISimpleStyleClient , IBitmapDrawable
Implementadores	MXFTETextInput, TextInput

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Defines an interface for a single-line text field that is optionally editable.

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		accessibilityProperties : AccessibilityProperties Las opciones de accesibilidad actuales para este objeto de visualización.	IFlexDisplayObject
		alpha : Number Indica el valor de transparencia alfa del objeto especificado.	IFlexDisplayObject
		baselinePosition : Number [solo lectura] The y-coordinate of the baseline of the first line of text of the component.	IUIComponent
		blendMode : String Un valor de la clase BlendMode que especifica el modo de mezcla que debe utilizarse.	IFlexDisplayObject
		cacheAsBitmap : Boolean Si se define como true, los motores de ejecución de Flash dejan en caché una representación interna de mapa de bits del objeto de visualización.	IFlexDisplayObject
		className : String [solo lectura] The name of the component class.	IStyleClient
		data : Object The data to render or edit.	IDataRenderer
		document : Object A reference to the document object associated with this component.	IUIComponent
		editable : Boolean Indicates whether the user is allowed to edit the text in this control.	ITextInput
		enabled : Boolean Whether the component can accept user interaction.	IUIComponent
		enableIME : Boolean [solo lectura] Specifies whether the IME should be enabled when this component has focus.	IIMESupport
		explicitHeight : Number The explicitly specified height for the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMaxHeight : Number [solo lectura] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMaxWidth : Number [solo lectura] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinHeight : Number [solo lectura] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinWidth : Number [solo lectura] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitWidth : Number The explicitly specified width for the component, in pixels, as the component's coordinates.	IUIComponent
		filters : Array Conjunto indexado que contiene todos los objetos de filtro actualmente asociados con el objeto de visualización.	IFlexDisplayObject
		focusEnabled : Boolean A flag that indicates whether the component can receive focus when selected.	IFocusManagerComponent
		focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator.	IUIComponent
		fontContext : IFlexModuleFactory The module factory that provides the font context for this component.	IFontContextComponent
		hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus.	IFocusManagerComponent
		height : Number Indica la altura del objeto de visualización, expresada en píxeles.	IFlexDisplayObject
		horizontalScrollPosition : Number Pixel position in the content area of the leftmost pixel that is currently displayed.	ITextInput
		imeMode : String The IME mode of the component.	IIMESupport
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	IUIComponent
		inheritingStyles : Object An object containing the inheritable styles for this component.	IStyleClient
		initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) This flag should only be modified by the LayoutManager.	ILayoutManagerClient
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	IUIComponent
		listData : BaseListData Implements the listData property using setter and getter methods.	IDropInListItemRenderer
		loaderInfo : LoaderInfo [solo lectura] Devuelve un objeto LoaderInfo que contiene información sobre la carga del archivo al que pertenece este objeto de visualización.	IFlexDisplayObject
		mask : DisplayObject El objeto de visualización que origina la llamada se enmascara mediante el objeto mask especificado.	IFlexDisplayObject
		maxChars : int Maximum number of characters that users can enter in the text field.	ITextInput
		maxHeight : Number [solo lectura] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		maxWidth : Number [solo lectura] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		measuredHeight : Number [solo lectura] The measured height of this object.	IFlexDisplayObject
		measuredMinHeight : Number The default minimum height of the component, in pixels.	IUIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	IUIComponent
		measuredWidth : Number [solo lectura] The measured width of this object.	IFlexDisplayObject
		minHeight : Number [solo lectura] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		minWidth : Number [solo lectura] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.	IUIComponent
		mouseChildren : Boolean Determina si los elementos secundarios del objeto están activados para acciones de ratón o de dispositivo de entrada de usuario.	ITextInput
		mouseEnabled : Boolean Especifica si este objeto recibe la entrada del ratón, la entrada del usuario o mensajes.	ITextInput
		mouseFocusEnabled : Boolean [solo lectura] A flag that indicates whether the component can receive focus when selected with the mouse.	IFocusManagerComponent
		mouseX : Number [solo lectura] Indica la coordenada x de la posición del ratón o del dispositivo de entrada del usuario, en píxeles.	IFlexDisplayObject
		mouseY : Number [solo lectura] Indica la coordenada y de la posición del ratón o del dispositivo de entrada del usuario, en píxeles.	IFlexDisplayObject
		name : String Indica el nombre de instancia de DisplayObject.	IFlexDisplayObject
		nestLevel : int The top-level SystemManager has a nestLevel of 1.	ILayoutManagerClient
		nonInheritingStyles : Object An object containing the noninheritable styles for this component.	IStyleClient
		opaqueBackground : Object Especifica si el objeto de visualización es opaco con un determinado color de fondo.	IFlexDisplayObject
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IUIComponent
		parent : DisplayObjectContainer [solo lectura] Indica el objeto DisplayObjectContainer que contiene este objeto de visualización.	IFlexDisplayObject
		parentDrawsFocus : Boolean If true, calls to this control's drawFocus() method are forwarded to its parent's drawFocus() method.	ITextInput
		percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size.	IUIComponent
		percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size.	IUIComponent
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	ILayoutManagerClient
		restrict : String Indicates the set of characters that a user can enter into the control.	ITextInput
		root : DisplayObject [solo lectura] Para un objeto de visualización en un archivo SWF cargado, la propiedad root es el objeto de visualización de nivel más alto en la parte de la estructura de árbol de la lista de visualización representada por dicho archivo SWF.	IFlexDisplayObject
		rotation : Number Indica el giro de la instancia de DisplayObject, expresado en grados, con respecto a su orientación original.	IFlexDisplayObject
		scale9Grid : Rectangle La cuadrícula de escala aplicada actualmente.	IFlexDisplayObject
		scaleX : Number Indica la escala horizontal (percentage) del objeto aplicada desde el punto de registro.	IFlexDisplayObject
		scaleY : Number Indica la escala vertical (percentage) de un objeto aplicada desde el punto de registro del objeto.	IFlexDisplayObject
		scrollRect : Rectangle Los límites del rectángulo de desplazamiento del objeto de visualización.	IFlexDisplayObject
		selectable : Boolean A flag indicating whether the text in the TextInput can be selected.	ITextInput
		selectionActivePosition : int [solo lectura] The zero-based index of the position after the last character in the current selection (equivalent to the one-based index of the last character).	ITextInput
		selectionAnchorPosition : int [solo lectura] The zero-based character index value of the first character in the current selection.	ITextInput
		stage : Stage [solo lectura] El escenario del objeto de visualización.	IFlexDisplayObject
		styleDeclaration : CSSStyleDeclaration The style declaration that holds the inline styles declared by this object.	IStyleClient
		styleName : Object The source of this object's style values.	ISimpleStyleClient
		systemManager : ISystemManager A reference to the SystemManager object for this component.	IUIComponent
		tabFocusEnabled : Boolean [solo lectura] A flag that indicates whether pressing the Tab key eventually moves focus to this component.	IFocusManagerComponent
		tabIndex : int If tabFocusEnabled, the order in which the component receives focus.	IFocusManagerComponent
		text : String Plain text that appears in the control.	ITextInput
		transform : flash.geom:Transform Objeto con propiedades pertenecientes a una matriz, transformación de color y límites de píxel de un objeto de visualización.	IFlexDisplayObject
		tweeningProperties : Array Used by EffectManager.	IUIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object is waiting to have its updateComplete event dispatched.	ILayoutManagerClient
		visible : Boolean Indica si el objeto de visualización es visible.	IFlexDisplayObject
		width : Number Indica la anchura del objeto de visualización, expresada en píxeles.	IFlexDisplayObject
		x : Number Indica la coordenada x de la instancia de DisplayObject en relación a las coordenadas locales del DisplayObjectContainer principal.	IFlexDisplayObject
		y : Number Indica la coordenada y de la instancia de DisplayObject en relación a las coordenadas locales del DisplayObjectContainer principal.	IFlexDisplayObject

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	IEventDispatcher
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	IStyleClient
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	IEventDispatcher
		drawFocus(isFocused:Boolean):void Called by the FocusManager when the component receives focus.	IFocusManagerComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Devuelve un rectángulo que define el área del objeto de visualización relativo al sistema de coordenadas del objeto targetCoordinateSpace.	IFlexDisplayObject
		getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.	IStyleClient
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	IUIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	IUIComponent
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Devuelve un rectángulo que define el límite del objeto de visualización, basado en el sistema de coordenadas definido por el parámetro targetCoordinateSpace, excluyendo los trazos en las formas.	IFlexDisplayObject
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	IStyleClient
		globalToLocal(point:Point):Point Convierte el objeto point de las coordenadas del escenario (globales) en las coordenadas del objeto de visualización (locales).	IFlexDisplayObject
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	IEventDispatcher
		hitTestObject(obj:DisplayObject):Boolean Calcula el cuadro delimitador del objeto de visualización para ver si se solapa o corta con el cuadro delimitador del objeto de visualización obj.	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evalúa el objeto de visualización para comprobar si se solapa o presenta un punto de intersección con el punto especificado por los parámetros x e y.	IFlexDisplayObject
		initialize():void Initialize the object.	IUIComponent
		invalidateDisplayList():void Calling this method results in a call to the component's validateDisplayList() method before the display list is rendered.	IInvalidating
		invalidateProperties():void Calling this method results in a call to the component's validateProperties() method before the display list is rendered.	IInvalidating
		invalidateSize():void Calling this method results in a call to the component's validateSize() method before the display list is rendered.	IInvalidating
		localToGlobal(point:Point):Point Convierte el objeto point de coordenadas del objeto de visualización (locales) en coordenadas del escenario (globales).	IFlexDisplayObject
		move(x:Number, y:Number):void Moves this object to the specified x and y coordinates.	IFlexDisplayObject
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this component.	IStyleClient
		owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	IUIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	IUIComponent
		regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions.	IStyleClient
		registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event.	IStyleClient
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	IEventDispatcher
		selectRange(anchorPosition:int, activePosition:int):void Selects the text in the range specified by the parameters.	ITextInput
		setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object.	IFlexDisplayObject
		setFocus():void Called by the FocusManager when the component receives focus.	IFocusManagerComponent
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	IStyleClient
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	IUIComponent
		showBorderAndBackground(visible:Boolean):void Determines whether the border and background of the TextInput are visible.	ITextInput
		styleChanged(styleProp:String):void Called when the value of a style property is changed.	ISimpleStyleClient
		validateDisplayList():void Validates the position and size of children and draws other visuals.	ILayoutManagerClient
		validateNow():void Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.	IInvalidating
		validateProperties():void Validates the properties of a component.	ILayoutManagerClient
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.	ILayoutManagerClient
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	IEventDispatcher

Información sobre propiedades

editable

propiedad

editable:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Indicates whether the user is allowed to edit the text in this control. If true, the user can edit the text.

El valor predeterminado es true.

Implementación
public function get editable():Boolean
public function set editable(value:Boolean):void

horizontalScrollPosition

propiedad

horizontalScrollPosition:Number

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Pixel position in the content area of the leftmost pixel that is currently displayed. (The content area includes all contents of a control, not just the portion that is currently displayed.) This property is always set to 0, and ignores changes, if wordWrap is set to true.

El valor predeterminado es 0.

Implementación
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

maxChars

propiedad

maxChars:int

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Maximum number of characters that users can enter in the text field. This property does not limit the length of text specified by the setting the control's text or htmlText property.

The default value is 0, which is a special case meaning an unlimited number.

Implementación
public function get maxChars():int
public function set maxChars(value:int):void

mouseChildren

propiedad

mouseChildren:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Determina si los elementos secundarios del objeto están activados para acciones de ratón o de dispositivo de entrada de usuario. Si un objeto está activado, el usuario puede interactuar con él por medio de un ratón o de un dispositivo de entrada de usuario. El valor predeterminado es true.

Esta propiedad es útil cuando se crea un botón con una instancia de la clase Sprite (en lugar de utilizar la clase SimpleButton). Cuando utilice una instancia de Sprite para crear un botón, podrá optar por decorar el botón empleando el método addChild() para añadir instancias adicionales de Sprite. Este proceso puede provocar un comportamiento inesperado con los eventos de ratón, ya que las instancias de Sprite que añada como elementos secundarios pueden convertirse en el objeto de destino de un evento de ratón cuando se espera que la instancia principal sea el objeto de destino. Para asegurarse de que la instancia principal actúa como objeto de destino de los eventos de ratón, puede establecer la propiedad mouseChildren de la instancia principal con el valor false.

No se distribuye ningún evento al establecer esta propiedad. Debe utilizar el método addEventListener() para crear funcionalidad interactiva.

Implementación
public function get mouseChildren():Boolean
public function set mouseChildren(value:Boolean):void

mouseEnabled

propiedad

mouseEnabled:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Especifica si este objeto recibe la entrada del ratón, la entrada del usuario o mensajes. El valor predeterminado es true, lo que significa que, de manera predeterminada, toda instancia de InteractiveObject que esté en la lista de visualización recibirá eventos de ratón u otros eventos de entrada del usuario. Si mouseEnabled se establece en false, la instancia no recibirá ningún evento de ratón (o cualquier otra entrada de usuario como eventos de teclado). Los elementos secundarios de esta instancia en la lista de visualización no se verán afectados. Para cambiar el comportamiento mouseEnabled de todos los elementos secundarios de un objeto de la lista de visualización, utilice flash.display.DisplayObjectContainer.mouseChildren.

No se distribuye ningún evento al establecer esta propiedad. Debe utilizar el método addEventListener() para crear funcionalidad interactiva.

Implementación
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void

parentDrawsFocus

propiedad

parentDrawsFocus:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

If true, calls to this control's drawFocus() method are forwarded to its parent's drawFocus() method. This is used when a TextInput is part of a composite control like NumericStepper or ComboBox;

El valor predeterminado es false.

Implementación
public function get parentDrawsFocus():Boolean
public function set parentDrawsFocus(value:Boolean):void

restrict

propiedad

restrict:String

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Indicates the set of characters that a user can enter into the control. If the value of the restrict property is null, you can enter any character. If the value of the restrict property is an empty string, you cannot enter any character. This property only restricts user interaction; a script can put any text into the text field. If the value of the restrict property is a string of characters, you may enter only characters in that string into the text field.

Flex scans the string from left to right. You can specify a range by using the hyphen (-) character. If the string begins with a caret (^) character, all characters are initially accepted and succeeding characters in the string are excluded from the set of accepted characters. If the string does not begin with a caret (^) character, no characters are initially accepted and succeeding characters in the string are included in the set of accepted characters.

Because some characters have a special meaning when used in the restrict property, you must use backslash characters to specify the literal characters -, ^, and \. When you use the restrict property as an attribute in an MXML tag, use single backslashes, as in the following example: \^\-\\. When you set the restrict In and ActionScript expression, use double backslashes, as in the following example: \\^\\-\\\.

El valor predeterminado es null.

Implementación
public function get restrict():String
public function set restrict(value:String):void

Elementos de API relacionados

flash.text.TextField.restrict

selectable

propiedad

selectable:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

A flag indicating whether the text in the TextInput can be selected.

Implementación
public function get selectable():Boolean
public function set selectable(value:Boolean):void

selectionActivePosition

propiedad

selectionActivePosition:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

The zero-based index of the position after the last character in the current selection (equivalent to the one-based index of the last character). If the last character in the selection, for example, is the fifth character, this property has the value 5. When the control gets the focus, the selection is visible if the selectionAnchorIndex and selectionActiveIndex properties are both set.

El valor predeterminado es 0.

Implementación
public function get selectionActivePosition():int

selectionAnchorPosition

propiedad

selectionAnchorPosition:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

The zero-based character index value of the first character in the current selection. For example, the first character is 0, the second character is 1, and so on. When the control gets the focus, the selection is visible if the selectionAnchorIndex and selectionActiveIndex properties are both set.

El valor predeterminado es 0.

Implementación
public function get selectionAnchorPosition():int

text

propiedad

text:String

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Plain text that appears in the control. Its appearance is determined by the CSS styles of this Label control.

Any HTML tags in the text string are ignored, and appear as entered in the string. To display text formatted using HTML tags, use the htmlText property instead. If you set the htmlText property, the HTML replaces any text you had set using this propety, and the text property returns a plain-text version of the HTML text, with all HTML tags stripped out. For more information see the htmlText property.

To include the special characters left angle bracket (<), right angle bracket (>), or ampersand (&) in the text, wrap the text string in the CDATA tag. Alternatively, you can use HTML character entities for the special characters, for example, <.

If you try to set this property to null, it is set, instead, to the empty string. The text property can temporarily have the value null, which indicates that the htmlText has been recently set and the corresponding text value has not yet been determined.

El valor predeterminado es "".

Implementación
public function get text():String
public function set text(value:String):void

Información sobre métodos

selectRange

()

método

public function selectRange(anchorPosition:int, activePosition:int):void

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Selects the text in the range specified by the parameters.

Parámetros

	`anchorPosition:int` — The zero-based character index value of the first character in the current selection.

	`activePosition:int` — The zero-based index of the position after the last character in the current selection (equivalent to the one-based index of the last character).

showBorderAndBackground

()

método

public function showBorderAndBackground(visible:Boolean):void

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 4

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Determines whether the border and background of the TextInput are visible.

Parámetros

visible:Boolean — true if visible, and false if not.

Avisos legales | Política de privacidad en línea

ITextInput - AS3 Flex

Paquetesx

Elementos del lenguaje

Apéndices

Paquete mx.core

editable

horizontalScrollPosition

maxChars

mouseChildren

mouseEnabled

parentDrawsFocus

restrict

selectable

selectionActivePosition

selectionAnchorPosition

text

selectRange

showBorderAndBackground