org.htmlcleaner
Class TagInfo

java.lang.Object
  org.htmlcleaner.TagInfo

public class TagInfo
extends Object

Class contains information about single HTML tag.
It also contains rules for tag balancing. For each tag, list of dependent tags may be defined. There are several kinds of dependencies used to reorder tags:

• fatal tags - required outer tag - the tag will be ignored during parsing (will be skipped) if this fatal tag is missing. For example, most web browsers ignore elements TD, TR, TBODY if they are not in the context of TABLE tag.
• required enclosing tags - if there is no such, it is implicitly created. For example if TD is out of TR - open TR is created before.
• forbidden tags - it is not allowed to occur inside - for example FORM cannot be inside other FORM and it will be ignored during cleanup.
• allowed children tags - for example TR allows TD and TH. If there are some dependent allowed tags defined then cleaner ignores other tags, treating them as not allowed, unless they are in some other relationship with this tag.
• higher level tags - for example for TR higher tags are THEAD, TBODY, TFOOT.
• tags that must be closed and copied - for example, in <a href="#"><div>.... tag A must be closed before DIV but copied again inside DIV.
• tags that must be closed before closing this tag and copied again after - for example, in <i><b>at</i> first</b> text tag B must be closed before closing I, but it must be copied again after resulting finally in sequence: <i><b>at</b></i><b> first</b> text .

Tag TR for instance (table row) may define the following dependencies:

• fatal tag is table
• required enclosing tag is tbody
• allowed children tags are td,th
• higher level tags are thead,tfoot
• tags that muste be closed before are tr,td,th,caption,colgroup

meaning the following:

• tr must be in context of table, otherwise it will be ignored,
• tr may can be directly inside tbody, tfoot and thead, otherwise tbody will be implicitly created in front of it.
• tr can contain td and th, all other tags and content will be pushed out of current limiting context, in the case of html tables, in front of enclosing table tag.
• if previous open tag is one of tr, caption or colgroup, it will be implicitly closed.

Constructor Summary

TagInfo(String name, ContentType contentType, BelongsTo belongsTo, boolean deprecated, boolean unique, boolean ignorePermitted, CloseTag closeTag, Display display)

Method Summary

void	defineAllowedChildrenTags(String commaSeparatedListOfTags)
void	defineCloseBeforeCopyInsideTags(String commaSeparatedListOfTags)
void	defineCloseBeforeTags(String commaSeparatedListOfTags)
void	defineCloseInsideCopyAfterTags(String commaSeparatedListOfTags)
void	defineFatalTags(String commaSeparatedListOfTags)
void	defineForbiddenTags(String commaSeparatedListOfTags)
void	defineHigherLevelTags(String commaSeparatedListOfTags)
void	defineRequiredEnclosingTags(String commaSeparatedListOfTags)
BelongsTo	getBelongsTo()
Set<String>	getChildTags()
ContentType	getContentType()
Set<String>	getContinueAfterTags()
Set<String>	getCopyTags()
Display	getDisplay()
String	getFatalTag()
Set<String>	getHigherTags()
Set<String>	getMustCloseTags()
String	getName()
Set<String>	getPermittedTags()
String	getRequiredParent()
boolean	isDeprecated()
boolean	isEmptyTag()
boolean	isIgnorePermitted()
boolean	isMinimizedTagPermitted()
boolean	isUnique()
void	setBelongsTo(BelongsTo belongsTo)
void	setChildTags(Set<String> childTags)
void	setContinueAfterTags(Set<String> continueAfterTags)
void	setCopyTags(Set<String> copyTags)
void	setDeprecated(boolean deprecated)
void	setDisplay(Display display)
void	setFatalTag(String fatalTag)
void	setHigherTags(Set<String> higherTags)
void	setIgnorePermitted(boolean ignorePermitted)
void	setMustCloseTags(Set<String> mustCloseTags)
void	setName(String name)
void	setPermittedTags(Set<String> permittedTags)
void	setRequiredParent(String requiredParent)
void	setUnique(boolean unique)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagInfo

public TagInfo(String name,
               ContentType contentType,
               BelongsTo belongsTo,
               boolean deprecated,
               boolean unique,
               boolean ignorePermitted,
               CloseTag closeTag,
               Display display)

Method Detail

defineFatalTags

public void defineFatalTags(String commaSeparatedListOfTags)

defineRequiredEnclosingTags

public void defineRequiredEnclosingTags(String commaSeparatedListOfTags)

defineForbiddenTags

public void defineForbiddenTags(String commaSeparatedListOfTags)

defineAllowedChildrenTags

public void defineAllowedChildrenTags(String commaSeparatedListOfTags)

defineHigherLevelTags

public void defineHigherLevelTags(String commaSeparatedListOfTags)

defineCloseBeforeCopyInsideTags

public void defineCloseBeforeCopyInsideTags(String commaSeparatedListOfTags)

defineCloseInsideCopyAfterTags

public void defineCloseInsideCopyAfterTags(String commaSeparatedListOfTags)

defineCloseBeforeTags

public void defineCloseBeforeTags(String commaSeparatedListOfTags)

getDisplay

public Display getDisplay()

setDisplay

public void setDisplay(Display display)

getName

public String getName()

setName

public void setName(String name)

getContentType

public ContentType getContentType()

getMustCloseTags

public Set<String> getMustCloseTags()

setMustCloseTags

public void setMustCloseTags(Set<String> mustCloseTags)

getHigherTags

public Set<String> getHigherTags()

setHigherTags

public void setHigherTags(Set<String> higherTags)

getChildTags

public Set<String> getChildTags()

setChildTags

public void setChildTags(Set<String> childTags)

getPermittedTags

public Set<String> getPermittedTags()

setPermittedTags

public void setPermittedTags(Set<String> permittedTags)

getCopyTags

public Set<String> getCopyTags()

setCopyTags

public void setCopyTags(Set<String> copyTags)

getContinueAfterTags

public Set<String> getContinueAfterTags()

setContinueAfterTags

public void setContinueAfterTags(Set<String> continueAfterTags)

getRequiredParent

public String getRequiredParent()

setRequiredParent

public void setRequiredParent(String requiredParent)

getBelongsTo

public BelongsTo getBelongsTo()

setBelongsTo

public void setBelongsTo(BelongsTo belongsTo)

getFatalTag

public String getFatalTag()

setFatalTag

public void setFatalTag(String fatalTag)

isDeprecated

public boolean isDeprecated()

setDeprecated

public void setDeprecated(boolean deprecated)

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean unique)

isIgnorePermitted

public boolean isIgnorePermitted()

isEmptyTag

public boolean isEmptyTag()

setIgnorePermitted

public void setIgnorePermitted(boolean ignorePermitted)

isMinimizedTagPermitted

public boolean isMinimizedTagPermitted()

Returns: