qnx.fuse.ui.text.TextArea

TextArea

Properties | Methods | Events


Packageqnx.fuse.ui.text
Classpublic class TextArea
InheritanceTextArea Inheritance TextInputBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip

The TextArea class provides developers with a multi-line input component. A text area with example text.

Class information:
BlackBerry 10 Version:   10.0.0

See also

TextInput



Public Properties

 PropertyDefined By
 InheritedautoCapitalize : String
Gets or sets a value that enables auto-capitalization when the user inputs text.
TextInputBase
 InheritedautoCorrect : Boolean
Gets or sets a value that enables auto-correct when text is entered by the user.
TextInputBase
 InheritedclearIconMode : int
Gets or sets a value that determines how the clear button appears in the text field.
TextInputBase
 InheritedcontextActions : Vector.<ActionSet>
Gets or Sets a Vector of ActionSet objects.
UIComponent
 InheritedcontextMultiSelectText : String
Gets or Sets a String to be displayed when showing the Multi Select Context Menu.
UIComponent
 InheritedcurrentTheme : String
[read-only] Returns the current theme this component is styled with.
UIComponent
 InheritedcursorColor : uint
Gets or sets the color of the cursor when editing.
TextInputBase
 InheriteddisableReturnKey : Boolean
Gets or sets a value that disables the return key on the soft keyboard.
TextInputBase
 InheriteddisplayAsPassword : Boolean
Gets or sets a value that determines whether the control is a password field.
TextInputBase
 Inheritededitable : Boolean
Gets or sets a value that determines if text can be modified.
TextInputBase
 Inheritederror : Boolean
Gets or sets the error state of the component.
TextInputBase
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 InheritedforceLatinKeyboard : Boolean
When set to true, forces the keyboard to show the latin key layout.
TextInputBase
 Inheritedformat : TextFormat
Gets or sets the format of the text.
TextInputBase
 Inheritedid : String
The id is a name for the component that can be used in CSS using the # selector.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Gets or sets the layoutData.
UIComponent
 Inheritedlength : int
[read-only] Returns the length of the text that is being rendered.
TextInputBase
 Inheritedlocale : String
Gets or sets the current locale of the component.
UIComponent
 InheritedmaskPassword : Boolean
Gets or sets a value that determines whether to mask the text of a password field.
TextInputBase
 InheritedmaxChars : int
Gets or sets the maximum number of characters that can be entered in the field.
TextInputBase
  maxLines : int
Gets or sets the maximum number of lines to be measured by a layout.
TextArea
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
  minLines : int
Gets or sets the minimum number of lines to be measured by a layout.
TextArea
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
  paddingBottom : int
Gets or sets the padding to the right of the text and the right of the skin.
TextArea
 InheritedpaddingLeft : int
Gets or sets the padding to the left of the text and the left of the skin.
TextInputBase
 InheritedpaddingRight : int
Gets or sets the padding to the right of the text and the right of the skin.
TextInputBase
  paddingTop : int
Gets or sets the padding to the left of the text and the left of the skin.
TextArea
 Inheritedprompt : String
Gets or sets the prompt.
TextInputBase
 InheritedpromptFont : String
Gets or sets the font used for the prompt text.
TextInputBase
 InheritedpromptFontColor : uint
Gets or sets the font color of the prompt text.
TextInputBase
 Inheritedrestrict : String
Gets or sets the set of characters (as a String) that a user can enter into the text field.
TextInputBase
 InheritedreturnKeyLabel : String
Gets or sets the label of the return key on the soft keyboard.
TextInputBase
 Inheritedselectable : Boolean
Gets or sets a value that determines whether text can be selected.
TextInputBase
 InheritedselectionActiveIndex : int
[read-only] Returns the zero-based index of the first character in the selection.
TextInputBase
 InheritedselectionAnchorIndex : int
[read-only] Returns the zero-based index of the last character in the selection.
TextInputBase
 InheritedsoftKeyboardType : String
Gets or sets the type of keyboard to be displayed when an editing session begins.
TextInputBase
 InheritedspellCheck : Boolean
Gets or sets a value that enables spell-check.
TextInputBase
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent
 InheritedstyleChildren : Boolean
Allows you to style the children of this component with CSS.
UIComponent
 Inheritedtext : String
Gets or sets the text of the component.
TextInputBase

Protected Properties

 PropertyDefined By
 InheritedaccessibilityImplimentationClass : Class
UIComponent
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
TextArea
 InheritedexplicitLocale : Boolean
Set to true when the locale property has been set externally.
UIComponent
 InheritedinternalID : String
