|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.widgets.form.fields.FormItem
com.smartgwt.client.widgets.form.fields.TextAreaItem
public class TextAreaItem
Class for editable multi-line text areas (uses HTML <TEXTAREA>
object)
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
TextAreaItem()
|
|
TextAreaItem(JavaScriptObject jsObj)
|
|
TextAreaItem(String name)
|
|
TextAreaItem(String name,
String title)
|
Method Summary | |
---|---|
void |
deselectValue()
If this item currently has focus, clear the current selection. |
void |
deselectValue(boolean start)
If this item currently has focus, clear the current selection. |
int |
getHeight()
default height of this item |
VerticalAlignment |
getIconVAlign()
Align icons with the top edge of text area icons by default. |
Integer |
getLength()
Return the length. |
static TextAreaItem |
getOrCreateRef(JavaScriptObject jsObj)
|
int[] |
getSelectionRange()
For text-based items, this method returns the indices of the start/end of the current selection. |
Boolean |
getSelectOnFocus()
Allows the 'selectOnFocus' behavior to be
configured on a per-FormItem basis. |
Boolean |
getShowHintInField()
If showing hint for this form item, should it be shown within the field? |
String |
getTextBoxStyle()
Base CSS class to apply to this item's input element. |
int |
getWidth()
default width of this item |
TextAreaWrap |
getWrap()
Text wrapping style. |
void |
selectValue()
Put focus in this item and select the entire value. |
void |
setHeight(int height)
default height of this item |
void |
setIconVAlign(VerticalAlignment iconVAlign)
Align icons with the top edge of text area icons by default. |
void |
setLength(Integer length)
Set the length. |
void |
setSelectionRange(int start,
int end)
Puts focus into this form item and selects characters between the given indices. |
void |
setSelectOnFocus(Boolean selectOnFocus)
Allows the 'selectOnFocus' behavior to be
configured on a per-FormItem basis. |
void |
setShowHintInField(Boolean showHintInField)
If showing hint for this form item, should it be shown within the field? |
void |
setTextBoxStyle(String textBoxStyle)
Base CSS class to apply to this item's input element. |
void |
setWidth(int width)
default width of this item |
void |
setWrap(TextAreaWrap wrap)
Text wrapping style. |
Methods inherited from class com.smartgwt.client.core.RefDataClass |
---|
getRef, getRef |
Methods inherited from class com.smartgwt.client.core.DataClass |
---|
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public TextAreaItem()
public TextAreaItem(JavaScriptObject jsObj)
public TextAreaItem(String name)
public TextAreaItem(String name, String title)
Method Detail |
---|
public static TextAreaItem getOrCreateRef(JavaScriptObject jsObj)
public void setWidth(int width)
setWidth
in class FormItem
width
- width Default value is 150public int getWidth()
getWidth
in class FormItem
public void setHeight(int height)
setHeight
in class FormItem
height
- height Default value is 100public int getHeight()
getHeight
in class FormItem
public void setTextBoxStyle(String textBoxStyle)
setTextBoxStyle
in class FormItem
textBoxStyle
- textBoxStyle Default value is "textItem"public String getTextBoxStyle()
getTextBoxStyle
in class FormItem
public void setIconVAlign(VerticalAlignment iconVAlign)
setIconVAlign
in class FormItem
iconVAlign
- iconVAlign Default value is Canvas.TOPpublic VerticalAlignment getIconVAlign()
getIconVAlign
in class FormItem
public void setSelectOnFocus(Boolean selectOnFocus)
'selectOnFocus'
behavior to be
configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus
.
setSelectOnFocus
in class FormItem
selectOnFocus
- selectOnFocus Default value is nullpublic Boolean getSelectOnFocus()
'selectOnFocus'
behavior to be
configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus
.
getSelectOnFocus
in class FormItem
public void setShowHintInField(Boolean showHintInField)
CSS style for the hint is textBoxStyle
with the suffix "Hint" appended to
it.
Note : This is an advanced setting
showHintInField
- showHintInField Default value is nullpublic Boolean getShowHintInField()
CSS style for the hint is textBoxStyle
with the suffix "Hint" appended to
it.
public void setSelectionRange(int start, int end)
start
- selection starting character indexend
- end of selection character indexpublic void selectValue()
public void deselectValue()
public void deselectValue(boolean start)
start
- By default the text insertion cursor will be moved to the end of the current value - pass in this parameter to move to
the start insteadpublic void setLength(Integer length)
length
- the lengthpublic Integer getLength()
public void setWrap(TextAreaWrap wrap)
wrap
- wrap Default value is TextAreaWrap.SOFT
public TextAreaWrap getWrap()
public int[] getSelectionRange()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |