biz.hammurapi.web.menu
Class Help

java.lang.Object
  biz.hammurapi.web.menu.Help

public class Help

extends java.lang.Object

Helper class to form help topic tree.

Author:

Pavel Vlasov

Field Summary

static int	DEFAULT_MAX_TOOLTIP_LENGTH
static java.lang.String	DEFAULT_TAIL

Constructor Summary

Help(Menu owner)

Method Summary

void	add(java.lang.String name, biz.hammurapi.web.menu.sql.MenuHelpTopics mht)
java.lang.String	getContent(int level, biz.hammurapi.config.Context context, boolean withHeader, boolean withChildren, boolean isTooltip)
java.lang.String	getId()
java.lang.String	getName()
java.util.Collection	getPath(biz.hammurapi.config.Context context)
java.lang.String	getTitle()
java.lang.String	getTooltip(biz.hammurapi.config.Context context)
boolean	isSection()
static void	main(java.lang.String[] args) For testing.
void	search(java.util.Collection terms, biz.hammurapi.config.Context context, java.util.Collection findings)
void	toDom(biz.hammurapi.config.Context context, org.w3c.dom.Element holder) Recursively outputs children.
void	writeSinglePageContent(biz.hammurapi.config.Context context, java.io.Writer writer) Writes content of self, subtopics and menu children to writer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_TOOLTIP_LENGTH

public static final int DEFAULT_MAX_TOOLTIP_LENGTH

See Also:

Constant Field Values

DEFAULT_TAIL

public static final java.lang.String DEFAULT_TAIL

See Also:

Constant Field Values

Constructor Detail

Help

public Help(Menu owner)

Method Detail

getId

public java.lang.String getId()

getName

public java.lang.String getName()

getTitle

public java.lang.String getTitle()

isSection

public boolean isSection()

add

public void add(java.lang.String name,
                biz.hammurapi.web.menu.sql.MenuHelpTopics mht)

Parameters:

name - - Name "tail"

mht -

getContent

public java.lang.String getContent(int level,
                                   biz.hammurapi.config.Context context,
                                   boolean withHeader,
                                   boolean withChildren,
                                   boolean isTooltip)
                            throws java.sql.SQLException

Parameters:

level - Nesting level. Shall be 1 for the page root and increase by one for eash subsection nesting.

Returns:

Throws:

java.sql.SQLException

writeSinglePageContent

public void writeSinglePageContent(biz.hammurapi.config.Context context,
                                   java.io.Writer writer)
                            throws java.io.IOException,
                                   java.sql.SQLException

Writes content of self, subtopics and menu children to writer.

Parameters:

context -

writer -

Throws:

java.io.IOException

java.sql.SQLException

getTooltip

public java.lang.String getTooltip(biz.hammurapi.config.Context context)
                            throws java.sql.SQLException

Throws:

java.sql.SQLException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

For testing.

Parameters:

args -

Throws:

java.lang.Exception

toDom

public void toDom(biz.hammurapi.config.Context context,
                  org.w3c.dom.Element holder)

Recursively outputs children.

getPath

public java.util.Collection getPath(biz.hammurapi.config.Context context)

search

public void search(java.util.Collection terms,
                   biz.hammurapi.config.Context context,
                   java.util.Collection findings)