Classes
AddedRemovedEvent
AlertElement
AnchorContainerElement
ArrowShape
ButtonElement
CanvasElement
CanvasManager
CheckboxElement
CheckboxSkinElement
CollectionChangedEvent
CollectionSort
ColorPickerButtonElement
ColorPickerElement
ContainerBaseElement
CursorDefinition
DataGridColumnDefinition
DataGridDataRenderer
DataGridElement
DataGridHeaderColumnDividerSkinElement
DataGridHeaderElement
DataGridHeaderItemRenderer
DataGridItemData
DataGridItemRendererBase
DataGridLabelItemRenderer
DataListData
DataListElement
DataRendererBaseElement
DataRendererLabelElement
DatePickerButtonElement
DatePickerElement
DispatcherEvent
DrawMetrics
DropdownArrowButtonSkinElement
DropdownBaseElement
DropdownElement
ElementEvent
ElementGridItemClickEvent
ElementKeyboardEvent
ElementListItemClickEvent
ElementMouseEvent
ElementMouseWheelEvent
EllipseShape
EventDispatcher
FillBase
GridContainerElement
GridContainerRowColumnDefinition
ImageElement
IpInputElement
LabelElement
LinearGradientFill
ListCollection
ListContainerElement
ProgressElement
RadioButtonElement
RadioButtonSkinElement
RoundedRectangleShape
ScrollBarElement
ScrollButtonSkinElement
ShapeBase
SkinnableElement
SolidFill
StyleableBase
StyleChangedEvent
StyleData
StyleDefinition
StyleProxy
TextAreaElement
TextElement
TextFieldElement
TextInputElement
TimeInputElement
ToggleButtonElement
ToggleButtonGroup
Tween
ViewportElement


TextInputElement

TextInput is an edit-able single line text box.

Inheritance:     TextInputElement ➞ SkinnableElementCanvasElementStyleableBaseStyleDefinitionEventDispatcher ➞ Object

Styles
Show Inherited
Style Defined By
DisabledSkinClass     :    CanvasElement TextInputElement
The CanvasElement constructor to be used for the TextInput is in the "disabled" state.
When this is null, the base SkinClass style will be used.
 
DisabledSkinStyle     :    StyleDefinition TextInputElement
The StyleDefinition or [StyleDefinition] array to apply to the "disabled" state skin element.
When this is null, the base SkinTyle will be used.
 
DisabledTextColor     :    String TextInputElement
Hex color value to be used for the button TextInput is in the "disabled" state. Format like "#FF0000" (red).
This will override the TextColor style.
 
DisabledTextHighlightedBackgroundColor     :    String TextInputElement
Hex color value to be used for highlighted text background when the TextInput is in the "disabled" state. Format like "#FF0000" (red).
When this is null, the base TextHighlightedBackgroundColor style will be used.
 
DisabledTextHighlightedColor     :    String TextInputElement
Hex color value to be used for highlighted text when the TextInput is in the "disabled" state. Format like "#FF0000" (red).
When this is null, the base TextHighlightedColor style will be used.
 
DisplayAsPassword     :    boolean TextInputElement
When true, text will be masked using the PasswordMaskCharacter style.
 
MaxChars     :    int TextInputElement
Maximum number of characters allowed.
 
SkinClass     :    CanvasElement TextInputElement
The CanvasElement constructor type to apply to all skin states.
Specific states such as UpSkinClass will override SkinClass.
 
UpSkinClass     :    CanvasElement TextInputElement
The CanvasElement constructor to be used for the skin when in the "up" state.
This will override SkinClass.
 
UpSkinStyle     :    StyleDefinition TextInputElement
The StyleDefinition or [StyleDefinition] array to apply to the "up" state skin element.
 
UpTextColor     :    String TextInputElement
Hex color value to be used for the button TextInput is in the "up" state. Format like "#FF0000" (red).
This will override the TextColor style.
 
UpTextHighlightedBackgroundColor     :    String TextInputElement
Hex color value to be used for highlighted text background when the TextInput is in the "up" state. Format like "#FF0000" (red).
This will override the TextHighlightedBackgroundColor style.
 
UpTextHighlightedColor     :    String TextInputElement
Hex color value to be used for highlighted text when the TextInput is in the "up" state. Format like "#FF0000" (red).
This will override the TextHighlightedColor style.
 


Events
Show Inherited
Event Defined By
changed     :    ElementEvent TextInputElement
Dispatched when the text is modified as a result of user input.
 


Public Functions
Show Inherited
Function Defined By
TextInputElement() [Constructor] TextInputElement
Creates new TextInputElement instance.
 
getText() TextInputElement
Gets the text currently displayed.
  returns     :    String
Text currently displayed.
 
setText(text) TextInputElement
Sets the text to be displayed.
  text     :    String
Text to be displayed.
 


Internal Members
Show Inherited


Internal Functions
Show Inherited
Function Defined By
_getTextColor(state) TextInputElement
Gets the text color for the supplied state based on text styles.
  state     :    String
The skin state to return the text color.
  returns     :    String
Hex color value.
 
_getTextHighlightedBackgroundColor(state) TextInputElement
Gets the highlighted text background color for the supplied state based on text styles.
  state     :    String
The skin state to return the highlighted text background color.
  returns     :    String
Hex color value.
 
_getTextHighlightedColor(state) TextInputElement
Gets the highlighted text color for the supplied state based on text styles.
  state     :    String
The skin state to return the highlighted text color.
  returns     :    String
Hex color value.
 
_onTextInputFocusIn(elementEvent) TextInputElement
Event handler for "focusin" event.
Proxies focus event to internal TextField.
  elementEvent     :    ElementEvent
ElementEvent to process.
 
_onTextInputFocusOut(elementEvent) TextInputElement
Event handler for "focusout" event.
Proxies focus event to internal TextField.
  elementEvent     :    ElementEvent
ElementEvent to process.
 
_onTextInputKeyDown(keyboardEvent) TextInputElement
Event handler for "keydown" event. Only active when TextInput is enabled.
Proxies keyboard event to internal TextField.
  keyboardEvent     :    ElementKeyboardEvent
ElementKeyboardEvent to process.
 
_onTextInputKeyUp(keyboardEvent) TextInputElement
Event handler for "keyup" event. Only active when TextInput is enabled.
Proxies keyboard event to internal TextField.
  keyboardEvent     :    ElementKeyboardEvent
ElementKeyboardEvent to process.
 
_onTextInputTextFieldChanged(elementEvent) TextInputElement
Event handler for the internal TextField "changed" event. Only active when TextInput is Enabled.
Dispatches a "changed" event from this TextInput element.
  elementEvent     :    ElementEvent
ElementEvent to be processed.
 
_updateSkinStyles(stylesMap) TextInputElement
Updates skin related styles. Called by _doStylesUpdated()
  stylesMap     :    Object
Map of styles that have been changed
 
_updateState() TextInputElement
Updates the current SkinState in response to style changes.
 
_updateTextColors() TextInputElement
Updates the text colors based on the current state. Called when state changes and when added to display hierarchy.