com.smartgwt.client.data

## Class TextSettings

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

- Direct Known Subclasses:
    TextExportSettings, TextImportSettings

      public class TextSettings
      extends BaseClass

  Common base class of `TextImportSettings`.

- - ### Field Summary

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

      `config, id, scClassName`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TextSettings()`
    `TextSettings(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `com.google.gwt.core.client.JavaScriptObject` | `create()`
    `EscapingMode` | `getEscapingMode()` `EscapingMode` expected for escaping special characters embedded in text values.
    `java.lang.String[]` | `getFieldList()` For export, a set of fields to export.
    `java.lang.String` | `getFieldSeparator()` Separator between field values.
    `java.lang.String` | `getLineSeparator()` Separator between Records.
    `static TextSettings` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `boolean` | `isCreated()` Definition of a hilite style.
    `void` | `setEscapingMode(EscapingMode escapingMode)` `EscapingMode` expected for escaping special characters embedded in text values.
    `void` | `setFieldList(java.lang.String... fieldList)` For export, a set of fields to export.
    `void` | `setFieldSeparator(java.lang.String fieldSeparator)` Separator between field values.
    `void` | `setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `void` | `setLineSeparator(java.lang.String lineSeparator)` Separator between Records.

    - ### Methods inherited from class com.smartgwt.client.core.BaseClass

      `asSGWTComponent, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getJsObj, getOrCreateJsObj, getRef, getScClassName, internalSetID, internalSetID, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setID, setProperty, setProperty, setProperty, setProperty, setScClassName`

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

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

- - ### Constructor Detail

    - #### TextSettings

          public TextSettings()

    - #### TextSettings

          public TextSettings(com.google.gwt.core.client.JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static TextSettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### setJavaScriptObject

          public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### create

          public com.google.gwt.core.client.JavaScriptObject create()

      Specified by:
        `create` in class `BaseClass`

    - #### setEscapingMode

          public void setEscapingMode(EscapingMode escapingMode)
                               throws java.lang.IllegalStateException

      `EscapingMode` expected for escaping special characters embedded in text values.
      Parameters:
        `escapingMode` - escapingMode Default value is "backslash"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getEscapingMode

          public EscapingMode getEscapingMode()

      `EscapingMode` expected for escaping special characters embedded in text values.
      Returns:
        EscapingMode

    - #### setFieldSeparator

          public void setFieldSeparator(java.lang.String fieldSeparator)
                                 throws java.lang.IllegalStateException

      Separator between field values. Default is a comma character, producing CSV (comma-separated values) format.
      Parameters:
        `fieldSeparator` - . See `String`. Default value is ","
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getFieldSeparator

          public java.lang.String getFieldSeparator()

      Separator between field values. Default is a comma character, producing CSV (comma-separated values) format.
      Returns:
        . See `String`

    - #### setLineSeparator

          public void setLineSeparator(java.lang.String lineSeparator)
                                throws java.lang.IllegalStateException

      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 in `TextExportSettings`.
      Parameters:
        `lineSeparator` - . See `String`. Default value is null
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getLineSeparator

          public java.lang.String 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 in `TextExportSettings`.
      Returns:
        . See `String`

    - #### isCreated

          public boolean isCreated()

      Definition of a hilite style.

      See `Hiliting` for an overview.

      Overrides:
        `isCreated` in class `BaseClass`

    - #### getFieldList

          public java.lang.String[] 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 values, in order.

      If `fieldList` is 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:
        String

    - #### setFieldList

          public void setFieldList(java.lang.String... fieldList)
                            throws java.lang.IllegalStateException

      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 values, in order.

      If `fieldList` is 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` - fieldList Default value is null
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created