nl.justobjects.xbook
Class XMenuDocument

java.lang.Object
  |
  +--nl.justobjects.xbook.XMenuDocument

public class XMenuDocument

extends java.lang.Object

Encapsulates XML XMenu Document for dynamic menu-population.

Purpose
Allows generation of dynamic menus from a Java program or servlet/JSP.

Implementation
TBS.

Examples
Give some code examples. Be sure to use the <pre> HTML tag.

Since:

$Date: 2003/01/06 10:27:22 $

Version:

$Id: XMenuDocument.java,v 1.3 2003/01/06 10:27:22 just Exp $

Author:

$Author: just $ - Just van den Broecke - Just Objects ©

See Also:

Field Summary

private org.w3c.dom.Document	document The XML menu document
private org.w3c.dom.Element	rootElement Root: the <xmenu > element
private static java.lang.String	skeletonXMLFile Empty xmenu file for initialization

Constructor Summary

XMenuDocument()
Constructs empty document.

XMenuDocument(org.w3c.dom.Document theDocument)
Constructs from XML xmenu Document.

XMenuDocument(java.lang.String fileName)
Constructs from XML xmenu file.

Method Summary

void	addDocument(org.w3c.dom.Element parentFolderElement, java.lang.String label, java.lang.String description, java.lang.String url) Add document (<doc/> element to parent folder.
void	addDocument(org.w3c.dom.Element parentFolderElement, java.lang.String label, java.lang.String description, java.lang.String url, java.lang.String target) Add document (<doc/> element to parent folder with target frame.
void	addDocument(java.lang.String label, java.lang.String description, java.lang.String url) Add document (<doc/> element to root menu.
void	addDocument(java.lang.String label, java.lang.String description, java.lang.String url, java.lang.String target) Add document (<doc/> element to root menu with target frame.
org.w3c.dom.Element	addFolder(org.w3c.dom.Element parentFolderElement, java.lang.String label, java.lang.String description) Add subfolder element to specified folder node.
org.w3c.dom.Element	addFolder(java.lang.String label, java.lang.String description) Add folder element to root node.
private static void	error(java.lang.String what, java.lang.Exception e) Error print/exit util.
void	generateSite(java.lang.String outputDir) Generate navigation site from current document.
void	generateSite(java.lang.String outputDir, boolean liteOption) Generate navigation site from current document using lite HTML option.
org.w3c.dom.Document	getDocument() Get the xmenu Document.
static void	main(java.lang.String[] args) For testing.
private static void	p(java.lang.String s) Print util.
void	save(java.lang.String outputFilePath) Save Document as XML into file.
void	setAttribute(java.lang.String name, java.lang.String value) Set attribute of <xmenu > root element.

Methods inherited from class java.lang.Object

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

Field Detail

document

private org.w3c.dom.Document document

The XML menu document

rootElement

private org.w3c.dom.Element rootElement

Root: the <xmenu > element

skeletonXMLFile

private static final java.lang.String skeletonXMLFile

Empty xmenu file for initialization

Constructor Detail

XMenuDocument

public XMenuDocument()
              throws java.lang.Exception

Constructs empty document.

XMenuDocument

public XMenuDocument(java.lang.String fileName)
              throws java.lang.Exception

Constructs from XML xmenu file.

XMenuDocument

public XMenuDocument(org.w3c.dom.Document theDocument)
              throws java.lang.Exception

Constructs from XML xmenu Document.

Method Detail

getDocument

public org.w3c.dom.Document getDocument()

Get the xmenu Document.

addDocument

public void addDocument(java.lang.String label,
                        java.lang.String description,
                        java.lang.String url)
                 throws java.lang.Exception

Add document (<doc/> element to root menu.

addDocument

public void addDocument(java.lang.String label,
                        java.lang.String description,
                        java.lang.String url,
                        java.lang.String target)
                 throws java.lang.Exception

Add document (<doc/> element to root menu with target frame.

addDocument

public void addDocument(org.w3c.dom.Element parentFolderElement,
                        java.lang.String label,
                        java.lang.String description,
                        java.lang.String url)
                 throws java.lang.Exception

Add document (<doc/> element to parent folder.

addDocument

public void addDocument(org.w3c.dom.Element parentFolderElement,
                        java.lang.String label,
                        java.lang.String description,
                        java.lang.String url,
                        java.lang.String target)
                 throws java.lang.Exception

Add document (<doc/> element to parent folder with target frame.

addFolder

public org.w3c.dom.Element addFolder(java.lang.String label,
                                     java.lang.String description)
                              throws java.lang.Exception

Add folder element to root node.

addFolder

public org.w3c.dom.Element addFolder(org.w3c.dom.Element parentFolderElement,
                                     java.lang.String label,
                                     java.lang.String description)
                              throws java.lang.Exception

Add subfolder element to specified folder node.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

Set attribute of <xmenu > root element.

generateSite

public void generateSite(java.lang.String outputDir)
                  throws java.lang.Exception

Generate navigation site from current document.

generateSite

public void generateSite(java.lang.String outputDir,
                         boolean liteOption)
                  throws java.lang.Exception

Generate navigation site from current document using lite HTML option.

save

public void save(java.lang.String outputFilePath)
          throws java.lang.Exception

Save Document as XML into file.

p

private static void p(java.lang.String s)

Print util.

error

private static void error(java.lang.String what,
                          java.lang.Exception e)

Error print/exit util.

main

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

For testing.