org.olat.core.gui.components.form.flexible
Class FormUIFactory

java.lang.Object
  org.olat.core.gui.components.form.flexible.FormUIFactory

public class FormUIFactory
extends java.lang.Object

Factory class to create the flexible form elements.

Author:

patrickb

Method Summary

MultipleSelectionElement	addCheckboxesHorizontal(java.lang.String name, FormItemContainer formLayout, java.lang.String[] keys, java.lang.String[] values, java.lang.String[] cssClasses) Create a multiple selection element with check-boxes horizontal aligned.
MultipleSelectionElement	addCheckboxesHorizontal(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, java.lang.String[] keys, java.lang.String[] values, java.lang.String[] cssClasses) Create a multiple selection element with check-boxes horizontal aligned.
MultipleSelectionElement	addCheckboxesVertical(java.lang.String name, FormItemContainer formLayout, java.lang.String[] keys, java.lang.String[] values, java.lang.String[] cssClasses, int columns) Create a multiple selection element with check-boxes that is rendered in vertical columns This method uses the name to set the i18nkey of the label.
MultipleSelectionElement	addCheckboxesVertical(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, java.lang.String[] keys, java.lang.String[] values, java.lang.String[] cssClasses, int columns) Create a multiple selection element with check-boxes that is rendered in vertical columns
DateChooser	addDateChooser(java.lang.String name, java.lang.String initValue, FormItemContainer formLayout) Date chooser is a text field with an icon, which on click shows a java script calendar to choose a date/time.
DateChooser	addDateChooser(java.lang.String name, java.lang.String i18nLabel, java.lang.String initValue, FormItemContainer formLayout) Date chooser is a text field with an icon, which on click shows a java script calendar to choose a date/time.
MultipleSelectionElement	addDropdownMultiselect(java.lang.String name, FormItemContainer formLayout) Create a multiple selection element as a drop-down This method uses the name to set the i18nkey of the label.
MultipleSelectionElement	addDropdownMultiselect(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout)
SingleSelection	addDropdownSingleselect(java.lang.String name, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues, java.lang.String[] theCssClasses) Add a drop down menu (also called pulldown menu), with a label's i18n key being the same as the name.
SingleSelection	addDropdownSingleselect(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues, java.lang.String[] theCssClasses) Add a drop down menu (also called pulldown menu).
FileElement	addFileElement(java.lang.String name, FormItemContainer formLayout) Add a file upload element, with a label's i18n key being the same as the name.
FileElement	addFileElement(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout) Add a file upload element
FormCancel	addFormCancelButton(java.lang.String name, FormLayoutContainer formLayoutContainer, UserRequest ureq, WindowControl wControl) Add a form cancel button.
FormLink	addFormLink(java.lang.String name, FormItemContainer formLayout) creates a form link with the given name which acts also as command, i18n and component name.
FormLink	addFormLink(java.lang.String name, FormItemContainer formLayout, int presentation) Add a form link with the option to choose the presentation, the name parameter is taken as to be used in $r.render(""), as i18nkey for the link text, and also the cmd string.
FormLink	addFormLink(java.lang.String name, FormItemContainer formLayout, java.lang.String customEnabledLinkCSS) Add a form link with a special css class
FormLink	addFormLink(java.lang.String name, java.lang.String i18nLink, java.lang.String i18nLabel, FormItemContainer formLayout, int presentation)
FormSubmit	addFormSubmitButton(java.lang.String name, FormItemContainer formLayout) Add a form submit button.
FormSubmit	addFormSubmitButton(java.lang.String name, java.lang.String i18nKey, FormItemContainer formLayout) Add a form submit button.
IntegerElement	addInlineIntegerElement(java.lang.String name, int initVal, FormItemContainer formLayout, FormBasicController listener)
TextElement	addInlineTextElement(java.lang.String name, java.lang.String value, FormItemContainer formLayout, FormBasicController listener)
IntegerElement	addIntegerElement(java.lang.String name, int initVal, FormItemContainer formLayout) create an integer Element.
IntegerElement	addIntegerElement(java.lang.String name, java.lang.String i18nLabel, int initVal, FormItemContainer formLayout) create an integer Element
TextElement	addPasswordElement(java.lang.String name, java.lang.String i18nLabel, int maxLen, java.lang.String initialValue, FormItemContainer formLayout)
SingleSelection	addRadiosHorizontal(java.lang.String name, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues) Add horizontal aligned radio buttons.
SingleSelection	addRadiosHorizontal(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues) Add horizontal aligned radio buttons.
SingleSelection	addRadiosVertical(java.lang.String name, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues) Add vertical aligned radio buttons This method uses the name to set the i18nkey of the label.
SingleSelection	addRadiosVertical(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, java.lang.String[] theKeys, java.lang.String[] theValues) Add vertical aligned radio buttons
RichTextElement	addRichTextElementForFileData(java.lang.String name, java.lang.String i18nLabel, java.lang.String initialValue, int rows, int cols, boolean externalToolbar, VFSContainer baseContainer, java.lang.String relFilePath, CustomLinkTreeModel customLinkTreeModel, FormItemContainer formLayout, UserSession usess, WindowControl wControl) Add a rich text formattable element that offers complex formatting functionality and loads the data from the given file path.
RichTextElement	addRichTextElementForStringData(java.lang.String name, java.lang.String i18nLabel, java.lang.String initialHTMLValue, int rows, int cols, boolean externalToolbar, boolean fullProfile, VFSContainer baseContainer, CustomLinkTreeModel customLinkTreeModel, FormItemContainer formLayout, UserSession usess, WindowControl wControl) Add a rich text formattable element that offers simple formatting functionality and loads the data form the given string value.
RichTextElement	addRichTextElementForStringDataMinimalistic(java.lang.String name, java.lang.String i18nLabel, java.lang.String initialHTMLValue, int rows, int cols, boolean externalToolbar, FormItemContainer formLayout, UserSession usess, WindowControl wControl) Add a rich text formattable element that offers basic formatting functionality and loads the data form the given string value.
SpacerElement	addSpacerElement(java.lang.String name, FormItemContainer formLayout, boolean onlySpaceAndNoLine) Inserts an HTML horizontal bar (<HR>) element.
FormItem	addStaticExampleText(java.lang.String name, java.lang.String text, FormItemContainer formLayout) adds a given text formatted in example style as part of the form.
FormItem	addStaticExampleText(java.lang.String name, java.lang.String i18nLabel, java.lang.String text, FormItemContainer formLayout)
StaticTextElement	addStaticTextElement(java.lang.String name, java.lang.String translatedText, FormItemContainer formLayout) Add a static text, with a label's i18n key being the same as the name.
StaticTextElement	addStaticTextElement(java.lang.String name, java.lang.String i18nLabel, java.lang.String translatedText, FormItemContainer formLayout) Add a static text.
FlexiTableElment	addTableElement(java.lang.String name, FlexiTableDataModel tableModel, FormItemContainer formLayout)
TextElement	addTextAreaElement(java.lang.String name, int rows, int cols, java.lang.String initialValue, FormItemContainer formLayout) Add a multi line text element, using the provided name as i18n key for the label, no max length check set, and fits content hight at maximium (100lnes).
TextElement	addTextAreaElement(java.lang.String name, java.lang.String i18nLabel, int maxLen, int rows, int cols, boolean isAutoHeightEnabled, java.lang.String initialValue, FormItemContainer formLayout) Add a multi line text element
TextElement	addTextElement(java.lang.String name, java.lang.String i18nLabel, int maxLen, java.lang.String initialValue, FormItemContainer formLayout)
MultipleSelectionElement	addTreeMultiselect(java.lang.String name, FormItemContainer formLayout, TreeModel treemodel, INodeFilter selectableFilter) Create a multiple selection element as a tree.
MultipleSelectionElement	addTreeMultiselect(java.lang.String name, java.lang.String i18nLabel, FormItemContainer formLayout, TreeModel treemodel, INodeFilter selectableFilter) Create a multiple selection element as a tree.
FormItem	createSimpleErrorText(java.lang.String name, java.lang.String translatedText) Static text with the error look and feel.
FormItem	createSimpleLabelText(java.lang.String name, java.lang.String translatedText)
static FormUIFactory	getInstance()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FormUIFactory getInstance()

