com.tridion.tcdl

Class OutputDocument.Bookmark

java.lang.Object

com.tridion.tcdl.OutputDocument.Bookmark

Enclosing class:

OutputDocument

public static class OutputDocument.Bookmark
extends Object

Container for bookmark information. Each bookmark has a name (usually mapped to the name of a dependency list) and a position. The position will be relative as long as the TCDL source content is being processed. In addition, the bookmark contains an order number indicating which bookmark came first. Since a bookmark does not take up space, bookmarks having the same position in the final document are common.

Constructor Summary

Constructors

Constructor and Description
Bookmark(String name, int position, int order, boolean requiresCodeBlock)

Method Summary

Modifier and Type	Method and Description
String	getName()
int	getOrder()
int	getPosition()
protected void	increasePosition(int amount)
boolean	requiresCodeBlock()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bookmark

public Bookmark(String name,
                int position,
                int order,
                boolean requiresCodeBlock)

Method Detail

getName

public String getName()

getPosition

public int getPosition()

getOrder

public int getOrder()

requiresCodeBlock

public boolean requiresCodeBlock()

increasePosition

protected void increasePosition(int amount)