org.olat.lms.user.propertyhandler

类 GenericCheckboxPropertyHandler

java.lang.Object

org.olat.lms.user.propertyhandler.AbstractUserPropertyHandler

org.olat.lms.user.propertyhandler.GenericCheckboxPropertyHandler

所有已实现的接口:

UserPropertyHandler, ItemValidatorProvider

public class GenericCheckboxPropertyHandler
extends AbstractUserPropertyHandler

Description: Checkbox property handler.

Initial Date: 06.08.2008

作者:

bja

方法概要

方法

限定符和类型	方法和说明
FormItem	addFormItem(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser, FormItemContainer formItemContainer) org.olat.presentation.framework.components.form.flexible.FormItemContainer)
FormElement	getFormElement(java.util.Locale locale, User user, java.lang.String usageIdentifyer, boolean isAdministrativeUser) Create a (non-flexi) form element for this UserPropertyHandler.
java.lang.String	getStringValue(FormElement ui) Get the value from this form element formatted as string.
java.lang.String	getStringValue(FormItem formItem) Get the value from this form item formatted as string.
java.lang.String	getStringValue(java.lang.String displayValue, java.util.Locale locale) Get the value from this GUI formatted string The returned value is formatted in a way it can be stored in the database, thus it might not be the right value to display to a user.
boolean	isValid(FormElement ui, java.util.Map formContext) Check if this form is valid
boolean	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	isValidValue(java.lang.String value, ValidationError validationError, java.util.Locale locale) Checks if the given value is a valid value for this property (e.g. syntax checking).
void	updateFormElementFromUser(FormElement ui, User user) Put the current value from this UserPropertyHandler into the given form element
void	updateUserFromFormElement(User user, FormElement ui) Reads the value of the given form element and updates the user
void	updateUserFromFormItem(User user, FormItem formItem) Reads the value of the given form item and updates the user

从类继承的方法 org.olat.lms.user.propertyhandler.AbstractUserPropertyHandler

getColumnDescriptor, getGroup, getName, getUserProperty, getUserPropertyAsHTML, i18nColumnDescriptorLabelKey, i18nFormElementGroupKey, i18nFormElementLabelKey, isDeletable, setDeletable, setGroup, setName, setUserProperty, toString

从类继承的方法 java.lang.Object

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

方法详细资料

addFormItem

public FormItem addFormItem(java.util.Locale locale,
                   User user,
                   java.lang.String usageIdentifyer,
                   boolean isAdministrativeUser,
                   FormItemContainer formItemContainer)

org.olat.presentation.framework.components.form.flexible.FormItemContainer)

参数:

locale - The current users locale

user - The user containing data to be prefilled or NULL if it should be left empty

usageIdentifyer - The identifyer of the form where this form element is used

isAdministrativeUser - true: Form element will be set to administrative mode. false: the element is set to user mode. In some cases the field is then read-only

formItemContainer - Container to which Form Item has to be added

返回:

The formItem will be added to formItemContainer

getFormElement

public FormElement getFormElement(java.util.Locale locale,
                         User user,
                         java.lang.String usageIdentifyer,
                         boolean isAdministrativeUser)

从接口复制的说明: UserPropertyHandler

Create a (non-flexi) form element for this UserPropertyHandler. The usageIdentifyer indicates in which form the element is to be used.

参数:

locale - The current users locale

user - The user containing data to be prefilled or NULL if it should be left empty

usageIdentifyer - The identifyer of the form where this form element is used

isAdministrativeUser - true: Form element will be set to administrative mode. false: the element is set to user mode. In some cases the field is then read-only

返回:

The form element or NULL if in this context the element is not displayed

getStringValue

public java.lang.String getStringValue(FormElement ui)

从接口复制的说明: UserPropertyHandler

Get the value from this form element formatted as string. The returned value is formatted in a way it can be stored in the database, thus it might not be the right value to display to a user.

返回:

getStringValue

public java.lang.String getStringValue(FormItem formItem)

从接口复制的说明: UserPropertyHandler

Get the value from this form item formatted as string. The returned value is formatted in a way it can be stored in the database, thus it might not be the right value to display to a user.

返回:

getStringValue

public java.lang.String getStringValue(java.lang.String displayValue,
                              java.util.Locale locale)

从接口复制的说明: UserPropertyHandler

Get the value from this GUI formatted string The returned value is formatted in a way it can be stored in the database, thus it might not be the right value to display to a user.

locale - The locale to be used to parse the display value

返回:

isValid

public boolean isValid(FormElement ui,
              java.util.Map formContext)

从接口复制的说明: UserPropertyHandler

Check if this form is valid

参数:

ui - The form element previously created with the getFormElement method

formContext - Map containing some variables used in this form context, e.g. for cross form value checks. NULL to not use any form context variables

返回:

true: the entered value is ok; false: the entered value is not accepted (Validation error)

isValid

public boolean isValid(FormItem formItem,
              java.util.Map formContext)

从接口复制的说明: UserPropertyHandler

Checks if a form item for a property has a valid value and sets the appropriate error key if necessary. This is different from UserPropertyHandler.isValidValue(String, ValidationError, Locale) since it takes the value of the form item associated with this user property into account. Do all validations which depend on a form item here.

参数:

formItem - The flexi form item previously created with the addFormItem method

formContext - Map containing some variables used in this form context, e.g. for cross form value checks. NULL to not use any form context variables

返回:

true: the entered value is ok; false: the entered value is not accepted (Validation error)

isValidValue

public boolean isValidValue(java.lang.String value,
                   ValidationError validationError,
                   java.util.Locale locale)

从接口复制的说明: UserPropertyHandler

Checks if the given value is a valid value for this property (e.g. syntax checking). This is not connected to any form item, in contrast to UserPropertyHandler.isValid(FormItem, Map), so all validations which do not depend on a form item can be done here.

参数:

value - The value to be checked

validationError - Callback to get the error key in case of validation=false

返回:

true: value is valid, false: value is invalid. Check validationError to get the error message

updateFormElementFromUser

public void updateFormElementFromUser(FormElement ui,
                             User user)

从接口复制的说明: UserPropertyHandler

Put the current value from this UserPropertyHandler into the given form element

参数:

ui - The form element previously created with the getFormElement method

user - The user that contains the data

updateUserFromFormElement

public void updateUserFromFormElement(User user,
                             FormElement ui)

从接口复制的说明: UserPropertyHandler

Reads the value of the given form element and updates the user

参数:

user - The user to be updated

ui - The form element previously created with the getFormElement method

updateUserFromFormItem

public void updateUserFromFormItem(User user,
                          FormItem formItem)

从接口复制的说明: UserPropertyHandler

Reads the value of the given form item and updates the user

参数:

user - The user to be updated

formItem - The form item previously created with the addFormItem method