jasp.webcom
Class NextLink

java.lang.Object
  |
  +--jasp.webcom.NextLink

public class NextLink

extends java.lang.Object

The Content Linking component creates a Nextlink object that manages a list of URLs so that you can treat the pages in your Web site like the pages in a book. You can use the Content Linking component to automatically generate and update tables of contents and navigational links to previous and subsequent Web pages. This is ideal for applications such as online newspapers and forum message listings. The Content Linking component references a Content Linking List file that contains the list of the linked Web pages. This list is stored on the Web server.

Constructor Summary

NextLink()
Creates a Nextlink object that manages a list of URLs so that you can treat the pages in your Web site like the pages in a book

Method Summary

int	GetListCount(java.lang.String listURL) Counts the number of items linked in the Content Linking List file.
int	getListIndex(java.lang.String listURL) The GetListIndex method retrieves the index number of the current item in the Content Linking List file.
java.lang.String	getNextDescription(java.lang.String listURL) The GetNextDescription method retrieves the text description of the next item in the Content Linking List file.
java.lang.String	getNextURL(java.lang.String listURL) Gets the URL of the next page listed in the Content Linking List file.
java.lang.String	getNthDescription(java.lang.String listURL, int i) The GetNthDescription method retrieves a text description of the Nth item in the Content Linking List file.
java.lang.String	getNthURL(java.lang.String listURL, int i) The GetNthURL method returns the URL of the Nth item in the Content Linking List file.
java.lang.String	getPreviousDescription(java.lang.String listURL) The GetPreviousDescription method retrieves a text description of the previous item in the Content Linking List file.
java.lang.String	getPreviousURL(java.lang.String listURL) Gets the URL of the previous pages listed in the Content Linking List file.

Methods inherited from class java.lang.Object

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

Constructor Detail

NextLink

public NextLink()

Creates a Nextlink object that manages a list of URLs so that you can treat the pages in your Web site like the pages in a book

Method Detail

GetListCount

public int GetListCount(java.lang.String listURL)

Counts the number of items linked in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

Returns the counts the numer of items

getListIndex

public int getListIndex(java.lang.String listURL)

The GetListIndex method retrieves the index number of the current item in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

Returns an integer index value specifying the current page's position on the file list. The index number of the first item is 1. The method returns 0 if the current page is not in the Content Linking List file.

getNextDescription

public java.lang.String getNextDescription(java.lang.String listURL)

The GetNextDescription method retrieves the text description of the next item in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

Returns an ASCII string describing the next item in the Content Linking List file. If the current page is not found in the list file, GetNextDescription returns the string description of the last page on the list.

getNextURL

public java.lang.String getNextURL(java.lang.String listURL)

Gets the URL of the next page listed in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

Returns the URL of the next page specified in the Content Linking List file. If the current page is not specified in the Content Linking List file, GetNextURL returns the URL of the last page on the list.

getNthDescription

public java.lang.String getNthDescription(java.lang.String listURL,
                                          int i)

The GetNthDescription method retrieves a text description of the Nth item in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

i - The index number of an item in the Content Linking List file.

Returns:

Returns a string.

getNthURL

public java.lang.String getNthURL(java.lang.String listURL,
                                  int i)

The GetNthURL method returns the URL of the Nth item in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

i - The index number of an item in the Content Linking List file.

Returns:

Returns a string.

getPreviousDescription

public java.lang.String getPreviousDescription(java.lang.String listURL)

The GetPreviousDescription method retrieves a text description of the previous item in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

returns a string describing either the previous item in the Content Linking List file or, if the current page is not in the file, the first item on the list.

getPreviousURL

public java.lang.String getPreviousURL(java.lang.String listURL)

Gets the URL of the previous pages listed in the Content Linking List file.

Parameters:

listURL - The location of the Content Linking List file.

Returns:

returns a string containing the URL of the previous item in the Content Linking List file. If the current page is not specified in the Content Linking List file, GetPreviousURL returns the URL of the first page in the