Examples of org.olat.core.gui.components.form.flexible.FormItem

Package org.olat.core.gui.components.form.flexible

Examples of org.olat.core.gui.components.form.flexible.FormItem

org.olat.core.gui.components.form.flexible.FormItem
Summary:
setting panels content is optional and params can always be null
- setXyzKey(String i18nKey, String[] params)
- setErrorComponent(FormItem quickFixWizard)
accessing different panels within velocity of a form item:
- $r.render("formElementName_LABEL")
- $r.render("formElementName_ERROR")
- $r.render("formElementName_EXAMPLE")
find out about form item attributes by querying it from the velocity page with:
- $f.isMandatory("formElementName")
- $f.hasError("formElementName")
- $f.hasExample("formElementName")
- $f.hasLabel("formElementName")
whereas $f. is the {@link FormDecorator} instance in the velocity.

Description:
Each implemented form item consists of 4 panels appearing as div's in the html rendered page. They belong together in a logical way, but are layoutable, e.g. placeable anywhere within a velocity page. The following figure illustrates the logical composition.
- the Element panel
  The form element panel holds for example one or more checkboxes, a dropdownbox, an input field, ... any other html form element, a link!, a custom element!
- the Label panel
  textlabel for the element
- the Error panel
  Either a textlabel as error text or another form element. This form element can then start a subworkflow explaining the error or for fixing the error.
- the Example panel
  example text, explaing an input format or how to proceed with the shown element.
The following figure shows a concrete example of a yes-no switch, the form element is labeled "Depending on date". The screenshot is taken in debug mode mini which is available in development mode only. SingleSelectionImpl is the FormItem implemenation in this case.

