com.smartgwt.client.types

Enum EscapingMode

java.lang.Object

java.lang.Enum<EscapingMode>

com.smartgwt.client.types.EscapingMode

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<EscapingMode>

public enum EscapingMode
extends java.lang.Enum<EscapingMode>
implements ValueEnum

Mode for escaping text values when using DataSource.recordsAsText() or DataSource.recordsFromText().

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKSLASH double quotes in data values have a blackslash (\) prepended, similar to String escaping in JavaScript and Java
DOUBLE Literal double quotes in data values are doubled (""), as expected by Microsoft Excel when pasting text values

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static EscapingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EscapingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOUBLE

public static final EscapingMode DOUBLE

Literal double quotes in data values are doubled (""), as expected by Microsoft Excel when pasting text values

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "double".

BACKSLASH

public static final EscapingMode BACKSLASH

double quotes in data values have a blackslash (\) prepended, similar to String escaping in JavaScript and Java

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "backslash".

Method Detail

values

public static EscapingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EscapingMode c : EscapingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EscapingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

Specified by:

getValue in interface ValueEnum