com.plumtree.xpshared.htmlconstructs
Class PTBreadcrumbPath

java.lang.Object
  com.plumtree.xpshared.htmlconstructs.PTBreadcrumbPath

public class PTBreadcrumbPath
extends java.lang.Object

An object of this class can be used to contruct the familiar breadcrumb path.

The breadcrumb path construct contains an ordered list of text and/or links, separated by a separator character.

Author:

beng

Field Summary

java.lang.String

sSeparator The separator should use breaking spaces so that the breadcrumb can wrap between folders.

Constructor Summary

PTBreadcrumbPath()
Creates a new PTBreadcrumbPath object.

Method Summary

void	appendAnchorItem(HTMLAnchor a) Call this method to append an HTMLAnchor to the end of this path.
void	appendTextItem(java.lang.String s) Call this method to append a regular string to the end of this path.
HTMLElement	GetPathAsHTMLElement() Call this method to obtain an HTMLElement that describes the state of this breadcrumb path.

Methods inherited from class java.lang.Object

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

Field Detail

sSeparator

public java.lang.String sSeparator

The separator should use breaking spaces so that the breadcrumb can wrap between folders.

Constructor Detail

PTBreadcrumbPath

public PTBreadcrumbPath()

Creates a new PTBreadcrumbPath object.

Method Detail

GetPathAsHTMLElement

public HTMLElement GetPathAsHTMLElement()

Call this method to obtain an HTMLElement that describes the state of this breadcrumb path.

Returns:

Throws:

java.lang.Exception

appendAnchorItem

public void appendAnchorItem(HTMLAnchor a)

Call this method to append an HTMLAnchor to the end of this path.

Parameters:

a -

appendTextItem

public void appendTextItem(java.lang.String s)

Call this method to append a regular string to the end of this path. This string should be plain text, and contain no html.

Parameters:

s -