com.novell.emframe.dev
Class Chapter

java.lang.Object
  com.novell.emframe.dev.Chapter

public class Chapter

extends java.lang.Object

PropertyBook contain Chapters, and Chapters can contain multiple PropertyBookPage objects. In the UI, a Chapter is displayed as a tab. PropertyBookPages contained within the Chapter are shown with links below the Chapter tab.

In Java implementation, Property Books don't contain lists of Chapters. Instead, PropertyBook contains lists of PropertyBookPages, and the PropertyBookPage contain the Chapter they are contained by. A PropertyBook then constructs the Chapter Java objects to contain the pages for display in the UI.

Field Summary

protected static java.util.Hashtable	m_chapters Static Hashtable of all Chapters.
protected java.lang.String	m_displayName Actual display name.
protected java.lang.String	m_displayNameResourceKey Key to lookup display name in the resource bundle.
protected java.lang.String	m_id ID of this Chapter.
protected java.lang.String	m_resourceBundle Resource bundle to read strings from.

Method Summary

static Chapter	createChapter(java.lang.String id, java.lang.String resourceBundleFile, java.lang.String displayNameResourceKey) Static call to create a Chapter.
boolean	equals(java.lang.Object obj) Comparator for Chapter objects.
java.lang.String	getDisplayNameKey() Returns the display name key for this Chapter.
java.lang.String	getId() Returns the unique identifier for this Chapter.
static java.lang.String	getName(java.lang.String strChapterId, TaskContext context) Static call that returns the actual display name for a given Chapter.
java.lang.String	getName(TaskContext context) Returns the localized display name of this Chapter.
java.lang.String	getResourcePropertiesFile() Returns the resource properties file for this Chapter.

Methods inherited from class java.lang.Object

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

Field Detail

m_chapters

protected static java.util.Hashtable m_chapters

Static Hashtable of all Chapters.

m_displayName

protected java.lang.String m_displayName

Actual display name.

m_displayNameResourceKey

protected java.lang.String m_displayNameResourceKey

Key to lookup display name in the resource bundle.

m_id

protected java.lang.String m_id

ID of this Chapter.

m_resourceBundle

protected java.lang.String m_resourceBundle

Resource bundle to read strings from.

Method Detail

createChapter

public static Chapter createChapter(java.lang.String id,
                                    java.lang.String resourceBundleFile,
                                    java.lang.String displayNameResourceKey)

Static call to create a Chapter.

Parameters:

id - String containing a unique ID for the new Chapter

resourceBundleFile - String containing the resource file

displayNameResourceKey - String containing the display name key

Returns:

Chapter object

equals

public boolean equals(java.lang.Object obj)

Comparator for Chapter objects. Chapters are equal if and only if the unique ids are equal.

Parameters:

obj - Chapter object to compare to

Returns:

true if ids are equal, false if otherwise

getDisplayNameKey

public java.lang.String getDisplayNameKey()

Returns the display name key for this Chapter.

Returns:

String containing the display name key

getId

public java.lang.String getId()

Returns the unique identifier for this Chapter.

Returns:

String containing the unique ID of this Chapter

getName

public static java.lang.String getName(java.lang.String strChapterId,
                                       TaskContext context)

Static call that returns the actual display name for a given Chapter.

Parameters:

strChapterId - ID of the Chapter to get the actual display name

context - TaskContext from the Task plug-in

Returns:

String containing the actual chapter name

getName

public java.lang.String getName(TaskContext context)

Returns the localized display name of this Chapter. Default implementation gets the display name from the xml description of the page.

Parameters:

context - TaskContext from the Task plug-in

Returns:

String containing the page's localized display name

getResourcePropertiesFile

public java.lang.String getResourcePropertiesFile()

Returns the resource properties file for this Chapter.

Returns:

String containing the resource properties file