ITextInput - Referência da API Adobe ActionScript® 3 (AS3 Flex)

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

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

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		accessibilityProperties : AccessibilityProperties As opções de acessibilidade atuais para este objeto de exibição.	IFlexDisplayObject
		alpha : Number Indica o valor de transparência alfa do objeto especificado.	IFlexDisplayObject
		baselinePosition : Number [somente leitura] The y-coordinate of the baseline of the first line of text of the component.	IUIComponent
		blendMode : String Um valor a partir da classe BlendMode que especifica o modo de mesclagem a ser usado.	IFlexDisplayObject
		cacheAsBitmap : Boolean Se definido como true, tempo de execução do Flash armazenará em cachê uma representação interna em bitmap do objeto de exibição.	IFlexDisplayObject
		className : String [somente leitura] 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 [somente leitura] 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 [somente leitura] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMaxWidth : Number [somente leitura] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinHeight : Number [somente leitura] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		explicitMinWidth : Number [somente leitura] 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 Uma matriz indexada que contém cada objeto de filtro atualmente associado ao objeto de exibição.	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 a altura do objeto de exibição, em pixels.	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 [somente leitura] Retorna um objeto LoaderInfo contendo informações sobre o carregamento do arquivo ao qual esse objeto de exibição pertence.	IFlexDisplayObject
		mask : DisplayObject O objeto de exibição de chamada é mascarado pelo objeto "mask" especificado.	IFlexDisplayObject
		maxChars : int Maximum number of characters that users can enter in the text field.	ITextInput
		maxHeight : Number [somente leitura] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.	IUIComponent
		maxWidth : Number [somente leitura] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.	IUIComponent
		measuredHeight : Number [somente leitura] 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 [somente leitura] The measured width of this object.	IFlexDisplayObject
		minHeight : Number [somente leitura] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.	IUIComponent
		minWidth : Number [somente leitura] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.	IUIComponent
		mouseChildren : Boolean Determina se os filhos do objeto são ou não ativados pelo mouse, ou dispositivo de entrada do usuário.	ITextInput
		mouseEnabled : Boolean Especifica se este objeto recebe mensagens de mouse, ou de outras entradas de usuários.	ITextInput
		mouseFocusEnabled : Boolean [somente leitura] A flag that indicates whether the component can receive focus when selected with the mouse.	IFocusManagerComponent
		mouseX : Number [somente leitura] Indica a coordenada x da posição do dispositivo do mouse ou de entrada do usuário, em pixels.	IFlexDisplayObject
		mouseY : Number [somente leitura] Indica a coordenada y da posição do dispositivo do mouse ou de entrada do usuário, em pixels.	IFlexDisplayObject
		name : String Indica o nome da ocorrência 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 se o objeto de exibição é opaco com uma certa cor de plano de fundo.	IFlexDisplayObject
		owner : DisplayObjectContainer The owner of this IVisualElement object.	IUIComponent
		parent : DisplayObjectContainer [somente leitura] Indica o objeto DisplayObjectContainer que contém esse objeto de exibição.	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 [somente leitura] Para um objeto de exibição em um arquivo SWF carregado, a propriedade "root" é o objeto de exibição na extremidade superior, na parte da estrutura em árvore da lista de exibição representada por esse arquivo SWF.	IFlexDisplayObject
		rotation : Number Indica o giro da ocorrência de DisplayObject, em graus, a partir da sua orientação original.	IFlexDisplayObject
		scale9Grid : Rectangle A grade de dimensionamento atual que está em vigor.	IFlexDisplayObject
		scaleX : Number Indica a escala horizontal (porcentagem) do objeto aplicada a partir do ponto de registro.	IFlexDisplayObject
		scaleY : Number Indica a escala vertical (porcentagem) de um objeto aplicada a partir do ponto de registro desse objeto.	IFlexDisplayObject
		scrollRect : Rectangle Os limites do retângulo de rolagem do objeto de exibição.	IFlexDisplayObject
		selectable : Boolean A flag indicating whether the text in the TextInput can be selected.	ITextInput
		selectionActivePosition : int [somente leitura] 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 [somente leitura] The zero-based character index value of the first character in the current selection.	ITextInput
		stage : Stage [somente leitura] O Palco do objeto de exibição.	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 [somente leitura] 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 Um objeto com propriedades relacionadas aos limites de pixels, matriz e transformação de cores de um objeto de exibição.	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 Se o objeto de exibição está ou não visível.	IFlexDisplayObject
		width : Number Indica a largura do objeto de exibição, em pixels.	IFlexDisplayObject
		x : Number Indica a coordenada x da ocorrência de DisplayObject com relação às coordenadas locais do DisplayObjectContainer-pai.	IFlexDisplayObject
		y : Number Indica a coordenada y da ocorrência de DisplayObject com relação às coordenadas locais do DisplayObjectContainer-pai.	IFlexDisplayObject

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	IEventDispatcher
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	IStyleClient
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	IEventDispatcher
		drawFocus(isFocused:Boolean):void Called by the FocusManager when the component receives focus.	IFocusManagerComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Retorna um retângulo que define a área do objeto de exibição com relação ao sistema de coordenadas do 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 Retorna um retângulo que define o limite do objeto de exibição, com base no sistema de coordenadas definido pelo parâmetro espaçoCoordenadasDestino, excluindo quaisquer traçados em 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 Converte o objeto de ponto a partir de coordenadas de Palco (globais) em coordenadas do objeto de exibição (locais).	IFlexDisplayObject
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	IEventDispatcher
		hitTestObject(obj:DisplayObject):Boolean Avalia a caixa delimitadora do objeto de exibição para ver se ela sobrepõe ou faz interseção com a caixa delimitadora do objeto de exibição obj.	IFlexDisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Avalia o objeto de exibição para ver se ele sobrepõe ou faz interseção com o ponto especificado pelos 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 Converte o objeto de ponto a partir das coordenadas do objeto de exibição (locais) em coordenadas do Palco (globais).	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 Remove um ouvinte do 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 Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	IEventDispatcher

