com.gnostice.documents.txt

Class TXTEncoderSettings

java.lang.Object

com.gnostice.documents.EncoderSettings

com.gnostice.documents.txt.TXTEncoderSettings

public class TXTEncoderSettings
extends EncoderSettings

This class specifies text format settings for converting documents.

Constructor Summary

Constructors

Constructor and Description
TXTEncoderSettings() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
FileEncoding	getFileEncoding() Returns text file encoding scheme.
TextFormatterSettings	getFormatter() Returns text-formatting settings.
String	getMIMEType() Returns output format.
String[]	getSupportedMIMETypes() Returns supported MIME types.
boolean	isByteOrderMarkOn() Returns whether BOM (byte-order mark) is enabled.
void	setByteOrderMarkOn(boolean byteOrderMarkOn) Specifies whether BOM mark needs to be enabled.
void	setFileEncoding(FileEncoding fileEncoding)

Methods inherited from class com.gnostice.documents.EncoderSettings

get

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TXTEncoderSettings

public TXTEncoderSettings()

Creates a new instance of this class.

Method Detail

getSupportedMIMETypes

public String[] getSupportedMIMETypes()

Description copied from class: EncoderSettings

Returns supported MIME types.

Overrides:

getSupportedMIMETypes in class EncoderSettings

Returns:

array containing the MIME types

getMIMEType

public String getMIMEType()

Description copied from class: EncoderSettings

Returns output format.

Overrides:

getMIMEType in class EncoderSettings

Returns:

file extension identifying the output format

setFileEncoding

public void setFileEncoding(FileEncoding fileEncoding)
                     throws XDocException

Throws:

XDocException

setByteOrderMarkOn

public void setByteOrderMarkOn(boolean byteOrderMarkOn)

Specifies whether BOM mark needs to be enabled.

Parameters:

byteOrderMarkOn -

isByteOrderMarkOn

public boolean isByteOrderMarkOn()

Returns whether BOM (byte-order mark) is enabled.

Returns:

true if enabled; false if otherwise

getFileEncoding

public FileEncoding getFileEncoding()

Returns text file encoding scheme.

Returns:

constant specifying the encoding scheme

getFormatter

public TextFormatterSettings getFormatter()

Returns text-formatting settings.

Returns:

text-formatting settings