butler.client.form
Class DForm

java.lang.Object
  butler.client.form.DForm

Direct Known Subclasses:

DDetailForm, DListForm, DLoginForm, DMultipleForm, DTreeForm, DWizard, DXMLForm

public class DForm
extends java.lang.Object

Author:

Fredrik Bertilsson

Nested Class Summary

static interface

DForm.Parser

Constructor Summary

DForm()

Method Summary

void	addAction(ClientAction action)
void	addMenu(DMenu menu)
DMenuItem	createMenuItem()
ClientAction	getAction(java.lang.String command)
java.util.List	getActions()
butler.util.LocalizedText	getCaption()
java.lang.String	getChildFormId(java.lang.String id)
java.util.Collection	getChildren()
butler.util.LocalizedText	getHelp()
java.lang.String	getId()
java.util.List	getMenuList()
java.lang.Object	getNativeInfo(java.lang.String type)
DForm	getParent()
java.lang.String	getSiblingFormId(java.lang.String id)
DStatusBar	getStatusBar()
java.lang.String	getTitle()
static DForm	parseForm(org.dom4j.Element element)
static DForm	parseForm(java.io.InputStream stream)
static void	registerParser(java.lang.String elementName, DForm.Parser parser)
void	setCaption(butler.util.LocalizedText caption)
void	setCaption(java.lang.String caption)
void	setHelp(butler.util.LocalizedText help)
void	setHelp(java.lang.String help)
void	setId(java.lang.String id)
void	setNativeInfo(java.lang.String type, java.lang.Object info)
void	setParent(DForm parent)
void	setStatusBar(DStatusBar statusBar)
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

DForm

public DForm()

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getCaption

public butler.util.LocalizedText getCaption()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

setCaption

public void setCaption(java.lang.String caption)

setCaption

public void setCaption(butler.util.LocalizedText caption)

parseForm

public static DForm parseForm(java.io.InputStream stream)
                       throws java.lang.Exception

Throws:

java.lang.Exception

parseForm

public static DForm parseForm(org.dom4j.Element element)
                       throws java.lang.Exception

Throws:

java.lang.Exception

addMenu

public void addMenu(DMenu menu)

getMenuList

public java.util.List getMenuList()

getAction

public ClientAction getAction(java.lang.String command)

addAction

public void addAction(ClientAction action)

getActions

public java.util.List getActions()

registerParser

public static void registerParser(java.lang.String elementName,
                                  DForm.Parser parser)

getTitle

public java.lang.String getTitle()
                          throws java.lang.Exception

Throws:

java.lang.Exception

setTitle

public void setTitle(java.lang.String title)

getStatusBar

public DStatusBar getStatusBar()

setStatusBar

public void setStatusBar(DStatusBar statusBar)

getHelp

public butler.util.LocalizedText getHelp()
                                  throws java.lang.Exception

Throws:

java.lang.Exception

setHelp

public void setHelp(java.lang.String help)

setHelp

public void setHelp(butler.util.LocalizedText help)

getParent

public DForm getParent()

setParent

public void setParent(DForm parent)

getChildFormId

public java.lang.String getChildFormId(java.lang.String id)

getSiblingFormId

public java.lang.String getSiblingFormId(java.lang.String id)

createMenuItem

public DMenuItem createMenuItem()
                         throws java.lang.Exception

Throws:

java.lang.Exception

setNativeInfo

public void setNativeInfo(java.lang.String type,
                          java.lang.Object info)

getNativeInfo

public java.lang.Object getNativeInfo(java.lang.String type)

getChildren

public java.util.Collection getChildren()
                                 throws java.lang.Exception

Throws:

java.lang.Exception