The java code to create the above yes-no-switch looks as follows. Please note the anonymous class creation style, with a initializer block. This helps grouping the code:
- 519: dateSwitch is the name of the element in the velocity container
- 521/522: form.easy.dateSwitch is the i18n key for labeling, and the label is made visible.
- 523/524: sets the i18n keys for yes and no, and selects no as default
- 528: add an onclick listener, so you get informed if yes or no is clicked
- 529: final step of adding the form element to form (layout), it is then available in the velocity page layouting the form under the name dateSwitch
The form item goes to a velocity page under defined name, e.g. dateSwitch, and the corresponding logical panels are accessed with the following convention:
- form element name_LABEL
- form element name_ERROR
- form element name_EXAMPLE
It is very common that a layout needs information about whether a form item has an error, example, label or is mandatory. This information is available through a {@link org.olat.core.gui.components.form.flexible.FormDecorator}which can be accessed for example as $f.hasError("dateSwitch").
The {@link FormItem} is aggregated within {@link FormItemContainer} and bothtogether form the composite pattern.
They play together with the {@link Component} and {@link Container}
Initial Date: 24.11.2006
@author patrickb

    //
    Manager im = ManagerFactory.getManager();
    Identity identity = im.findIdentityByName(getIdentity().getName());
    for (UserPropertyHandler userPropertyHandler : userPropertyHandlers) {
      String propertyName = userPropertyHandler.getName();
      FormItem fi = this.flc.getFormComponent(propertyName);
      String propertyValue = userPropertyHandler.getStringValue(fi);
      //(propertyname, propertyvalue) for mailtemplate
      propsAndValues.add(new String[]{translate(userPropertyHandler.i18nFormElementLabelKey()), propertyValue});
      //set property value
      identity.getUser().setProperty(propertyName, propertyValue);

View Full Code Here

      int i = 0;
      HashMap<String, String> attributeChangeMap = new HashMap<String, String>();
      for (Iterator<MultipleSelectionElement> iterator = checkBoxes.iterator(); iterator.hasNext();) {
        MultipleSelectionElement checkbox = iterator.next();
        if (checkbox.isSelected(0)) {
          FormItem formItem = formItems.get(i);
          // first get the values from the hardcoded items
          if (formItem.getName().equals(UserBulkChangeManager.LANG_IDENTIFYER)) {
            SingleSelection selectField = (SingleSelection) formItem;
            attributeChangeMap.put(UserBulkChangeManager.LANG_IDENTIFYER, selectField.getSelectedKey());            
          } else if (formItem.getName().equals(UserBulkChangeManager.PWD_IDENTIFYER)) {
            TextElement propertyField = (TextElement) formItem;
            attributeChangeMap.put(UserBulkChangeManager.PWD_IDENTIFYER, propertyField.getValue());            
          }          
          // second get the values from all configured user properties
          else {
            // find corresponding user property handler
            for (UserPropertyHandler propertyHanlder : userPropertyHandlers) {
              if (propertyHanlder.getName().equals(formItem.getName())) {
                String inputText;
                if (formItem instanceof DateChooser) {
                  // special case: don't use getStringValue, this would encode
                  // the date with the date formatter, use raw text input value
                  // instead
                  DateChooser dateItem = (DateChooser) formItem;  
                  inputText = dateItem.getValue();
                } else {
                  inputText = propertyHanlder.getStringValue(formItem);
                }


                attributeChangeMap.put(formItem.getName(), inputText);
              }
            }
          }
        }
        i++;

View Full Code Here

      for (Iterator<MultipleSelectionElement> iterator = checkBoxes.iterator(); iterator.hasNext();) {
        MultipleSelectionElement checkbox = iterator.next();
        if (checkbox.isSelected(0)) {
          Context vcContext = ubcMan.getDemoContext(getTranslator(), isAdministrativeUser);
          validChange = true;
          FormItem formItem = formItems.get(i);
          if (formItem instanceof TextElement) {
            TextElement propertyField = (TextElement) formItem;
            String inputFieldValue = propertyField.getValue();




            // check validity of velocity-variables by using default values from
            // userproperties
            inputFieldValue = inputFieldValue.replace("$", "$!");
            String evaluatedInputFieldValue = ubcMan.evaluateValueWithUserContext(inputFieldValue, vcContext);


            // check user property configuration
            for (UserPropertyHandler handler : userPropertyHandlers) {
              if (handler.getName().equals(formItem.getName())) {
                // first check on mandatoryness
                if (um.isMandatoryUserProperty(usageIdentifyer, handler) && ! StringHelper.containsNonWhitespace(evaluatedInputFieldValue)) {
                  formItem.setErrorKey("form.name." + handler.getName() + ".error.empty", null);        
                  return false;                  
                }
                // second check on property content
                ValidationError valicationError = new ValidationError();
                if (! handler.isValidValue(evaluatedInputFieldValue, valicationError, ureq.getLocale())) {
                  formItem.setErrorKey(valicationError.getErrorKey(), null);
                  return false;
                }
                // else validation was ok, reset previous errors
                formItem.clearError();
              }
            }


            // special case: check password-syntax:
            if (propertyField.getName().equals("password")) {

View Full Code Here

  }


  protected void formInnerEvent(UserRequest ureq, FormItem source, FormEvent event) {
    if (event instanceof FormEvent) {
      FormEvent fe = (FormEvent) event;
      FormItem sourceItem = fe.getFormItemSource();
      if (source instanceof FormLink) {
        FormLink link = (FormLink)source;
        if (link.getName().equals(ADD_FIELD_LINK)) {
          if (customFields.size() < MAX_NBR_CUSTOM_FIELDS) {
            // Add new custom-field

View Full Code Here

0 1 2 3

TOP

Related Classes of org.olat.core.gui.components.form.flexible.FormItem

ch.unizh.portal.zsuz.ZsuzStepUserDataForm

org.olat.admin.user.bulkChange.UserBulkChangeStep00$UserBulkChangeStepForm00

org.olat.admin.user.NewUserForm

org.olat.core.commons.modules.glossary.GlossaryTermAndSynonymController

org.olat.core.gui.components.form.flexible.impl.elements.table.FlexiTableRenderer

org.olat.core.gui.components.form.flexible.impl.Form

org.olat.core.gui.components.form.flexible.impl.FormBasicController

org.olat.core.gui.components.form.flexible.impl.FormDecoratorImpl

org.olat.core.gui.components.form.flexible.impl.FormLayoutContainer

org.olat.core.gui.components.form.flexible.impl.rules.FormItemDependencyRuleImpl

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of org.olat.core.gui.components.form.flexible.FormItem

Summary:

Description:

Related Classes of org.olat.core.gui.components.form.flexible.FormItem