Returns:

addDateChooser

public DateChooser addDateChooser(java.lang.String name,
                                  java.lang.String initValue,
                                  FormItemContainer formLayout)

Date chooser is a text field with an icon, which on click shows a java script calendar to choose a date/time. This method uses the name to set the i18nkey of the label.

If no label is desired use the addDateChooser(String, String, String, FormItemContainer) with null as i18nLabel.

Parameters:

name -

initValue -

formLayout -

Returns:

addDateChooser

public DateChooser addDateChooser(java.lang.String name,
                                  java.lang.String i18nLabel,
                                  java.lang.String initValue,
                                  FormItemContainer formLayout)

Date chooser is a text field with an icon, which on click shows a java script calendar to choose a date/time.

Parameters:

name -

initValue -

i18nLabel -

formLayout -

Returns:

addIntegerElement

public IntegerElement addIntegerElement(java.lang.String name,
                                        int initVal,
                                        FormItemContainer formLayout)

create an integer Element. This method uses the name to set the i18nkey of the label.

If no label is desired use the addIntegerElement(String, String, int, FormItemContainer) with null as i18nLabel.

Parameters:

name -

initVal -

formLayout -

Returns:

addIntegerElement

public IntegerElement addIntegerElement(java.lang.String name,
                                        java.lang.String i18nLabel,
                                        int initVal,
                                        FormItemContainer formLayout)

