Package org.xwiki.rendering.block

Class WordBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.WordBlock

All Implemented Interfaces:

Cloneable, Block

public class WordBlock
extends AbstractBlock

Represents a word.

Since:

1.5M2

Version:

$Id: ad2e8151f62ddd4d66b60b30b307186569f1fe21 $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.rendering.block.Block

Block.Axes

Field Summary

Fields inherited from interface org.xwiki.rendering.block.Block

LIST_BLOCK_TYPE

Constructor Summary

Constructors

Constructor	Description
WordBlock(String word)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getWord()
int	hashCode()
String	toString()
void	traverse(Listener listener)	Let the block send Listener events corresponding to its content.

Methods inherited from class org.xwiki.rendering.block.AbstractBlock

addChild, addChildren, after, before, clone, clone, get, getAttribute, getAttributes, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, getSyntaxMetadata, indexOf, insertChildAfter, insertChildBefore, removeBlock, replaceChild, replaceChild, setAttribute, setAttributes, setChildren, setNextSiblingBlock, setParameter, setParameters, setParent, setPreviousSiblingBlock

Methods inherited from class java.lang.Object

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

Constructor Details

WordBlock

public WordBlock(String word)

Parameters:

word - the word wrapped by this block. Note that this is supposed to be a single word and space or special symbols should be represented by other blocks

Method Details

traverse

public void traverse(Listener listener)

Description copied from interface: Block

Let the block send Listener events corresponding to its content. For example a Paragraph block will send the Listener.beginParagraph(java.util.Map<java.lang.String, java.lang.String>) and Listener.endParagraph(java.util.Map<java.lang.String, java.lang.String>) events when this method is called.

Specified by:

traverse in interface Block

Overrides:

traverse in class AbstractBlock

Parameters:

listener - the listener to which to send the events to.

getWord

public String getWord()

Returns:

the word wrapped by this block

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractBlock

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBlock