Package com.smartgwt.client.data

# Class TextImportSettings

java.lang.Object
com.smartgwt.client.core.BaseClass
com.smartgwt.client.data.TextSettings
com.smartgwt.client.data.TextImportSettings

All Implemented Interfaces:
  `HasHandlers`

public class TextImportSettings extends TextSettings
Settings for use with `DataSource.recordsFromText()`.

- ## Field Summary

  ### Fields inherited from class com.smartgwt.client.core.BaseClass

  `config, configOnly, factoryCreated, factoryProperties, id, scClassName`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `TextImportSettings()`
  `TextImportSettings(JavaScriptObject jsObj)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `JavaScriptObject`
  `create()`
  `Boolean`
  `getHasHeaderLine()`
  If set to true, the data is assumed to have a header line that lists titles for each field, which should be parsed.
  `static TextImportSettings`
  `getOrCreateRef(JavaScriptObject jsObj)`
  `TextImportSettings`
  `setHasHeaderLine(Boolean hasHeaderLine)`
  If set to true, the data is assumed to have a header line that lists titles for each field, which should be parsed.

  ### Methods inherited from class com.smartgwt.client.data.TextSettings

  `getEscapingMode, getFieldList, getFieldSeparator, getJsObj, getLineSeparator, getOrCreateJsObj, isCreated, setEscapingMode, setFieldList, setFieldSeparator, setJavaScriptObject, setLineSeparator`

  ### 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`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### TextImportSettings

    public TextImportSettings()

  - ### TextImportSettings

    public TextImportSettings(JavaScriptObject jsObj)

- ## Method Details

  - ### getOrCreateRef

    public static TextImportSettings getOrCreateRef(JavaScriptObject jsObj)

  - ### create

    public JavaScriptObject create()
    Overrides:
      `create` in class `TextSettings`

  - ### setHasHeaderLine

    public TextImportSettings setHasHeaderLine(Boolean hasHeaderLine) throws IllegalStateException
    If set to true, the data is assumed to have a header line that lists titles for each field, which should be parsed.

    `recordsFromText` will then try to find a same-named DataSourceField by checking parsed titles against both `DataSourceField.title` and `DataSourceField.name` (titles first), doing a case-insensitive comparison with any leading or trailing whitespace removed from the title. If no field matches, data will appear in the returned Records under the exact title parsed from the header line.

    If this approach will not find appropriate DataSourceFields, parse the header line before calling `recordsFromText()`, and provide the list of field names to use when parsing data as `TextSettings.fieldList`.

    Parameters:
      `hasHeaderLine` - New hasHeaderLine value. Default value is false
    Returns:
      `TextImportSettings` instance, for chaining setter calls
    Throws:
      `IllegalStateException` - this property cannot be changed after the underlying component has been created

  - ### getHasHeaderLine

    public Boolean getHasHeaderLine()
    If set to true, the data is assumed to have a header line that lists titles for each field, which should be parsed.

    `recordsFromText` will then try to find a same-named DataSourceField by checking parsed titles against both `DataSourceField.title` and `DataSourceField.name` (titles first), doing a case-insensitive comparison with any leading or trailing whitespace removed from the title. If no field matches, data will appear in the returned Records under the exact title parsed from the header line.

    If this approach will not find appropriate DataSourceFields, parse the header line before calling `recordsFromText()`, and provide the list of field names to use when parsing data as `TextSettings.fieldList`.

    Returns:
      Current hasHeaderLine value. Default value is false