Package org.omegat.filters4.xml.openxml

Class MsOfficeFileFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters4.AbstractZipFilter

org.omegat.filters4.xml.openxml.MsOfficeFileFilter

All Implemented Interfaces:

IFilter

public class MsOfficeFileFilter
extends AbstractZipFilter

Filter for Microsoft Open XML.

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
MsOfficeFileFilter()

Method Summary

Modifier and Type	Method	Description
@Nullable Map<String,String>	changeOptions(Window parent, Map<String,String> currentOptions)	OpenXML Filter shows a modal dialog to edit its own options.
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	hasOptions()	OmegaT calls this to see whether the filter has any options.
boolean	isFileSupported(File inFile, Map<String,String> config, FilterContext context)	Returns whether the file is supported by the filter, given the file and possible file's encoding ( null encoding means autodetect).
static void	loadPlugins()	Register plugin into OmegaT.
static void	unloadPlugins()

Methods inherited from class org.omegat.filters4.AbstractZipFilter

isSourceEncodingVariable, isTargetEncodingVariable, processFile, readZipEntryContent

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, changeOptions, getFuzzyMark, getHint, getInEncodingLastParsedFile, getTargetFilenamePatterns, 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

isBilingual, isEnabledInDefault

Constructor Details

MsOfficeFileFilter

public MsOfficeFileFilter()

Method Details

loadPlugins

public static void loadPlugins()

Register plugin into OmegaT.

unloadPlugins

public static void unloadPlugins()

isFileSupported

public boolean isFileSupported(File inFile,
 Map<String,String> config,
 FilterContext context)

Description copied from class: AbstractFilter

Returns whether the file is supported by the filter, given the file and possible file's encoding ( null encoding means autodetect). Default implementation creates a reader and calls AbstractFilter.isFileSupported(BufferedReader). You should override only one of the two.

For example, DocBook files have .xml extension, as possibly many other XML files, so the filter should check a DTD of the document.

Specified by:

isFileSupported in interface IFilter

Overrides:

isFileSupported in class AbstractZipFilter

Parameters:

inFile - Source file.

config - filter's configuration options

context - Filter context.

Returns:

Does the filter support the file.

getFileFormatName

public String getFileFormatName()

Description copied from class: AbstractFilter

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()

Description copied from class: AbstractFilter

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

hasOptions

public boolean hasOptions()

Description copied from class: AbstractFilter

OmegaT calls this to see whether the filter has any options. By default, returns false, so filter authors should override this to tell OmegaT core that this filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True if the filter has any options, and false otherwise.

changeOptions

public @Nullable Map<String,String> changeOptions(Window parent,
 Map<String,String> currentOptions)

OpenXML Filter shows a modal dialog to edit its own options.

Parameters:

currentOptions - Current options to edit.

parent - parent window

Returns:

Updated filter options if user confirmed the changes, and current options otherwise.