create an integer Element

Parameters:

name -

initVal -

formLayout -

Returns:

addCheckboxesHorizontal

public MultipleSelectionElement addCheckboxesHorizontal(java.lang.String name,
                                                        FormItemContainer formLayout,
                                                        java.lang.String[] keys,
                                                        java.lang.String[] values,
                                                        java.lang.String[] cssClasses)

Create a multiple selection element with check-boxes horizontal aligned. This method uses the name to set the i18nkey of the label.

If no label is desired use the addCheckboxesHorizontal(String, String, FormItemContainer, String[], String[], String[]) with null as i18nLabel.

Parameters:

name -

layouter -

keys -

values -

cssClasses -

Returns:

addCheckboxesHorizontal

public MultipleSelectionElement addCheckboxesHorizontal(java.lang.String name,
                                                        java.lang.String i18nLabel,
                                                        FormItemContainer formLayout,
                                                        java.lang.String[] keys,
                                                        java.lang.String[] values,
                                                        java.lang.String[] cssClasses)

Create a multiple selection element with check-boxes horizontal aligned.

Parameters:

name -

i18nLabel -

formLayout -

keys -

values -

cssClasses -

Returns:

addCheckboxesVertical

public MultipleSelectionElement addCheckboxesVertical(java.lang.String name,
                                                      FormItemContainer formLayout,
                                                      java.lang.String[] keys,
                                                      java.lang.String[] values,
                                                      java.lang.String[] cssClasses,
                                                      int columns)

Create a multiple selection element with check-boxes that is rendered in vertical columns This method uses the name to set the i18nkey of the label.

If no label is desired use the addCheckboxesVertical(String, String, FormItemContainer, String[], String[], String[], int) with null as i18nLabel.

Parameters:

name -

layouter -

keys -

values -

cssClasses -

columns - Currently 1 and 2 columns are supported

Returns:

addCheckboxesVertical

public MultipleSelectionElement addCheckboxesVertical(java.lang.String name,
                                                      java.lang.String i18nLabel,
                                                      FormItemContainer formLayout,
                                                      java.lang.String[] keys,
                                                      java.lang.String[] values,
                                                      java.lang.String[] cssClasses,
                                                      int columns)

Create a multiple selection element with check-boxes that is rendered in vertical columns

Parameters:

name -

i18nLabel -

formLayout -

keys -

values -

cssClasses -

columns -

Returns:

addDropdownMultiselect

public MultipleSelectionElement addDropdownMultiselect(java.lang.String name,
                                                       FormItemContainer formLayout)

Create a multiple selection element as a drop-down This method uses the name to set the i18nkey of the label.

If no label is desired use the addDropdownMultiselect(String, String, FormItemContainer) with null as i18nLabel.

Parameters:

name -

formLayout -

Returns:

addDropdownMultiselect

public MultipleSelectionElement addDropdownMultiselect(java.lang.String name,
                                                       java.lang.String i18nLabel,
                                                       FormItemContainer formLayout)

Parameters:

name -

i18nLabel -

formLayout -

Returns:

addTreeMultiselect

public MultipleSelectionElement addTreeMultiselect(java.lang.String name,
                                                   FormItemContainer formLayout,
                                                   TreeModel treemodel,
                                                   INodeFilter selectableFilter)

Create a multiple selection element as a tree. This method uses the name to set the i18nkey of the label.

If no label is desired use the addDropdownMultiselect(String, String, FormItemContainer) with null as i18nLabel.

Parameters:

name -

formLayout -

treemodel -

Returns:

addTreeMultiselect

public MultipleSelectionElement addTreeMultiselect(java.lang.String name,
                                                   java.lang.String i18nLabel,
                                                   FormItemContainer formLayout,
                                                   TreeModel treemodel,
                                                   INodeFilter selectableFilter)

Create a multiple selection element as a tree.

Parameters:

name -

i18nLabel -

formLayout -

treemodel -

selectableFilter -

Returns:

addRadiosHorizontal

public SingleSelection addRadiosHorizontal(java.lang.String name,
                                           FormItemContainer formLayout,
                                           java.lang.String[] theKeys,
                                           java.lang.String[] theValues)

Add horizontal aligned radio buttons.
This method uses the name to set the i18nkey of the label.

If no label is desired use the addRadiosHorizontal(String, String, FormItemContainer, String[], String[]) with null as i18nLabel.

Parameters:

name - item identifier and i18n key for the label

formLayout -

theKeys - the radio button keys

theValues - the radio button display values

Returns:

addRadiosHorizontal

public SingleSelection addRadiosHorizontal(java.lang.String name,
                                           java.lang.String i18nLabel,
                                           FormItemContainer formLayout,
                                           java.lang.String[] theKeys,
                                           java.lang.String[] theValues)

Add horizontal aligned radio buttons.

Parameters:

name -

i18nLabel -

formLayout -

theKeys -

theValues -

Returns:

addRadiosVertical

public SingleSelection addRadiosVertical(java.lang.String name,
                                         FormItemContainer formLayout,
                                         java.lang.String[] theKeys,
                                         java.lang.String[] theValues)

Add vertical aligned radio buttons
This method uses the name to set the i18nkey of the label.

If no label is desired use the addRadiosVertical(String, String, FormItemContainer, String[], String[]) with null as i18nLabel.

Parameters:

name - item identifier and i18n key for the label

formLayout -

theKeys - the radio button keys

theValues - the radio button display values

Returns:

addRadiosVertical

public SingleSelection addRadiosVertical(java.lang.String name,
                                         java.lang.String i18nLabel,
                                         FormItemContainer formLayout,
                                         java.lang.String[] theKeys,
                                         java.lang.String[] theValues)

Add vertical aligned radio buttons

Parameters:

name -

i18nLabel -

formLayout -

theKeys -

theValues -

Returns:

addDropdownSingleselect

public SingleSelection addDropdownSingleselect(java.lang.String name,
                                               FormItemContainer formLayout,
                                               java.lang.String[] theKeys,
                                               java.lang.String[] theValues,
                                               java.lang.String[] theCssClasses)

Add a drop down menu (also called pulldown menu), with a label's i18n key being the same as the name. If you do not want a label, use the addDropdownSingleselect(String, String, FormItemContainer, String[], String[], String[]) method with the i18nKey and set it null

Parameters:

name - item identifier and i18n key for the label

formLayout -

theKeys - the menu selection keys

theValues - the menu display values

theCssClasses - the css classes to style the menu items or NULL to use no special styling

Returns:

addDropdownSingleselect

public SingleSelection addDropdownSingleselect(java.lang.String name,
                                               java.lang.String i18nLabel,
                                               FormItemContainer formLayout,
                                               java.lang.String[] theKeys,
                                               java.lang.String[] theValues,
                                               java.lang.String[] theCssClasses)

Add a drop down menu (also called pulldown menu).

Parameters:

name -

labelKey - i18n key for the label, may be null indicating no label.

formLayout -

theKeys -

theValues -

theCssClasses -

Returns:

addStaticTextElement

public StaticTextElement addStaticTextElement(java.lang.String name,
                                              java.lang.String translatedText,
                                              FormItemContainer formLayout)

Add a static text, with a label's i18n key being the same as the name. If you do not want a label, use the addStaticTextElement(String, String, String, FormItemContainer) method with the i18nKey and set it null

Parameters:

name -

translatedText -

formLayout -

Returns:

addStaticTextElement

public StaticTextElement addStaticTextElement(java.lang.String name,
                                              java.lang.String i18nLabel,
                                              java.lang.String translatedText,
                                              FormItemContainer formLayout)

Add a static text.

Parameters:

name -

i18nLabel -

translatedText -

formLayout -

Returns:

addInlineTextElement

public TextElement addInlineTextElement(java.lang.String name,
                                        java.lang.String value,
                                        FormItemContainer formLayout,
                                        FormBasicController listener)

addInlineIntegerElement

public IntegerElement addInlineIntegerElement(java.lang.String name,
                                              int initVal,
                                              FormItemContainer formLayout,
                                              FormBasicController listener)

addSpacerElement

public SpacerElement addSpacerElement(java.lang.String name,
                                      FormItemContainer formLayout,
                                      boolean onlySpaceAndNoLine)

Inserts an HTML horizontal bar (<HR>) element.

Parameters:

name -

formLayout -

Returns:

addStaticExampleText

public FormItem addStaticExampleText(java.lang.String name,
                                     java.lang.String text,
                                     FormItemContainer formLayout)

adds a given text formatted in example style as part of the form.

Parameters:

name -

text -

formLayout -

Returns:

addStaticExampleText

public FormItem addStaticExampleText(java.lang.String name,
                                     java.lang.String i18nLabel,
                                     java.lang.String text,
                                     FormItemContainer formLayout)

Parameters:

name -

i18nLabel - i18n key for label, null to disable

text -

formLayout -

Returns:

addTextElement

public TextElement addTextElement(java.lang.String name,
                                  java.lang.String i18nLabel,
                                  int maxLen,
                                  java.lang.String initialValue,
                                  FormItemContainer formLayout)

Parameters:

name -

maxLen -

initialValue -

i18nLabel -

formLayout -

Returns:

addPasswordElement

public TextElement addPasswordElement(java.lang.String name,
                                      java.lang.String i18nLabel,
                                      int maxLen,
                                      java.lang.String initialValue,
                                      FormItemContainer formLayout)

addTextAreaElement

public TextElement addTextAreaElement(java.lang.String name,
                                      int rows,
                                      int cols,
                                      java.lang.String initialValue,
                                      FormItemContainer formLayout)

Add a multi line text element, using the provided name as i18n key for the label, no max length check set, and fits content hight at maximium (100lnes).

Parameters:

name -

rows -

cols -

initialValue -

formLayout -

Returns:

See Also:

addTextAreaElement(String, String, int, int, int, boolean, String, FormItemContainer)

addTextAreaElement

public TextElement addTextAreaElement(java.lang.String name,
                                      java.lang.String i18nLabel,
                                      int maxLen,
                                      int rows,
                                      int cols,
                                      boolean isAutoHeightEnabled,
                                      java.lang.String initialValue,
                                      FormItemContainer formLayout)

Add a multi line text element

Parameters:

name -

i18nLabel - i18n key for the label or null to set no label at all.

maxLen -

