org.omegat.filters3.xml.xhtml

Class XHTMLFilter

java.lang.Object

org.omegat.filters2.AbstractFilter

org.omegat.filters3.xml.XMLFilter

org.omegat.filters3.xml.xhtml.XHTMLFilter

All Implemented Interfaces:

IFilter

public class XHTMLFilter
extends XMLFilter

Filter for XHTML files.

Field Summary

Fields inherited from class org.omegat.filters2.AbstractFilter

ENCODING_AUTO_HUMAN, entryAlignCallback, entryParseCallback, entryTranslateCallback, inEncodingLastParsedFile, processOptions, 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 and Description
XHTMLFilter() Creates a new instance of XHTMLFilter

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	changeOptions(java.awt.Window parent, java.util.Map<java.lang.String,java.lang.String> currentOptions) XHTML Filter shows a modal dialog to edit its own options.
Instance[]	getDefaultInstances() The default list of filter instances that this filter class has.
java.lang.String	getFileFormatName() Human-readable name of the File Format this filter supports.
boolean	hasOptions() Returns true to indicate that the XHTML filter has options.
boolean	isFileSupported(java.io.File inFile, java.util.Map<java.lang.String,java.lang.String> config, FilterContext context) Checking whether it is a valid XHTML file.
boolean	isSourceEncodingVariable() Either the encoding can be read, or it is UTF-8.
boolean	isTargetEncodingVariable() Yes, XHTML may be written out in a variety of encodings.
protected boolean	requirePrevNextFields() Method can be overridden to return true, in case you want previous and next segment to be included in the search for a translation, when alternative translations are provided by the user.
java.lang.String	translate(java.lang.String entry, java.util.List<ProtectedPart> protectedParts) Overrides superimplementation not to send translatable content on XHTML validity check, and don't translate items that match regular expression.

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

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

Methods inherited from class org.omegat.filters2.AbstractFilter

alignFile, alignFile, changeOptions, getFuzzyMark, getHint, getInEncodingLastParsedFile, getInputEncoding, getOutputEncoding, getTargetFilenamePatterns, parseFile, processEntry, processEntry, setCallbacks, translateFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegat.filters2.IFilter

isBilingual

Constructor Detail

XHTMLFilter

public XHTMLFilter()

Creates a new instance of XHTMLFilter

Method Detail

requirePrevNextFields

protected boolean requirePrevNextFields()

Description copied from class: AbstractFilter

Method can be overridden to return true, in case you want previous and next segment to be included in the search for a translation, when alternative translations are provided by the user. (normally, only the filename is used) Technically it means that parsing happens in two passes and prev/next segments will be linked, so it comes with a cost

Overrides:

requirePrevNextFields in class AbstractFilter

getFileFormatName

public java.lang.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, XHTML may be written out in a variety of encodings.

Specified by:

isTargetEncodingVariable in interface IFilter

Overrides:

isTargetEncodingVariable in class XMLFilter

Returns:

true

isFileSupported

public boolean isFileSupported(java.io.File inFile,
                               java.util.Map<java.lang.String,java.lang.String> config,
                               FilterContext context)

Checking whether it is a valid XHTML file.

Specified by:

isFileSupported in interface IFilter

Overrides:

isFileSupported in class AbstractFilter

Parameters:

inFile - Source file.

config - filter's configuration options

context - Filter context.

Returns:

Does the filter support the file.

translate

public java.lang.String translate(java.lang.String entry,
                                  java.util.List<ProtectedPart> protectedParts)

Overrides superimplementation not to send translatable content on XHTML validity check, and don't translate items that match regular expression.

Overrides:

translate in class XMLFilter

hasOptions

public boolean hasOptions()

Returns true to indicate that the XHTML filter has options.

Specified by:

hasOptions in interface IFilter

Overrides:

hasOptions in class AbstractFilter

Returns:

True, because the XHTML filter has options.

changeOptions

public java.util.Map<java.lang.String,java.lang.String> changeOptions(java.awt.Window parent,
                                                                      java.util.Map<java.lang.String,java.lang.String> currentOptions)

XHTML 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.