IdBlock (XWiki Rendering - Api 14.1-rc-1 API)

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: 774ad6bcf5531d6530d570414d054ea86a2f48f8 $

See Also:

Listener.onId(String)

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

IdBlock(String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getName()`
`int`	`hashCode()`
`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, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, indexOf, 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<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.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractBlock
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractBlock