Uses of Interface
org.olat.core.gui.components.form.flexible.FormItem

Packages that use FormItem
de.bps.olat.user.propertyhandlers   
org.olat.core.commons.modules.bc.meta   
org.olat.core.commons.services.search.ui   
org.olat.core.gui.components.form.flexible Flexi.Form is the way to create forms in OLAT since release 5.2. 
org.olat.core.gui.components.form.flexible.elements   
org.olat.core.gui.components.form.flexible.impl   
org.olat.core.gui.components.form.flexible.impl.elements   
org.olat.core.gui.components.form.flexible.impl.elements.richText   
org.olat.core.gui.components.form.flexible.impl.elements.table   
org.olat.core.gui.components.form.flexible.impl.rules   
org.olat.core.gui.control.generic.wizard   
org.olat.core.util.component   
org.olat.course.condition   
org.olat.search.ui The ui package contains all classes to implement the search-service user-interface. 
org.olat.user.propertyhandlers   
 

Uses of FormItem in de.bps.olat.user.propertyhandlers
 

Methods in de.bps.olat.user.propertyhandlers that return FormItem
 FormItem GenericCheckboxPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 

Methods in de.bps.olat.user.propertyhandlers with parameters of type FormItem
 java.lang.String GenericCheckboxPropertyHandler.getStringValue(FormItem formItem)
           
 boolean GenericCheckboxPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 void GenericCheckboxPropertyHandler.updateUserFromFormItem(User user, FormItem formItem)
           
 

Uses of FormItem in org.olat.core.commons.modules.bc.meta
 

Methods in org.olat.core.commons.modules.bc.meta that return FormItem
 FormItem MetaInfoFormController.getFormItem()
          Get the form item representing this form
 

Uses of FormItem in org.olat.core.commons.services.search.ui
 

Methods in org.olat.core.commons.services.search.ui that return FormItem
 FormItem SearchController.getFormItem()
           
 FormItem ResultController.getInitialFormItem()
           
 

Uses of FormItem in org.olat.core.gui.components.form.flexible
 

Subinterfaces of FormItem in org.olat.core.gui.components.form.flexible
 interface FormItemContainer
          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.
 interface FormMultipartItem
          Description:
 

Methods in org.olat.core.gui.components.form.flexible that return FormItem
 FormItem FormUIFactory.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 FormUIFactory.addStaticExampleText(java.lang.String name, java.lang.String i18nLabel, java.lang.String text, FormItemContainer formLayout)
           
 FormItem FormUIFactory.createSimpleErrorText(java.lang.String name, java.lang.String translatedText)
          Static text with the error look and feel.
 FormItem FormUIFactory.createSimpleLabelText(java.lang.String name, java.lang.String translatedText)
           
 FormItem FormItemContainer.getFormComponent(java.lang.String name)
           
 FormItem FormItemDependencyRule.getTriggerElement()
          which form element triggers this rule
 FormItem FormItem.setLabelComponent(FormItem labelComponent, FormItemContainer formLayout)
          see setErrorComponent for comments
 

Methods in org.olat.core.gui.components.form.flexible that return types with arguments of type FormItem
 java.util.Map<java.lang.String,FormItem> FormItemContainer.getFormComponents()
          the form components managed by this container
 java.util.Set<FormItem> FormItemDependencyRule.getTargetElements()
           
 

Methods in org.olat.core.gui.components.form.flexible with parameters of type FormItem
 void FormItemContainer.add(FormItem formComp)
          add a formelement or container by adding subcomponents name_LABEL name_ERROR name_EXAMPLE
 void FormItemContainer.add(java.lang.String name, FormItem formComp)
          add with different name
 void DependencyRuleApplayable.apply(FormItem triggerElement, java.lang.Object triggerVal, java.util.Set<FormItem> targets)
          custom rule interface
 void FormItemContainer.evalDependencyRuleSetFor(UserRequest ureq, FormItem formItem)
           
 void FormItemContainer.register(FormItem formComp)
          register only, does not addsubcomponents, does not expose formItem in the velocity.
 void FormItemContainer.remove(FormItem formComp)
          remove the component from this container
 void FormItem.setErrorComponent(FormItem errorFormItem, FormLayouter container)
          a complex "error" message, or a helper wizard to fix the error.
It must be a form item itself, that starting the fixing workflow let the surrounding form evaluate (intermediate save values).
Typically a FormLink is used here to start a workflow in a modal dialog.
Use showError(true) for the visibility of the error.
 FormItem FormItem.setLabelComponent(FormItem labelComponent, FormItemContainer formLayout)
          see setErrorComponent for comments
 

Method parameters in org.olat.core.gui.components.form.flexible with type arguments of type FormItem
 void FormItemContainer.add(java.lang.String string, java.util.Collection<FormItem> stepTitleLinks)
           
 void DependencyRuleApplayable.apply(FormItem triggerElement, java.lang.Object triggerVal, java.util.Set<FormItem> targets)
          custom rule interface
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.elements
 

Subinterfaces of FormItem in org.olat.core.gui.components.form.flexible.elements
 interface Cancel
          Description:
The cancel button offers a way to not submit any data and to reset the form
 interface DateChooser
           
 interface FileElement
          Description:
 interface FormLink
           
 interface InlineElement
          Description:
TODO: patrickb Class Description for InlineTextElement
 interface InlineIntegerElement
          Description:
TODO: patrickb Class Description for InlineIntegerElement
 interface InlineTextElement
          Description:
TODO: patrickb Class Description for InlineTextElement
 interface IntegerElement
          Description:
TODO: patrickb Class Description for IntegerElement
 interface MultipleSelectionElement
          Description:
TODO: patrickb Class Description for MultipleSelectionElement
 interface Reset
          Description:
Marker interface for form item implementing a form reset or cancel functionality.
 interface RichTextElement
          Description:
The rich text flexi form element is a text area that can be formatted using WYSIWYG techniques.The formatting is limited to what is possible in a browser.
 interface SelectionElement
           
 interface SingleSelection
           
 interface SpacerElement
          Implements an HTML horizontal bar (<HR>) element.
 interface StaticTextElement
           
 interface Submit
          Description:
Marker interface for form item implementing a form submit functionality.
 interface TextElement
          Description:
TODO: patrickb Class Description for TextElement
 

Methods in org.olat.core.gui.components.form.flexible.elements that return FormItem
 FormItem InlineElement.setEmptyDisplayText(java.lang.String i18nKey4Text)
           
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.impl
 

Classes in org.olat.core.gui.components.form.flexible.impl that implement FormItem
 class FormItemImpl
          Description:
 class FormLayoutContainer
          Description:
TODO: patrickb Class Description for FormVelocityContainer
 

Methods in org.olat.core.gui.components.form.flexible.impl that return FormItem
 FormItem FormLayoutContainer.getFormComponent(java.lang.String name)
           
 FormItem FormEvent.getFormItemSource()
           
 FormItem FormItemImpl.setEmptyDisplayText(java.lang.String i18nKey4Text)
           
 FormItem FormItemImpl.setLabelComponent(FormItem labelComponent, FormItemContainer container)
           
 

Methods in org.olat.core.gui.components.form.flexible.impl that return types with arguments of type FormItem
 java.util.Map<java.lang.String,FormItem> FormLayoutContainer.getFormComponents()
           
 

Methods in org.olat.core.gui.components.form.flexible.impl with parameters of type FormItem
 void FormLayoutContainer.add(FormItem formComp)
           
 void FormLayoutContainer.add(java.lang.String name, FormItem formComp)
           
 void FormLayoutContainer.evalDependencyRuleSetFor(UserRequest ureq, FormItem dispatchFormItem)
           
 void FormLayoutContainer.register(FormItem formComp)
           
 void FormLayoutContainer.remove(FormItem toBeRemoved)
           
 void FormLayoutContainer.replace(FormItem toBeReplaced, FormItem with)
           
 void FormItemImpl.setErrorComponent(FormItem errorFormItem, FormLayouter container)
           
 FormItem FormItemImpl.setLabelComponent(FormItem labelComponent, FormItemContainer container)
           
 

Method parameters in org.olat.core.gui.components.form.flexible.impl with type arguments of type FormItem
 void FormLayoutContainer.add(java.lang.String name, java.util.Collection<FormItem> foItems)
           
 

Constructors in org.olat.core.gui.components.form.flexible.impl with parameters of type FormItem
FormEvent(Event event, FormItem source, int action)
           
FormEvent(java.lang.String command, FormItem source)
           
FormEvent(java.lang.String command, FormItem source, int action)
           
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.impl.elements
 

Classes in org.olat.core.gui.components.form.flexible.impl.elements that implement FormItem
 class AbstractTextElement
          Description:
TODO: patrickb Class Description for AbstractTextElement
 class FileElementImpl
          Description:
 class FormCancel
          Description:
The form cancel triggers the form cancelled event and bypasses the normal form event infrastructure by using a conventional link and an inner controller that dispatches the link event and forwards it as an inner form event.
 class FormLinkImpl
          Description:
Links / Buttons within the flexi form have to be form items.
 class FormReset
           
 class FormSubmit
          Description:
TODO: patrickb Class Description for FormSubmit
 class IntegerElementImpl
          Description:
TODO: patrickb Class Description for IntegerElement
 class JSDateChooser
          Description:
TODO: patrickb Class Description for JSDateChooser
 class MultipleSelectionElementImpl
          Description:
TODO: patrickb Class Description for MultipleSelectionElementImpl
 class MultiSelectionTree
          Description:
TODO: patrickb Class Description for SelectionTree
 class SingleSelectionImpl
          Description:
TODO: patrickb Class Description for SingleSelectionContainerImpl
 class SpacerElementImpl
          Implements an HTML horizontal bar (<HR>) element.
 class StaticTextElementImpl
          Description:
TODO: patrickb Class Description for StaticTextElementImpl
 class TextAreaElementImpl
          Description:
TextArea-Element for FlexiForm
 class TextElementImpl
          Description:
TODO: patrickb Class Description for TextElement
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.impl.elements.richText
 

Classes in org.olat.core.gui.components.form.flexible.impl.elements.richText that implement FormItem
 class RichTextElementImpl
          Description:
This class implements a rich text form element based on the TinyMCE javascript library.
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.impl.elements.table
 

Classes in org.olat.core.gui.components.form.flexible.impl.elements.table that implement FormItem
 class FlexiTableElementImpl
           
 

Uses of FormItem in org.olat.core.gui.components.form.flexible.impl.rules
 

Methods in org.olat.core.gui.components.form.flexible.impl.rules that return FormItem
 FormItem FormItemDependencyRuleImpl.getTriggerElement()
           
 

Methods in org.olat.core.gui.components.form.flexible.impl.rules that return types with arguments of type FormItem
 java.util.Set<FormItem> FormItemDependencyRuleImpl.getTargetElements()
           
 

Methods in org.olat.core.gui.components.form.flexible.impl.rules with parameters of type FormItem
static FormItemDependencyRule RulesFactory.createCustomRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
          creates a custom rule, it is a must to define and set the applayable
static FormItemDependencyRule RulesFactory.createCustomRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
          Creates a custom rule which is triggered whenever triggerElement is set to triggerValue.
static FormItemDependencyRule RulesFactory.createHideRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createHideRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createReadOnlyRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createReadOnlyRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createResetRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
          creates a reset rule
static FormItemDependencyRule RulesFactory.createResetRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
          creates a reset rule
static FormItemDependencyRule RulesFactory.createShowRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createShowRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createWritableRule(FormItem triggerElement, java.lang.Object triggerValue, FormItem target, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createWritableRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
 

Method parameters in org.olat.core.gui.components.form.flexible.impl.rules with type arguments of type FormItem
static FormItemDependencyRule RulesFactory.createCustomRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
          Creates a custom rule which is triggered whenever triggerElement is set to triggerValue.
static FormItemDependencyRule RulesFactory.createHideRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createReadOnlyRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createResetRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
          creates a reset rule
static FormItemDependencyRule RulesFactory.createShowRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
static FormItemDependencyRule RulesFactory.createWritableRule(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, FormItemContainer formLayout)
           
 

Constructors in org.olat.core.gui.components.form.flexible.impl.rules with parameters of type FormItem
FormItemDependencyRuleImpl(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, int type)
           
 

Constructor parameters in org.olat.core.gui.components.form.flexible.impl.rules with type arguments of type FormItem
FormItemDependencyRuleImpl(FormItem triggerElement, java.lang.Object triggerValue, java.util.Set<FormItem> targets, int type)
           
 

Uses of FormItem in org.olat.core.gui.control.generic.wizard
 

Methods in org.olat.core.gui.control.generic.wizard that return FormItem
 FormItem StepFormController.getStepFormItem()
          the "sub"form container which is placed in the steps main run controller's place for this steps content.
 FormItem StepFormBasicController.getStepFormItem()
           
 FormItem BasicStep.getStepShortDescription()
          generates a StaticTextElement with i18n key defined, or returns null if i18n key undefined.
 FormItem Step.getStepShortDescription()
          tells in one or two sentences what the title could not express.
 FormItem BasicStep.getStepTitle()
          generates FormLink with defined i18nKey, otherwise override and provide your own FormItem here.
 FormItem Step.getStepTitle()
          descriptive and short title of input mask or info mask presented by this step.
 

Uses of FormItem in org.olat.core.util.component
 

Methods in org.olat.core.util.component with parameters of type FormItem
 boolean FormComponentVisitor.visit(FormItem comp, UserRequest ureq)
          Visitor pattern
 

Constructors in org.olat.core.util.component with parameters of type FormItem
FormComponentTraverser(FormComponentVisitor v, FormItem root, boolean visitChildrenFirst)
           
 

Uses of FormItem in org.olat.course.condition
 

Methods in org.olat.course.condition that return FormItem
 FormItem AttributeEasyRowAdderController.getFormItem()
          Get the form item that forms this subform
 

Uses of FormItem in org.olat.search.ui
 

Methods in org.olat.search.ui that return FormItem
 FormItem ResultsController.getFormItem()
           
 FormItem AdvancedSearchInputController.getFormItem()
           
 FormItem SearchInputController.getFormItem()
           
 FormItem ContextHelpResultController.getInitialFormItem()
           
 FormItem StandardResultController.getInitialFormItem()
           
 

Uses of FormItem in org.olat.user.propertyhandlers
 

Methods in org.olat.user.propertyhandlers that return FormItem
 FormItem MSNPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem EmailProperty.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem ICQPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem UserPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
          Adds a flexi-form Item for this UserPropertyHandler.
 FormItem SkypePropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem PhonePropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem XingPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem URLPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem GenderPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem DatePropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 FormItem Generic127CharTextPropertyHandler.addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer)
           
 

Methods in org.olat.user.propertyhandlers with parameters of type FormItem
 java.lang.String UserPropertyHandler.getStringValue(FormItem formItem)
          Get the value from this form item formatted as string.
 java.lang.String GenderPropertyHandler.getStringValue(FormItem formItem)
           
 java.lang.String DatePropertyHandler.getStringValue(FormItem formItem)
           
 java.lang.String Generic127CharTextPropertyHandler.getStringValue(FormItem formItem)
           
 boolean MSNPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean EmailProperty.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean ICQPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean UserPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
          Checks if a form item for a property has a valid value and sets the appropriate error key if necessary.
 boolean PhonePropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean XingPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean URLPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean GenderPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean DatePropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 boolean Generic127CharTextPropertyHandler.isValid(FormItem formItem, java.util.Map formContext)
           
 void UserPropertyHandler.updateUserFromFormItem(User user, FormItem formItem)
          Reads the value of the given form item and updates the user
 void GenderPropertyHandler.updateUserFromFormItem(User user, FormItem formItem)
           
 void DatePropertyHandler.updateUserFromFormItem(User user, FormItem formItem)
           
 void Generic127CharTextPropertyHandler.updateUserFromFormItem(User user, FormItem formItem)