public class StaticTextItem extends FormItem
scClassNameid| Constructor and Description |
|---|
StaticTextItem() |
StaticTextItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
StaticTextItem(java.lang.String name) |
StaticTextItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.Boolean |
getApplyHeightToTextBox()
If
height is specified, should it be applied to the
item's text box element? |
boolean |
getCanSelectText()
Should the user be able to select the text in this item?
|
java.lang.Boolean |
getClipValue()
If true, text that exceeds the specified size of the form item will be clipped.
|
DateDisplayFormat |
getDateFormatter()
Display format to use for date type values within this formItem.
|
java.lang.Boolean |
getEscapeHTML()
By default HTML values in a staticTextItem will be interpreted by the browser.
|
static StaticTextItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getTextBoxStyle()
Base CSS class for this item
|
java.lang.Boolean |
getWrap()
If true, item contents can wrap.
|
void |
setApplyHeightToTextBox(java.lang.Boolean applyHeightToTextBox)
If
height is specified, should it be applied to the
item's text box element? |
void |
setCanSelectText(boolean canSelectText)
Should the user be able to select the text in this item?
|
void |
setClipValue(java.lang.Boolean clipValue)
If true, text that exceeds the specified size of the form item will be clipped.
|
void |
setDateFormatter(DateDisplayFormat dateFormatter)
Display format to use for date type values within this formItem.
|
static void |
setDefaultProperties(StaticTextItem staticTextItemProperties)
Class level method to set the default properties of this class.
|
void |
setEscapeHTML(java.lang.Boolean escapeHTML)
By default HTML values in a staticTextItem will be interpreted by the browser.
|
void |
setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class for this item
|
void |
setWrap(java.lang.Boolean wrap)
If true, item contents can wrap.
|
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getDataPath, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHeight, getHeightAsString, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWidthAsString, getWrapTitle, hasAdvancedCriteria, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setDataPath, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setExportFormat, setFetchMissingValues, setFilterLocally, setFormat, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectequals, getJsObj, hashCode, setJavaScriptObject, setJsObjpublic StaticTextItem()
public StaticTextItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public StaticTextItem(java.lang.String name)
public StaticTextItem(java.lang.String name,
java.lang.String title)
public static StaticTextItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setApplyHeightToTextBox(java.lang.Boolean applyHeightToTextBox)
height is specified, should it be applied to the
item's text box element? Overridden to be false for StaticTextItems by default.
See shouldApplyHeightToTextBox() for more
information.
Note : This is an advanced setting
setApplyHeightToTextBox in class FormItemapplyHeightToTextBox - Default value is falsepublic java.lang.Boolean getApplyHeightToTextBox()
height is specified, should it be applied to the
item's text box element? Overridden to be false for StaticTextItems by default.
See shouldApplyHeightToTextBox() for more
information.
getApplyHeightToTextBox in class FormItempublic void setCanSelectText(boolean canSelectText)
setCanSelectText in class FormItemcanSelectText - Default value is truepublic boolean getCanSelectText()
getCanSelectText in class FormItempublic void setClipValue(java.lang.Boolean clipValue)
clipValue - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getClipValue()
Appearance overview and related methodspublic void setDateFormatter(DateDisplayFormat dateFormatter)
Note that Fields of type "date",
"datetime" or "time" will be edited using a DateItem or TimeItem by
default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
The timeFormatter may also be used to format underlying
Date values as times (ommitting the date part entirely). If both dateFormatter and
timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used,
otherwise the dateFormatter
If item.dateFormatter and item.timeFormatter is
unspecified, date display format may be defined at the component level via dateFormatter, or for fields of type
"datetime" datetimeFormatter.
Otherwise for fields of type "date", default is to use the system-wide default short date format, configured via Date.setShortDisplayFormat(). For fields of type "datetime" or for
Date values in fields whose type does not inherit from the logical "date" type, default is to use the system-wide normal
date format configured via Date.setNormalDisplayFormat()
(using "toNormalDate()" on logical "date" type fields is not desirable as this would display the time
component of the date object to the user).
Specify any valid DateDisplayFormat to
change the format used by this item.
Note : This is an advanced setting
setDateFormatter in class FormItemdateFormatter - Default value is nullFormItem.setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat),
Appearance overview and related methodspublic DateDisplayFormat getDateFormatter()
Note that Fields of type "date",
"datetime" or "time" will be edited using a DateItem or TimeItem by
default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
The timeFormatter may also be used to format underlying
Date values as times (ommitting the date part entirely). If both dateFormatter and
timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used,
otherwise the dateFormatter
If item.dateFormatter and item.timeFormatter is
unspecified, date display format may be defined at the component level via dateFormatter, or for fields of type
"datetime" datetimeFormatter.
Otherwise for fields of type "date", default is to use the system-wide default short date format, configured via Date.setShortDisplayFormat(). For fields of type "datetime" or for
Date values in fields whose type does not inherit from the logical "date" type, default is to use the system-wide normal
date format configured via Date.setNormalDisplayFormat()
(using "toNormalDate()" on logical "date" type fields is not desirable as this would display the time
component of the date object to the user).
Specify any valid DateDisplayFormat to
change the format used by this item.
getDateFormatter in class FormItemFormItem.getTimeFormatter(),
Appearance overview and related methodspublic void setEscapeHTML(java.lang.Boolean escapeHTML)
"<b>AAA</b>") is
displayed to the user rather than the interpreted HTML (for example "AAA")escapeHTML - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getEscapeHTML()
"<b>AAA</b>") is
displayed to the user rather than the interpreted HTML (for example "AAA")Appearance overview and related methodspublic void setTextBoxStyle(java.lang.String textBoxStyle)
setTextBoxStyle in class FormItemtextBoxStyle - See FormItemBaseStyle . Default value is "staticTextItem"Appearance overview and related methodspublic java.lang.String getTextBoxStyle()
getTextBoxStyle in class FormItemFormItemBaseStyleAppearance overview and related methodspublic void setWrap(java.lang.Boolean wrap)
wrap - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getWrap()
Appearance overview and related methodspublic static void setDefaultProperties(StaticTextItem staticTextItemProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
staticTextItemProperties - properties that should be used as new defaults when instances of this class are created