Class TextSettings
- All Implemented Interfaces:
HasHandlers
- Direct Known Subclasses:
TextExportSettings,TextImportSettings
TextImportSettings.-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()EscapingModeexpected for escaping special characters embedded in text values.String[]For export, a set of fields to export.Separator between field values.getJsObj()Separator between Records.static TextSettingsgetOrCreateRef(JavaScriptObject jsObj) booleansetEscapingMode(EscapingMode escapingMode) EscapingModeexpected for escaping special characters embedded in text values.setFieldList(String... fieldList) For export, a set of fields to export.setFieldSeparator(String fieldSeparator) Separator between field values.voidsetLineSeparator(String lineSeparator) Separator between Records.Methods inherited from class com.smartgwt.client.core.BaseClass
addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName
-
Constructor Details
-
TextSettings
public TextSettings() -
TextSettings
-
-
Method Details
-
getOrCreateRef
-
setJavaScriptObject
- Overrides:
setJavaScriptObjectin classBaseClass
-
create
-
isCreated
public boolean isCreated() -
getJsObj
-
getOrCreateJsObj
- Overrides:
getOrCreateJsObjin classBaseClass
-
setEscapingMode
EscapingModeexpected for escaping special characters embedded in text values.- Parameters:
escapingMode- New escapingMode value. Default value is "backslash"- Returns:
TextSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getEscapingMode
EscapingModeexpected for escaping special characters embedded in text values.- Returns:
- Current escapingMode value. Default value is "backslash"
-
setFieldList
For export, a set of fields to export. Default is to export all DataSource fields.Fields may be specified that are not in the DataSource but for which data values are present in the provided Records. In this case the field is assumed to be of type "text".
For import, names of DataSource fields to use to parse values, in order.
If
fieldListis unset, DataSource fields are used, in order.If more values exist in a given Record than the listed fields or than all DataSource fields, remaining values are ignored.
- Parameters:
fieldList- New fieldList value. Default value is null- Returns:
TextSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getFieldList
For export, a set of fields to export. Default is to export all DataSource fields.Fields may be specified that are not in the DataSource but for which data values are present in the provided Records. In this case the field is assumed to be of type "text".
For import, names of DataSource fields to use to parse values, in order.
If
fieldListis unset, DataSource fields are used, in order.If more values exist in a given Record than the listed fields or than all DataSource fields, remaining values are ignored.
- Returns:
- Current fieldList value. Default value is null
-
setFieldSeparator
Separator between field values. Default is a comma character, producing CSV (comma-separated values) format.- Parameters:
fieldSeparator- New fieldSeparator value. Default value is ","- Returns:
TextSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getFieldSeparator
Separator between field values. Default is a comma character, producing CSV (comma-separated values) format.- Returns:
- Current fieldSeparator value. Default value is ","
-
setLineSeparator
Separator between Records. For import, default of null means that either the Unix/Mac format of just a newline ("\n") or the typical DOS/Windows format of a carriage return and newline ("\r\n") will be accepted. For export, overridden inTextExportSettings.- Parameters:
lineSeparator- New lineSeparator value. Default value is null- Returns:
TextSettingsinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getLineSeparator
Separator between Records. For import, default of null means that either the Unix/Mac format of just a newline ("\n") or the typical DOS/Windows format of a carriage return and newline ("\r\n") will be accepted. For export, overridden inTextExportSettings.- Returns:
- Current lineSeparator value. Default value is null
-