The Component's Id used for styling.
UIComponent
 InheritedlongPressEnabled : Boolean
Specifies whether the UIComponent can detect a long press.
UIComponent

Public Methods

 MethodDefined By
  
Creates a new TextArea instance.
TextArea
 Inherited
Cancels a long press from occuring on the component.
UIComponent
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
configureStyles(styles:Array):void
[override] The SkinnableComponent version styles the component with the base style first, and then styles it with the current state's style.
SkinnableComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
getClearIconRect():Rectangle
Gets the position and size of the clear icon.
TextInputBase
 Inherited
Returns the CSS selector for the object, composing it from its position in the display hierarchy and an optional ID selector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
hasFocus():Boolean
Returns true if the field has focus.
TextInputBase
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
TextInputBase
 Inherited
registerEmoticons(emoticons:Vector.<Emoticon>):void
Registers a set of emoticons with the TextInputBase.
TextInputBase
 Inherited
replaceText(startIndex:int, endIndex:int, insert:String):void
Replaces the text between at a given start and end index.
TextInputBase
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSelection(anchorIndex:int, activeIndex:int):void
Sets the range of selected text.
TextInputBase
 Inherited
setSkin(newSkin:Object):void
Set the skin object on the component for it to render.
SkinnableComponent
 Inherited
updateDefaultLocale(updateChildren:Boolean = true):void
Updates the locale property to be the same as the locale of the device.
UIComponent
 Inherited
Lets a component that contains text know that it should update its font formats as the font settings have changed.
UIComponent
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
allowShowContextMenu(target:IEventDispatcher):Boolean
When the user presses on the component this method is called with the object that dispatched the event.
UIComponent
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
Style the component after the style has changed.
UIComponent
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
excemptFromCSSStyling(target:*, property:String = null):void
Exempts a property on an object from being styled by CSS.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
getStyleApplier():Function
A style applier is a method that gets called every time a property from the stylesheet should be applied to the component.
UIComponent
 Inherited
getStyleForState(state:String):IStyleable
A utility method to get the styling information for a given state.
SkinnableComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
Is called when a user is no longer long pressing on the component.
UIComponent
 Inherited
Is called when a user long presses on the component.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
Calling this function will refresh the ContextMenu with whatever actions were set by contextActions.
UIComponent
 Inherited
Shows the context menu if there are contextActions associated with the control.
UIComponent
 Inherited
styleState():void
Style the component after state has changed.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent
 Inherited
updateSkin(unscaledWidth:Number, unscaledHeight:Number):void
Updates the skin's dimensions.
SkinnableComponent

Events

 Event Summary Defined By
 InheritedDispatched when an action in the Context Menu is selected.UIComponent
 InheritedDispatched when the user changes the content of the textfield by adding or removing text.TextInputBase
 InheritedDispatched when the Context Menu has closed to the DISMISSED state.UIComponent
 InheritedDispatched when the ContextMenu is closing to the DISMISSED state.UIComponent
 InheritedDispatched when the Context Menu has opened to the PEEK or EXPANDED state.UIComponent
 InheritedDispatched when the ContextMenu is opening from the DISMISSED state.UIComponent
 InheritedDispacthed when the user begins to edit the text.TextInputBase
 InheritedDispatched when the user has finished editing the text.TextInputBase
 InheritedDispatched when the CrossCut multiselect has been canceled.UIComponent
 InheritedDispatched when there has been a change in the selection of the text.TextInputBase

Property Detail

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is TextArea.


Implementation

protected function get cssID():String

maxLines


maxLines:int

Gets or sets the maximum number of lines to be measured by a layout.

The text component will render additional lines, if necessary, and will be clipped from view. Setting this value to 0 causes all lines to be measured.


Implementation

public function get maxLines():int
public function set maxLines(value:int):void

minLines


minLines:int

Gets or sets the minimum number of lines to be measured by a layout.

If the full text results in less lines than the minimum number of lines, then the size of the minimum number of lines will be returned when measuring the text. Setting this value less then 1 will have no effect and will be constrained to 1.


Implementation

public function get minLines():int
public function set minLines(value:int):void

paddingBottom


paddingBottom:int

Gets or sets the padding to the right of the text and the right of the skin.


Implementation

public function get paddingBottom():int
public function set paddingBottom(value:int):void

paddingTop


paddingTop:int

Gets or sets the padding to the left of the text and the left of the skin.


Implementation

public function get paddingTop():int
public function set paddingTop(value:int):void

Constructor Detail

TextArea()


public function TextArea()

Creates a new TextArea instance.





comments powered by Disqus