Detalhes da propriedade

editable

propriedade

editable:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

O valor padrão é true.

Implementação
public function get editable():Boolean
public function set editable(value:Boolean):void

horizontalScrollPosition

propriedade

horizontalScrollPosition:Number

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

O valor padrão é 0.

Implementação
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

maxChars

propriedade

maxChars:int

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

Implementação
public function get maxChars():int
public function set maxChars(value:int):void

mouseChildren

propriedade

mouseChildren:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Determina se os filhos do objeto são ou não ativados pelo mouse, ou dispositivo de entrada do usuário. Se um objeto estiver ativado,um usuário pode interagir com ele usando um mouse ou dispositivo de entrada do usuário. O padrão é true.

Essa propriedade é útil quando você cria um botão com uma ocorrência da classe Sprite (em vez de usar a classe SimpleButton). Ao usar uma ocorrência de Sprite para criar um botão, você pode optar por decorar esse botão usando o método addChild() para incluir ocorrências adicionais de Sprite. Esse processo pode causar um comportamento inesperado com eventos de mouse, já que as ocorrências de Sprite adicionadas como filhos podem se tornar o objeto de destino de um evento de mouse, quando você espera que a ocorrência-pai seja o objeto de destino. Para garantir que a ocorrência-pai atue como o objeto de destino para eventos de mouse, defina a propriedade mouseChildren dessa ocorrência como false.

Nenhum evento é despachado com o uso dessa propriedade. É necessário usar o método addEventListener() para criar uma funcionalidade interativa.

Implementação
public function get mouseChildren():Boolean
public function set mouseChildren(value:Boolean):void

mouseEnabled

propriedade

mouseEnabled:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Especifica se este objeto recebe mensagens de mouse, ou de outras entradas de usuários. O valor padrão é true, o que significa que, por padrão, qualquer instância de InteractiveObject na lista de exibição receberá eventos do mouse. Se mouseEnabled for definido como false, a instância não recebe nenhum evento de mouse (ou outros eventos de entrada de usuário como eventos do teclado). Nenhum filho dessa ocorrência na lista de exibição será afetado. Para alterar o comportamento de mouseEnabled para todos os filhos de um objeto na lista de objetos, use flash.display.DisplayObjectContainer.mouseChildren.

Nenhum evento é despachado com o uso dessa propriedade. É necessário usar o método addEventListener() para criar uma funcionalidade interativa.

Implementação
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void

parentDrawsFocus

propriedade

parentDrawsFocus:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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;

O valor padrão é false.

Implementação
public function get parentDrawsFocus():Boolean
public function set parentDrawsFocus(value:Boolean):void

restrict

propriedade

restrict:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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: \\^\\-\\\.

O valor padrão é null.

Implementação
public function get restrict():String
public function set restrict(value:String):void

Elementos da API relacionados

flash.text.TextField.restrict

selectable

propriedade

selectable:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

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

Implementação
public function get selectable():Boolean
public function set selectable(value:Boolean):void

selectionActivePosition

propriedade

selectionActivePosition:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

O valor padrão é 0.

Implementação
public function get selectionActivePosition():int

selectionAnchorPosition

propriedade

selectionAnchorPosition:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

O valor padrão é 0.

Implementação
public function get selectionAnchorPosition():int

text

propriedade

text:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

O valor padrão é "".

Implementação
public function get text():String
public function set text(value:String):void

Detalhes do método

selectRange

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

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.

Aspectos jurídicos | Política de privacidade on-line

ITextInput - AS3 Flex

Pacotesx

Elementos de linguagem

Apêndices

Pacote mx.core

editable

horizontalScrollPosition

maxChars

mouseChildren

mouseEnabled

parentDrawsFocus

restrict

selectable

selectionActivePosition

selectionAnchorPosition

text

selectRange

showBorderAndBackground