org.jwarp.flow.form.model
Class Navigation

java.lang.Object
  |
  +--org.jwarp.flow.form.model.Component
        |
        +--org.jwarp.flow.form.model.Container
              |
              +--org.jwarp.flow.form.model.Navigation

All Implemented Interfaces:

IComponent, IContainer, INavigation

public class Navigation

extends Container

implements INavigation

This is an interface that defines what a Navigation model. A navigation model contains the following items:
1. It can contain other components event other navigations
2. It contains its core navigation groups
3. The core navigation groups contain then links or references to other pages

Link name Link name Link name Link name Link name Link name

Version:

1.0

Author:

Anatole Tresch

Field Summary

(package private) java.util.LinkedList

links The navigation's groups

Fields inherited from class org.jwarp.flow.form.model.Container

components, containerListeners

Fields inherited from class org.jwarp.flow.form.model.Component

componentListeners, description, enabled, id, locale, name, parent

Constructor Summary

Navigation()

Navigation(int id, java.lang.String name, IContainer owner)

Navigation(java.lang.String name, IContainer owner)

Method Summary

void	addLink(ILink link)
void	addLink(ILink link, int pos)
void	addLink(int pos)
ILink	getLink(int pos)
java.util.Iterator	getLinks()
org.jdom.Element	getXMLTree() Get the actual XML result.
void	removeLink(ILink link)

Methods inherited from class org.jwarp.flow.form.model.Container

add, add, addContainerListener, contains, getComponent, getComponentCount, getComponents, handleEvent, remove, remove, removeAll, removeContainerListener

Methods inherited from class org.jwarp.flow.form.model.Component

addComponentListener, getDescription, getFullName, getID, getListeners, getLocale, getName, getParent, isEnabled, removeComponentListener, setDescription, setEnabled, setFlowData, setLocale, setName, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jwarp.flow.form.model.IContainer

add, add, addContainerListener, contains, getComponent, getComponentCount, getComponents, remove, remove, removeAll, removeContainerListener

Methods inherited from interface org.jwarp.flow.form.model.IComponent

addComponentListener, getDescription, getFullName, getID, getListeners, getLocale, getName, getParent, handleEvent, isEnabled, removeComponentListener, setEnabled, setFlowData, setLocale

Field Detail

links

java.util.LinkedList links

The navigation's groups

Constructor Detail

Navigation

public Navigation()

Navigation

public Navigation(java.lang.String name,
                  IContainer owner)

Navigation

public Navigation(int id,
                  java.lang.String name,
                  IContainer owner)

Method Detail

addLink

public void addLink(ILink link)

Specified by:

addLink in interface INavigation

addLink

public void addLink(ILink link,
                    int pos)

Specified by:

addLink in interface INavigation

removeLink

public void removeLink(ILink link)

Specified by:

removeLink in interface INavigation

addLink

public void addLink(int pos)

Specified by:

addLink in interface INavigation

getLink

public ILink getLink(int pos)

getLinks

public java.util.Iterator getLinks()

Specified by:

getLinks in interface INavigation

getXMLTree

public org.jdom.Element getXMLTree()
                            throws FormInitException

Description copied from interface: IComponent

Get the actual XML result.

Specified by:

getXMLTree in interface IComponent

Overrides:

getXMLTree in class Component

Following copied from interface: org.jwarp.flow.form.model.IComponent

Returns:

The valid XML tree for this object

Throws:

FormInitException - If the component is not initialised with any neded data