org.xwiki.rendering.block

Class IdBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.IdBlock

All Implemented Interfaces:

Cloneable, Block

public class IdBlock
extends AbstractBlock

A reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to that location, for example in links.

Since:

1.6M1

Version:

$Id: da11e40fd5c00d2c4c51b5c3ab4905b51d71e1d2 $

See Also:

Listener.onId(String)

Nested Class Summary

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

Block.Axes

Constructor Summary

Constructors

Constructor and Description
IdBlock(String name)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
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, equals, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, hashCode, insertChildAfter, insertChildBefore, removeBlock, replaceChild, replaceChild, setChildren, setNextSiblingBlock, setParameter, setParameters, setParent, setPreviousSiblingBlock

Methods inherited from class java.lang.Object

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

Constructor Detail

IdBlock

public IdBlock(String name)

Parameters:

name - the unique name for the reference/location.

Method Detail

getName

public String getName()

Returns:

the reference/location name

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) and Listener.endParagraph(java.util.Map) 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.