rows - the number of lines or -1 to use default value

cols - the number of characters per line or -1 to use 100% of the available space

isAutoHeightEnabled - true: element expands to fit content height, (max 100 lines); false: specified rows used

initialValue - Initial value

formLayout -

Returns:

addRichTextElementForStringDataMinimalistic

public RichTextElement addRichTextElementForStringDataMinimalistic(java.lang.String name,
                                                                   java.lang.String i18nLabel,
                                                                   java.lang.String initialHTMLValue,
                                                                   int rows,
                                                                   int cols,
                                                                   boolean externalToolbar,
                                                                   FormItemContainer formLayout,
                                                                   UserSession usess,
                                                                   WindowControl wControl)

Add a rich text formattable element that offers basic formatting functionality and loads the data form the given string value. Use item.getEditorConfiguration() to add more editor features if you need them

Parameters:

name - Name of the form item

i18nLabel - The i18n key of the label or NULL when no label is used

initialValue - The initial value or NULL if no initial value is available

rows - The number of lines the editor should offer. Use -1 to indicate no specific height

cols - The number of characters width the editor should offer. Use -1 to indicate no specific width

externalToolbar - true: use an external toolbar that is only visible when the user clicks into the text area; false: use the static toolbar

formLayout - The form item container where to add the rich text element

usess - The user session that dispatches the images

wControl - the current window controller

wControl - the current window controller

Returns:

The rich text element instance

addRichTextElementForStringData

public RichTextElement addRichTextElementForStringData(java.lang.String name,
                                                       java.lang.String i18nLabel,
                                                       java.lang.String initialHTMLValue,
                                                       int rows,
                                                       int cols,
                                                       boolean externalToolbar,
                                                       boolean fullProfile,
                                                       VFSContainer baseContainer,
                                                       CustomLinkTreeModel customLinkTreeModel,
                                                       FormItemContainer formLayout,
                                                       UserSession usess,
                                                       WindowControl wControl)

Add a rich text formattable element that offers simple formatting functionality and loads the data form the given string value. Use item.getEditorConfiguration() to add more editor features if you need them

Parameters:

name - Name of the form item

i18nLabel - The i18n key of the label or NULL when no label is used

initialValue - The initial value or NULL if no initial value is available

rows - The number of lines the editor should offer. Use -1 to indicate no specific height

cols - The number of characters width the editor should offer. Use -1 to indicate no specific width

externalToolbar - true: use an external toolbar that is only visible when the user clicks into the text area; false: use the static toolbar

fullProfile - false: load only the necessary plugins; true: load all plugins from the full profile

baseContainer - The VFS container where to load resources from (images etc) or NULL to not allow embedding of media files at all

formLayout - The form item container where to add the richt text element

customLinkTreeModel - A custom link tree model or NULL not not use a custom model

formLayout - The form item container where to add the rich text element

usess - The user session that dispatches the images

wControl - the current window controller

wControl - the current window controller

Returns:

The rich text element instance

addRichTextElementForFileData

public RichTextElement addRichTextElementForFileData(java.lang.String name,
                                                     java.lang.String i18nLabel,
                                                     java.lang.String initialValue,
                                                     int rows,
                                                     int cols,
                                                     boolean externalToolbar,
                                                     VFSContainer baseContainer,
                                                     java.lang.String relFilePath,
                                                     CustomLinkTreeModel customLinkTreeModel,
                                                     FormItemContainer formLayout,
                                                     UserSession usess,
                                                     WindowControl wControl)

Add a rich text formattable element that offers complex formatting functionality and loads the data from the given file path. Use item.getEditorConfiguration() to add more editor features if you need them

Parameters:

name - Name of the form item

i18nLabel - The i18n key of the label or NULL when no label is used

initialValue - The initial value or NULL if no initial value is available

rows - The number of lines the editor should offer. Use -1 to indicate no specific height

cols - The number of characters width the editor should offer. Use -1 to indicate no specific width

externalToolbar - true: use an external toolbar that is only visible when the user clicks into the text area; false: use the static toolbar

