org.olat.core.gui.components.form.flexible
Interface FormItemContainer

All Superinterfaces:

FormBaseComponentIdProvider, FormItem

All Known Implementing Classes:

FormLayoutContainer

public interface FormItemContainer
extends FormItem

Description:
FormContainer and FormComponent -> Composite Pattern Implementors of FormContainer should also extend the olat Container and override its put(.., Component) methods by throwing an exception -> use add instead.

Initial Date: 24.11.2006

Author:

patrickb

Field Summary

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormItem

ERRORC, EXAMPLEC, LABELC

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

DISPPREFIX

Method Summary

void	add(FormItem formComp) add a formelement or container by adding subcomponents name_LABEL name_ERROR name_EXAMPLE
void	add(java.lang.String string, java.util.Collection<FormItem> stepTitleLinks)
void	add(java.lang.String name, FormItem formComp) add with different name
void	addDependencyRule(FormItemDependencyRule depRule) add a dependency rule between a form item source and typically one or more form item targets.
void	evalDependencyRuleSetFor(UserRequest ureq, FormItem formItem)
FormItem	getFormComponent(java.lang.String name)
java.util.Map<java.lang.String,FormItem>	getFormComponents() the form components managed by this container
void	register(FormItem formComp) register only, does not addsubcomponents, does not expose formItem in the velocity.
void	remove(FormItem formComp) remove the component from this container
void	remove(java.lang.String name) remove the component with the give name from this container
void	setRootForm(Form rootForm) the getter is defined on FormItem

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormItem

addActionListener, clearError, doDispatchFormRequest, evalFormRequest, getAction, getActionListenersFor, getComponent, getErrorC, getErrorText, getExampleC, getExampleText, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isMandatory, isVisible, reset, setEnabled, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setTranslator, setUserObject, setVisible, showError, showExample, showLabel, validate

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

getFormDispatchId

Method Detail

add

void add(FormItem formComp)

add a formelement or container by adding subcomponents

• name_LABEL
• name_ERROR
• name_EXAMPLE

Parameters:

name -

formComp -

add

void add(java.lang.String name,
         FormItem formComp)

add with different name

Parameters:

name -

formComp -

register

void register(FormItem formComp)

register only, does not addsubcomponents, does not expose formItem in the velocity. In 99% of the cases you should use an addXX method instead.

Parameters:

formComp -

remove

void remove(FormItem formComp)

remove the component from this container

Parameters:

formComp -

remove

void remove(java.lang.String name)

remove the component with the give name from this container

Parameters:

name -

getFormComponents

java.util.Map<java.lang.String,FormItem> getFormComponents()

the form components managed by this container

Returns:

getFormComponent

FormItem getFormComponent(java.lang.String name)

Parameters:

name -

Returns:

setRootForm

void setRootForm(Form rootForm)

the getter is defined on FormItem

Specified by:

setRootForm in interface FormItem

Parameters:

rootForm -

addDependencyRule

void addDependencyRule(FormItemDependencyRule depRule)

add a dependency rule between a form item source and typically one or more form item targets. See FormItemDependencyRule for more information.

Parameters:

depRule -

See Also:

FormItemDependencyRule

evalDependencyRuleSetFor

void evalDependencyRuleSetFor(UserRequest ureq,
                              FormItem formItem)

Parameters:

ureq -

dispatchFormItem -

add

void add(java.lang.String string,
         java.util.Collection<FormItem> stepTitleLinks)

Parameters:

string -

stepTitleLinks -