public class FlexTextArea extends FlexScrollBase
The TextArea control supports the HTML rendering capabilities of Flash Player and AIR.
Modifier | Constructor and Description |
---|---|
protected |
FlexTextArea(JtfObjectHandle handle,
Desktop desktop)
Creates a new FlexTextArea with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
Color |
getColor()
Gets the color of text in the component, including the component label.
|
Color |
getDisabledColor()
Gets the background color of a component.
|
String |
getFontFamily()
Gets the name of the font to use.
|
double |
getFontSize()
Gets the height of the text, in pixels.
|
String |
getFontStyle()
Gets whether the text is italic font.
|
String |
getFontWeight()
Gets whether the text is boldface.
|
String |
getHorizontalScrollPolicy()
Gets whether the horizontal scroll bar is always on (ScrollPolicy.ON), always off (ScrollPolicy.OFF), or turns on when needed (ScrollPolicy.AUTO).
|
String |
getHtmlText()
Gets the text displayed by the TextInput control, including HTML markup that expresses the styles of that text.
|
double |
getLength()
Gets the number of characters of text displayed in the TextArea.
|
int |
getMaxChars()
Gets the maximum number of characters that users can enter in the text field.
|
String |
getRestrict()
Gets the set of characters that a user can enter into the control.
|
int |
getSelectionBeginIndex()
Gets the zero-based character index value of the first character in the current selection.
|
int |
getSelectionEndIndex()
Gets 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).
|
String |
getText()
Gets the plain text that appears in the control.
|
void |
input(String text)
Dispatched when the user types, deletes, or pastes text into the control.
|
boolean |
isDisplayAsPassword()
Gets whether this control is used for entering passwords.
|
boolean |
isEditable()
Gets whether the user can edit the text in this control.
|
boolean |
isWordWrap()
Gets whether text in the row should be word wrapped.
|
void |
scroll(int position,
FlexScrollDirection direction,
FlexScrollDetail detail)
Defines the value of the type property of the event object for a scroll event.
|
void |
selectText(int beginIndex,
int endIndex)
Lets you track selection within a text field.
|
void |
type(String keyCode)
Dispatched when the user presses a key.
|
void |
type(String keyCode,
ModifierKey keyModifier)
Dispatched when the user presses a key.
|
mouseScroll, mouseScroll
changeFocus, changeFocus, changeFocus, getAutomationClassName, getAutomationIndex, getAutomationName, getClassName, getCurrentState, getErrorColor, getErrorString, getId, getNumAutomationChildren, getPercentHeight, getPercentWidth, getScaleX, getScaleY, getThemeColor, getToolTip, isEnabled, isFocusEnabled, isUseHandCursor, move, move, move, setFocus
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, getAlpha, getHeight, getStyle, getTabIndex, getWidth, getX, getY, isMouseEnabled, isTabChildren, isTabEnabled, isVisible, mouseMove, mouseMove, nativeToString, pressKeys, pressKeys, pressMouse, pressMouse, pressMouse, pressMouse, releaseKeys, releaseKeys, releaseMouse, releaseMouse, releaseMouse, releaseMouse, typeKeys, typeKeys, typeKeys, typePasswordKeys, typePasswordKeys, typePasswordKeys
captureBitmap, captureBitmap, exists, exists, generateLocator, getChildren, getDynamicMethodList, getParent, getPropertyList, getRect, getRect, getValue, highlightObject, highlightObject, highlightObject, invokeMethods, textCapture, textCapture, textClick, textClick, textClick, textClick, textClick, textClick, textExists, textExists, textExists, textExists, textExists, textRectangle, textRectangle, textRectangle, textRectangle, textRectangle, waitForChildDisappearance, waitForChildDisappearance, waitForDisappearance, waitForDisappearance, waitForObject, waitForObject, waitForProperty, waitForProperty
equals, exists, find, find, findAll, findAll, getCustomTypeName, getDesktop, getHandle, getLocator, getProperty, getTypeName, hashCode, imageClick, imageClick, imageClick, imageClick, imageClick, imageClick, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageExists, imageExists, imageExists, imageExistsFile, imageExistsFile, imageExistsFile, imageRectangle, imageRectangle, imageRectangle, imageRectangleFile, imageRectangleFile, imageRectangleFile, invoke, preventFinalLocator, setProperty, toString
protected FlexTextArea(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the FlexTextAreadesktop
- the desktop on which this object livespublic void input(String text)
text
- the character or sequence of characters entered by the userpublic void scroll(int position, FlexScrollDirection direction, FlexScrollDetail detail)
position
- contains the new scroll positiondirection
- contains the scroll direction, either ScrollEventDirection.HORIZONTAL or ScrollEventDirection.VERTICAL.detail
- provides the specifics of the type of scroll activity. Constants for the possible values are provided in the ScrollEventDetail class.public void selectText(int beginIndex, int endIndex)
beginIndex
- index at which selection startsendIndex
- index at which selection endspublic void type(String keyCode)
keyCode
- the key code value of the key pressed or releasedpublic void type(String keyCode, ModifierKey keyModifier)
keyCode
- the key code value of the key pressed or releasedkeyModifier
- the key modifiers (for example, the Ctrl key) to usepublic Color getColor()
public Color getDisabledColor()
You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.
public boolean isDisplayAsPassword()
If true, the field does not display entered text, instead, each text character entered into the control appears as the character *
. The default value is false.
public boolean isEditable()
If true, the user can edit the text. The default value is true.
public String getFontFamily()
Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is Verdana
.
public double getFontSize()
The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
public String getFontStyle()
Recognized values are normal
and italic
. The default value is normal
.
public String getFontWeight()
Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
public String getHorizontalScrollPolicy()
The default value is ScrollPolicy.AUTO.
public String getHtmlText()
When you specify HTML text in this property, you can use the subset of HTML tags that is supported by the Flash TextField control.
public double getLength()
public int getMaxChars()
public String getRestrict()
public int getSelectionBeginIndex()
public int getSelectionEndIndex()
public String getText()
Its appearance is determined by the CSS styles of this Label control.
The default value is "".
getText
in class TestObject
public boolean isWordWrap()
If true, enables word wrapping for text in the rows. Only takes effect if the variableRowHeight property is also true. The default value is false.
Copyright 2009-2012 Micro Focus. All Rights Reserved.