Package net.sf.okapi.filters.subtitles

Class SubtitleParameters

java.lang.Object

net.sf.okapi.common.BaseParameters

net.sf.okapi.common.StringParameters

net.sf.okapi.filters.subtitles.SubtitleParameters

All Implemented Interfaces:

Cloneable, IParameters, IEditorDescriptionProvider

Direct Known Subclasses:

TTMLParameters, VTTParameters

public class SubtitleParameters
extends StringParameters
implements IEditorDescriptionProvider

VTT Filter parameters

Version:

0.1, 07.06.23

Field Summary

Fields inherited from class net.sf.okapi.common.StringParameters

buffer

Fields inherited from class net.sf.okapi.common.BaseParameters

path

Constructor Summary

Constructors

Constructor	Description
SubtitleParameters()

Method Summary

Modifier and Type	Method	Description
protected EditorDescription	createEditorDescription(String caption, ParametersDescription paramDesc)
EditorDescription	createEditorDescription(ParametersDescription paramDesc)
int	getCjkCharsPerLine()
boolean	getKeepTimecodes()
int	getMaxCharsPerLine()
int	getMaxLinesPerCaption()
ParametersDescription	getParametersDescription()	Gets the description of the parameters.
boolean	getSplitWords()
String	getTimeFormat()
void	setCjkCharsPerLine(int cjkCharsPerLine)
void	setKeepTimecodes(boolean keepTimecodes)
void	setMaxCharsPerLine(int maxCharsPerLine)
void	setMaxLinesPerCaption(int maxLinesPerCaption)
void	setSplitWords(boolean splitWords)
void	setTimeFormat(String timeFormat)

Methods inherited from class net.sf.okapi.common.StringParameters

fromString, fromString, getBoolean, getGroup, getInteger, getString, reset, setBoolean, setGroup, setInteger, setString, toString

Methods inherited from class net.sf.okapi.common.BaseParameters

getPath, load, load, save, setPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.IParameters

copy

Constructor Detail

SubtitleParameters

public SubtitleParameters()

Method Detail

getTimeFormat

public String getTimeFormat()

setTimeFormat

public void setTimeFormat(String timeFormat)

getMaxLinesPerCaption

public int getMaxLinesPerCaption()

setMaxLinesPerCaption

public void setMaxLinesPerCaption(int maxLinesPerCaption)

getMaxCharsPerLine

public int getMaxCharsPerLine()

setMaxCharsPerLine

public void setMaxCharsPerLine(int maxCharsPerLine)

getCjkCharsPerLine

public int getCjkCharsPerLine()

setCjkCharsPerLine

public void setCjkCharsPerLine(int cjkCharsPerLine)

getKeepTimecodes

public boolean getKeepTimecodes()

setKeepTimecodes

public void setKeepTimecodes(boolean keepTimecodes)

getSplitWords

public boolean getSplitWords()

setSplitWords

public void setSplitWords(boolean splitWords)

getParametersDescription

public ParametersDescription getParametersDescription()

Description copied from interface: IParameters

Gets the description of the parameters.

Specified by:

getParametersDescription in interface IParameters

Overrides:

getParametersDescription in class BaseParameters

Returns:

the ParametersDescription object for this set of parameters, or null if none is provided.

createEditorDescription

public EditorDescription createEditorDescription(ParametersDescription paramDesc)

Specified by:

createEditorDescription in interface IEditorDescriptionProvider

createEditorDescription

protected EditorDescription createEditorDescription(String caption,
                                                    ParametersDescription paramDesc)