baseContainer - The VFS container where to load resources from (images etc) or NULL to not allow embedding of media files at all

relFilePath - The path to the file relative to the baseContainer

customLinkTreeModel - A custom link tree model or NULL not not use a custom model

formLayout - The form item container where to add the rich text element

usess - The user session that dispatches the images

wControl - the current window controller

Returns:

The richt text element instance

createSimpleLabelText

public FormItem createSimpleLabelText(java.lang.String name,
                                      java.lang.String translatedText)

createSimpleErrorText

public FormItem createSimpleErrorText(java.lang.String name,
                                      java.lang.String translatedText)

Static text with the error look and feel.

Parameters:

name - in velocity for $r.render("name")

translatedText - already translated text that should be displayed.

Returns:

addTableElement

public FlexiTableElment addTableElement(java.lang.String name,
                                        FlexiTableDataModel tableModel,
                                        FormItemContainer formLayout)

Parameters:

name -

tableModel -

formLayout -

Returns:

See Also:

and its implementations

addFormLink

public FormLink addFormLink(java.lang.String name,
                            FormItemContainer formLayout)

creates a form link with the given name which acts also as command, i18n and component name.

Parameters:

name -

formLayout -

Returns:

addFormLink

public FormLink addFormLink(java.lang.String name,
                            FormItemContainer formLayout,
                            int presentation)

Add a form link with the option to choose the presentation, the name parameter is taken as to be used in $r.render(""), as i18nkey for the link text, and also the cmd string.

If different values are needed for name, i18nkey link text, use the addFormLink(String, String, String, FormItemContainer, int). This allows also to set the i18n key for label.

Parameters:

name - The name of the form element (identifyer), also used as i18n key

formLayout -

presentation - See Link.BUTTON etc

Returns:

addFormLink

public FormLink addFormLink(java.lang.String name,
                            java.lang.String i18nLink,
                            java.lang.String i18nLabel,
                            FormItemContainer formLayout,
                            int presentation)

Parameters:

name - to be used to render in velocity $r.render("name")

i18nLink - i18n key for the link text

i18nLabel - i18n key for the link elements label, maybe null

formLayout - FormLink is added as element here

presentation - See Link.BUTTON etc.

Returns:

addFormLink

public FormLink addFormLink(java.lang.String name,
                            FormItemContainer formLayout,
                            java.lang.String customEnabledLinkCSS)

Add a form link with a special css class

Parameters:

name - The name of the form element (identifyer), also used as i18n key

formLayout -

css - class

Returns:

addFileElement

public FileElement addFileElement(java.lang.String name,
                                  FormItemContainer formLayout)

Add a file upload element, with a label's i18n key being the same as the name. If you do not want a label, use the addFileElement(String, String, FormItemContainer) method with null value for the i18nKey.

Parameters:

name -

formLayout -

Returns:

addFileElement

public FileElement addFileElement(java.lang.String name,
                                  java.lang.String i18nLabel,
                                  FormItemContainer formLayout)

Add a file upload element

Parameters:

name -

i18nKey -

formLayout -

Returns:

addFormSubmitButton

public FormSubmit addFormSubmitButton(java.lang.String name,
                                      FormItemContainer formLayout)

Add a form submit button.

Parameters:

name - the button name (identifyer) and at the same time the i18n key of the button

formItemContiner - The container where to add the button

Returns:

the new form button

addFormSubmitButton

public FormSubmit addFormSubmitButton(java.lang.String name,
                                      java.lang.String i18nKey,
                                      FormItemContainer formLayout)

Add a form submit button.

Parameters:

name - the button name (identifyer)

i18nKey - The display key

formItemContiner - The container where to add the button

Returns:

the new form button

addFormCancelButton

public FormCancel addFormCancelButton(java.lang.String name,
                                      FormLayoutContainer formLayoutContainer,
                                      UserRequest ureq,
                                      WindowControl wControl)

Add a form cancel button. You must implement the formCancelled() method in your FormBasicController to get events fired by this button

Parameters:

name -

formLayoutContainer -

ureq -

wControl -

Returns: