org.olat.core.gui.components.form.flexible.elements
Interface IntegerElement

All Superinterfaces:

FormBaseComponentIdProvider, FormItem, TextElement

All Known Subinterfaces:

InlineIntegerElement

All Known Implementing Classes:

IntegerElementImpl

public interface IntegerElement
extends TextElement

Description:
TODO: patrickb Class Description for IntegerElement

Initial Date: 22.06.2007

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

int	getIntValue()
void	setIntValue(int value) set the int value.
void	setIntValueCheck(java.lang.String errorKey) Implementors note: an integer element implementation has to provide a generic int value check anyway with a generic "must be a number" error message.
void	setIsEqualCheck(int otherValue, java.lang.String errorKey)
void	setMaxValueCheck(int maxValue, java.lang.String errorKey) The value must be less or equal to maxValue
void	setMinValueCheck(int minValue, java.lang.String errorKey) The value must be bigger or equal minValue.

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

getValue, getValue, isEmpty, isEmpty, setDisplaySize, setIsEqualCheck, setItemValidatorProvider, setMaxLength, setNewOriginalValue, setNotEmptyCheck, setNotLongerThanCheck, setRegexMatchCheck, setValue

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, setRootForm, setTranslator, setUserObject, setVisible, showError, showExample, showLabel, validate

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

getFormDispatchId

Method Detail

getIntValue

int getIntValue()

Returns:

int value validated by element

setIntValue

void setIntValue(int value)

set the int value.

Parameters:

value -

setIntValueCheck

void setIntValueCheck(java.lang.String errorKey)

Implementors note: an integer element implementation has to provide a generic int value check anyway with a generic "must be a number" error message. But the user of an int element can provide its own error key.

Parameters:

errorKey -

setIsEqualCheck

void setIsEqualCheck(int otherValue,
                     java.lang.String errorKey)

Parameters:

otherValue -

errorKey -

setMinValueCheck

void setMinValueCheck(int minValue,
                      java.lang.String errorKey)

The value must be bigger or equal minValue.

Parameters:

minValue -

errorKey -

setMaxValueCheck

void setMaxValueCheck(int maxValue,
                      java.lang.String errorKey)

The value must be less or equal to maxValue

Parameters:

maxValue -

errorKey -