Package org.omegat.filters2.moodlephp

Class MoodlePHPFilter

java.lang.Object
org.omegat.filters2.AbstractFilter
org.omegat.filters2.moodlephp.MoodlePHPFilter
All Implemented Interfaces:
IFilter
public class MoodlePHPFilter extends AbstractFilter
Filter for support Moodle PHP files. Code adapted from the file: MozillaDTDFilter.java

  • Field Details

    • OPTION_REMOVE_STRINGS_UNTRANSLATED

      public static final String OPTION_REMOVE_STRINGS_UNTRANSLATED
      See Also:

    • removeStringsUntranslated

      public boolean removeStringsUntranslated
      If true, will remove non-translated segments in the target files

  • Constructor Details

    • MoodlePHPFilter

      public MoodlePHPFilter()

  • Method Details

    • loadPlugins

      public static void loadPlugins()
      Register plugin into OmegaT.

    • unloadPlugins

      public static void unloadPlugins()

    • 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

    • 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

    • isSourceEncodingVariable

      public boolean isSourceEncodingVariable()
      Description copied from class: AbstractFilter
      Whether source encoding can be varied by the user.

      True means that OmegaT should handle all the encoding mess.

      Return false to state that your filter doesn't need encoding management provided by OmegaT, because it either autodetect the encoding based on file contents (like HTML filter does) or the encoding is fixed (like in OpenOffice files).

      Specified by:
      isSourceEncodingVariable in interface IFilter
      Specified by:
      isSourceEncodingVariable in class AbstractFilter
      Returns:
      whether source encoding can be changed by the user

    • isTargetEncodingVariable

      public boolean isTargetEncodingVariable()
      Description copied from class: AbstractFilter
      Whether target encoding can be varied by the user.

      True means that OmegaT should handle all the encoding mess.

      Return false to state that your filter doesn't need encoding management provided by OmegaT, because the encoding is fixed (like in OpenOffice files), or for some other reason.

      Specified by:
      isTargetEncodingVariable in interface IFilter
      Specified by:
      isTargetEncodingVariable in class AbstractFilter
      Returns:
      whether target encoding can be changed by the user

    • getInEncodingLastParsedFile

      public String getInEncodingLastParsedFile()
      Description copied from interface: IFilter
      Returns the encoding of the last parsed source file.
      Specified by:
      getInEncodingLastParsedFile in interface IFilter
      Overrides:
      getInEncodingLastParsedFile in class AbstractFilter
      Returns:
      the encoding of the last parsed source file, or null when no file has been parsed yet.

    • changeOptions

      public @Nullable Map<String,String> changeOptions(Window parent, Map<String,String> config)
      Description copied from interface: IFilter
      Show change options dialog for able to change options.
      Parameters:
      parent - parent window
      config - old options
      Returns:
      new options or null if options not changed

    • hasOptions

      public boolean hasOptions()
      Returns true to indicate that Moodle PHP 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.