info.bliki.htmlcleaner

Class TagNode

java.lang.Object

info.bliki.htmlcleaner.TagToken

info.bliki.htmlcleaner.TagNode

All Implemented Interfaces:

BaseToken, PlainTextConvertable, Cloneable

Direct Known Subclasses:

HTMLTag

public class TagNode
extends TagToken
implements PlainTextConvertable

XML node node tag - it is produced during cleaning process when all start and end tokens are removed and replaced by instances of TagNode.

Created by: Vladimir Nikic
Date: November, 2006.
Modified by: Axel Kramer

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALLOWED_ATTRIBUTES Allowed attributes Note: the 'style' attribute isn't allowed by default because of XSS risks; if you need this attribute (or other attributes not listed here) you can add it with the static addAllowedAttribute() method.
protected static HashSet<String>	ALLOWED_ATTRIBUTES_SET

Fields inherited from class info.bliki.htmlcleaner.TagToken

name, originalSource

Constructor Summary

Constructors

Constructor and Description
TagNode()
TagNode(String name)

Method Summary

Modifier and Type	Method and Description
static boolean	addAllowedAttribute(String key) Add an additional allowed attribute name Note: the 'style' attribute isn't allowed by default because of XSS risks; if you need this attribute (or other attributes not listed here) you can add it with this method.
boolean	addAttribute(String attName, String attValue, boolean checkXSS) Add an attribute to this tag.
void	addChild(Object child)
void	addChildren(List<?> children)
void	addItemForMoving(BaseToken item)
void	addObjectAttribute(String attName, Object attValue) Add a special object to this TagNode which contains original information from the parsed wiki object (for example the ImageFormat or original wiki topic string)
Object	clone()
static Set<String>	getAllowedAttributes()
Map<String,String>	getAttributes()
String	getBodyString() Get the pure content text without the tags from this HTMLTag
List<Object>	getChildren()
List<BaseToken>	getItemsToMove()
Map<String,Object>	getObjectAttributes() Get a special object for this TagNode which contains original information from the parsed wiki object (for example the ImageFormat or original wiki topic string).
TagNode	getParent()
String	getParents() Get the allowed parent tags for this tag
boolean	isAllowedAttribute(String attName) Check, if the attName is allowed.
boolean	isFormed()
TagNode	makeCopy()
void	renderPlainText(ITextConverter converter, Appendable buf, IWikiModel wikiModel)
void	serialize(XmlSerializer xmlSerializer)
void	setFormed()
void	setItemsToMove(List<BaseToken> itemsToMove)
void	setParent(TagNode parent)

Methods inherited from class info.bliki.htmlcleaner.TagToken

equals, getName, getOriginalSource, hashCode, isReduceTokenStack, setName, setOriginalSource, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALLOWED_ATTRIBUTES

public static final String[] ALLOWED_ATTRIBUTES

Allowed attributes Note: the 'style' attribute isn't allowed by default because of XSS risks; if you need this attribute (or other attributes not listed here) you can add it with the static addAllowedAttribute() method.

ALLOWED_ATTRIBUTES_SET

protected static final HashSet<String> ALLOWED_ATTRIBUTES_SET

Constructor Detail

TagNode

public TagNode()

TagNode

public TagNode(String name)

Method Detail

getAllowedAttributes

public static Set<String> getAllowedAttributes()

addAllowedAttribute

public static boolean addAllowedAttribute(String key)

Add an additional allowed attribute name Note: the 'style' attribute isn't allowed by default because of XSS risks; if you need this attribute (or other attributes not listed here) you can add it with this method.

getAttributes

public Map<String,String> getAttributes()

getObjectAttributes

public Map<String,Object> getObjectAttributes()

Get a special object for this TagNode which contains original information from the parsed wiki object (for example the ImageFormat or original wiki topic string).

Parameters:

attName - the attribute name

attValue - the attribute value

See Also:

addObjectAttribute(String, Object), ImageFormat

getChildren

public List<Object> getChildren()

getParent

public TagNode getParent()

setParent

public void setParent(TagNode parent)

addAttribute

public boolean addAttribute(String attName,
                            String attValue,
                            boolean checkXSS)

Description copied from class: TagToken

Add an attribute to this tag.

Specified by:

addAttribute in class TagToken

Parameters:

attName - the attribute name

attValue - the attribute's value string

checkXSS - check the attributes for allowed names to avoid cross side scripting

Returns:

isAllowedAttribute

public boolean isAllowedAttribute(String attName)

Description copied from class: TagToken

Check, if the attName is allowed.

Specified by:

isAllowedAttribute in class TagToken

Returns:

addObjectAttribute

public void addObjectAttribute(String attName,
                               Object attValue)

Add a special object to this TagNode which contains original information from the parsed wiki object (for example the ImageFormat or original wiki topic string)

Parameters:

attName - the attribute name

attValue - the attribute value

See Also:

getObjectAttributes(), ImageFormat

addChild

public void addChild(Object child)

addChildren

public void addChildren(List<?> children)

addItemForMoving

public void addItemForMoving(BaseToken item)

getItemsToMove

public List<BaseToken> getItemsToMove()

setItemsToMove

public void setItemsToMove(List<BaseToken> itemsToMove)

isFormed

public boolean isFormed()

setFormed

public void setFormed()

serialize

public void serialize(XmlSerializer xmlSerializer)
               throws IOException

Specified by:

serialize in interface BaseToken

Throws:

IOException

makeCopy

public TagNode makeCopy()

clone

public Object clone()

Overrides:

clone in class TagToken

getParents

public String getParents()

Description copied from class: TagToken

Get the allowed parent tags for this tag

Specified by:

getParents in class TagToken

Returns:

null if no parent tags are allowed

renderPlainText

public void renderPlainText(ITextConverter converter,
                            Appendable buf,
                            IWikiModel wikiModel)
                     throws IOException

Specified by:

renderPlainText in interface PlainTextConvertable

Throws:

IOException

getBodyString

public String getBodyString()

Get the pure content text without the tags from this HTMLTag