org.omegat.filters2.html2

Class FilterVisitor

java.lang.Object

org.htmlparser.visitors.NodeVisitor

org.omegat.filters2.html2.FilterVisitor

public class FilterVisitor
extends org.htmlparser.visitors.NodeVisitor

The part of HTML filter that actually does the job. This class is called back by HTMLParser (http://sf.net/projects/htmlparser/).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.htmlparser.Node>	afters The list of non-paragraph tags following a chunk of text.
protected java.util.List<org.htmlparser.Node>	befors The list of non-paragraph tags before a chunk of text.
protected HTMLFilter2	filter
protected boolean	preformatting Did the PRE block start (it means we mustn't compress the spaces).
protected boolean	recurse Should the parser call us for this tag's ending tag and its inner tags.
protected java.util.List<java.lang.String>	sShortcuts The list of all the tag shortcuts
protected java.util.List<java.lang.Integer>	sTagNumbers The tag numbers of shorcutized tags
protected java.util.List<org.htmlparser.Tag>	sTags The tags behind the shortcuts
protected boolean	text Do we collect the translatable text now.
protected java.util.List<org.htmlparser.Node>	translatable The list of nodes forming a chunk of text.

Constructor Summary

Constructors

Constructor and Description
FilterVisitor(HTMLFilter2 htmlfilter, java.io.BufferedWriter bufwriter, HTMLOptions opts)

Method Summary

Modifier and Type	Method and Description
void	beginParsing() This method is called before the parsing.
protected void	endup() Ends the segment collection and sends the translatable text out to OmegaT core, and some extra tags to writer.
void	finishedParsing() Called upon parsing completion.
protected void	maybeTranslateAttribute(org.htmlparser.Tag tag, java.lang.String key) If the attribute of the tag is not empty, it translates it as a separate segment.
protected void	queuePrefix(org.htmlparser.Tag tag) Queues up something, possibly before a text.
boolean	shouldRecurseChildren() Depth traversal predicate.
boolean	shouldRecurseSelf() Self traversal predicate.
void	visitEndTag(org.htmlparser.Tag tag) Called for each end Tag visited.
void	visitRemarkNode(org.htmlparser.Remark remark) Called for each comment (RemarkNode) visited.
void	visitStringNode(org.htmlparser.Text string) Called for each chunk of text (StringNode) visited.
void	visitTag(org.htmlparser.Tag tag) Called for each Tag visited.

Methods inherited from class java.lang.Object

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

Field Detail

filter

protected HTMLFilter2 filter

recurse

protected boolean recurse

Should the parser call us for this tag's ending tag and its inner tags.

text

protected boolean text

Do we collect the translatable text now.

preformatting

protected boolean preformatting

Did the PRE block start (it means we mustn't compress the spaces).

befors

protected java.util.List<org.htmlparser.Node> befors

The list of non-paragraph tags before a chunk of text.

• If a chunk of text follows, they get prepended to the translatable paragraph, (starting from the first tag having a pair inside a chunk of text)
• Otherwise they are written out directly.

translatable

protected java.util.List<org.htmlparser.Node> translatable

The list of nodes forming a chunk of text.

afters

protected java.util.List<org.htmlparser.Node> afters

The list of non-paragraph tags following a chunk of text.

• If another chunk of text follows, they get appended to the translatable paragraph,
• Otherwise (paragraph tag follows), they are written out directly.

sTags

protected java.util.List<org.htmlparser.Tag> sTags

The tags behind the shortcuts

sTagNumbers

protected java.util.List<java.lang.Integer> sTagNumbers

The tag numbers of shorcutized tags

sShortcuts

protected java.util.List<java.lang.String> sShortcuts

The list of all the tag shortcuts

Constructor Detail

FilterVisitor

public FilterVisitor(HTMLFilter2 htmlfilter,
                     java.io.BufferedWriter bufwriter,
                     HTMLOptions opts)

Method Detail

shouldRecurseSelf

public boolean shouldRecurseSelf()

Self traversal predicate.

Overrides:

shouldRecurseSelf in class org.htmlparser.visitors.NodeVisitor

Returns:

true if a node itself is to be visited.

shouldRecurseChildren

public boolean shouldRecurseChildren()

Depth traversal predicate.

Overrides:

shouldRecurseChildren in class org.htmlparser.visitors.NodeVisitor

Returns:

true if children are to be visited.

visitTag

public void visitTag(org.htmlparser.Tag tag)

Called for each Tag visited.

Overrides:

visitTag in class org.htmlparser.visitors.NodeVisitor

Parameters:

tag - The tag being visited.

maybeTranslateAttribute

protected void maybeTranslateAttribute(org.htmlparser.Tag tag,
                                       java.lang.String key)

If the attribute of the tag is not empty, it translates it as a separate segment.

Parameters:

tag - the tag object

key - the name of the attribute

visitStringNode

public void visitStringNode(org.htmlparser.Text string)

Called for each chunk of text (StringNode) visited.

Overrides:

visitStringNode in class org.htmlparser.visitors.NodeVisitor

Parameters:

string - The string node being visited.

visitRemarkNode

public void visitRemarkNode(org.htmlparser.Remark remark)

Called for each comment (RemarkNode) visited.

Overrides:

visitRemarkNode in class org.htmlparser.visitors.NodeVisitor

Parameters:

remark - The remark node being visited.

visitEndTag

public void visitEndTag(org.htmlparser.Tag tag)

Called for each end Tag visited.

Overrides:

visitEndTag in class org.htmlparser.visitors.NodeVisitor

Parameters:

tag - The end tag being visited.

beginParsing

public void beginParsing()

This method is called before the parsing.

Overrides:

beginParsing in class org.htmlparser.visitors.NodeVisitor

finishedParsing

public void finishedParsing()

Called upon parsing completion.

Overrides:

finishedParsing in class org.htmlparser.visitors.NodeVisitor

endup

protected void endup()

Ends the segment collection and sends the translatable text out to OmegaT core, and some extra tags to writer.

queuePrefix

protected void queuePrefix(org.htmlparser.Tag tag)

Queues up something, possibly before a text. If the text is collected now, the tag is queued up as translatable by calling queueTranslatable(Tag), otherwise it's collected to a special list that is inspected when the translatable text is sent to OmegaT core.