edu.indiana.dlib.metsnav.data
Class PageItem

java.lang.Object
  edu.indiana.dlib.metsnav.data.PageItem

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DefaultPageItemImpl

public abstract class PageItem
extends Object
implements Serializable

An abstract class that represents the item display in a page

Author:

David Jiao

See Also:

Serialized Form

Constructor Summary

PageItem()
Creates a new instance of Page

Method Summary

void	addParent(Division division) Adds an instance of Division to the parent list, if it's not in the list yet.
String	getDescription()
abstract String	getDisplay(ParameterMap properties) Returns the display HTML code based on property values
Division	getFirstParent() The first parent in the partent list.
String	getId() Returns the unique id of this page
Division	getLastParent() The last parent in the parent list.
ArrayList	getParents() Returns the parents list.
void	setDescription(String description)
void	setId(String string) Sets the unique id for the page
void	setParents(ArrayList list) Sets the parents list

Methods inherited from class java.lang.Object

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

Constructor Detail

PageItem

public PageItem()

Creates a new instance of Page

Method Detail

addParent

public void addParent(Division division)

Adds an instance of Division to the parent list, if it's not in the list yet. A page can belong to different divisions. For example, on a book page, there could be several chapters or small divisions.

Parameters:

division -

getDisplay

public abstract String getDisplay(ParameterMap properties)

Returns the display HTML code based on property values

Parameters:

properties -

Returns:

getFirstParent

public Division getFirstParent()

The first parent in the partent list. The list is sorted based on the order of divisions' start page number.

Returns:

getLastParent

public Division getLastParent()

The last parent in the parent list. The list is sorted based on the order of divisions' start page number.

Returns:

getParents

public ArrayList getParents()

Returns the parents list.

Returns:

a list of parents

setParents

public void setParents(ArrayList list)

Sets the parents list

Parameters:

list - a list of parents

getId

public String getId()

Returns the unique id of this page

Returns:

setId

public void setId(String string)

Sets the unique id for the page

Parameters:

string -

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.