Package org.omegat.filters3.xml.helpandmanual

Class HelpAndManualFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.XMLFilter

org.omegat.filters3.xml.helpandmanual.HelpAndManualFilter

All Implemented Interfaces:

IFilter, Translator

public class HelpAndManualFilter
extends XMLFilter

Filter for Help & Manual files.

Field Summary

Fields inherited from class org.omegat.filters2.AbstractFilter

ENCODING_AUTO_HUMAN, TARGET_DEFAULT, TFP_EXTENSION, TFP_FILE_FILTER_NAME, TFP_FILE_SOURCE_ENCODING, TFP_FILE_TARGET_ENCODING, TFP_FILENAME, TFP_NAMEONLY, TFP_SYSTEM_HOST_NAME, TFP_SYSTEM_OS_ARCH, TFP_SYSTEM_OS_NAME, TFP_SYSTEM_OS_VERSION, TFP_SYSTEM_USER_NAME, TFP_TARGET_COUNTRY_CODE, TFP_TARGET_COUTRY_CODE, TFP_TARGET_LANG_CODE, TFP_TARGET_LANGUAGE, TFP_TARGET_LOCALE, TFP_TARGET_LOCALE_LCID, TFP_TIMESTAMP_LA, TFP_TIMESTAMP_LD, TFP_TIMESTAMP_LDD, TFP_TIMESTAMP_LH, TFP_TIMESTAMP_LHH, TFP_TIMESTAMP_LM, TFP_TIMESTAMP_LMM, TFP_TIMESTAMP_LS, TFP_TIMESTAMP_LSS, TFP_TIMESTAMP_LYYYY, TFP_TIMESTAMP_UD, TFP_TIMESTAMP_UEEE, TFP_TIMESTAMP_UEEEE, TFP_TIMESTAMP_UH, TFP_TIMESTAMP_UHH, TFP_TIMESTAMP_UM, TFP_TIMESTAMP_UMM, TFP_TIMESTAMP_UMMM

Constructor Summary

Constructors

Constructor	Description
HelpAndManualFilter()	Creates a new instance of HelpAndManual

Method Summary

Modifier and Type	Method	Description
Instance[]	getDefaultInstances()	The default list of filter instances that this filter class has.
String	getFileFormatName()	Human-readable name of the File Format this filter supports.
boolean	isSourceEncodingVariable()	Either the encoding can be read, or it is UTF-8.
boolean	isTargetEncodingVariable()	Yes, Help & Manual may be written out in a variety of encodings.
static void	loadPlugins()	Register plugin into OmegaT.
static void	unloadPlugins()

Methods inherited from class org.omegat.filters3.xml.XMLFilter

comment, createReader, createWriter, getDialect, getSourceLanguage, getTargetLanguage, isFileSupported, isInIgnored, processFile, tagEnd, tagStart, text, translate

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getFuzzyMark, getHint, getInEncodingLastParsedFile, getTargetFilenamePatterns, hasOptions, isFileSupported, parseFile, setCallbacks, translateFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegat.filters2.IFilter

changeOptions, isBilingual, isEnabledInDefault

Constructor Details

HelpAndManualFilter

public HelpAndManualFilter()

Creates a new instance of HelpAndManual

Method Details

loadPlugins

public static void loadPlugins()

Register plugin into OmegaT.

unloadPlugins

public static void unloadPlugins()

getFileFormatName

public String getFileFormatName()

Human-readable name of the File Format this filter supports.

Specified by:

getFileFormatName in interface IFilter

Specified by:

getFileFormatName in class AbstractFilter

Returns:

File format name

getDefaultInstances

public Instance[] getDefaultInstances()

The default list of filter instances that this filter class has. One filter class may have different filter instances, different by source file mask, encoding of the source file etc.

Note that the user may change the instances freely.

Specified by:

getDefaultInstances in interface IFilter

Specified by:

getDefaultInstances in class AbstractFilter

Returns:

Default filter instances

isSourceEncodingVariable

public boolean isSourceEncodingVariable()

Either the encoding can be read, or it is UTF-8.

Specified by:

isSourceEncodingVariable in interface IFilter

Overrides:

isSourceEncodingVariable in class XMLFilter

Returns:

false

isTargetEncodingVariable

public boolean isTargetEncodingVariable()

Yes, Help & Manual may be written out in a variety of encodings.

Specified by:

isTargetEncodingVariable in interface IFilter

Overrides:

isTargetEncodingVariable in class XMLFilter

Returns:

true