Package org.exoplatform.webui.form

Class UIFormInputBase<T>

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIContainer

org.exoplatform.webui.form.UIFormInputBase<T>

All Implemented Interfaces:

UIFormInput<T>

Direct Known Subclasses:

UICheckBoxInput, UIFormCheckBoxInput, UIFormColorPicker, UIFormComboBox, UIFormDateTimeInput, UIFormHiddenInput, UIFormInputIconSelector, UIFormInputInfo, UIFormInputItemSelector, UIFormRadioBoxInput, UIFormStringInput, UIFormTextAreaInput, UIFormUploadInput, UIFormWYSIWYGInput, UIUploadInput

public abstract class UIFormInputBase<T>
extends UIContainer
implements UIFormInput<T>

Created by The eXo Platform SARL Author : Tuan Nguyen tuan08@users.sourceforge.net Jun 6, 2006 The base class to create form elements. Extend it to create your own elements.

Nested Class Summary

Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer

UIContainer.SelectTabActionListener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bindingField
protected T	defaultValue_	A default value for this field
static final boolean	DISABLE	Deprecated. According to deprecation of the setEditable(boolean) and setEnable(boolean) methods
protected boolean	disabled	Whether this field is disabled.
static final boolean	ENABLE	Deprecated. According to deprecation of the setEditable(boolean) and setEnable(boolean) methods
protected boolean	enable_	Deprecated. According to the deprecation of the setEnable(boolean) method Whether this field is enabled
protected String	name	The HTML 'name' attribute of this element
protected boolean	readonly_	Whether this field is in read only mode
protected Class<? extends T>	typeValue_	The type of value that is expected
protected List<Validator>	validators	The list of validators for this form element
protected T	value_	The current value of this field

Fields inherited from class org.exoplatform.webui.core.UIComponent

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent, USE_WEBUI_RESOURCES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UIFormInputBase()
	UIFormInputBase(String name, String bindingField, Class<T> typeValue)

Method Summary

Modifier and Type	Method	Description
<E extends Validator> UIFormInputBase<T>	addValidator(Class<E> clazz, Object... params)
abstract void	decode(Object input, WebuiRequestContext context)
String	getBindingField()
T	getDefaultValue()
String	getHTMLAttribute(String name)
String	getLabel()
String	getName()
Class<? extends T>	getTypeValue()
List<Validator>	getValidators()
T	getValue()
boolean	isDisabled()	Return true if this input field is disabled.
boolean	isEditable()	Deprecated. Use isReadOnly() instead
boolean	isEnable()	Deprecated. Use isDisabled() instead
boolean	isMandatory()
boolean	isReadOnly()	Return true if this input field is read only.
boolean	isValid()
final void	processDecode(WebuiRequestContext context)
protected void	renderHTMLAttributes(Writer w)
void	reset()
void	setBindingField(String s)
void	setDefaultValue(T defaultValue)
UIFormInputBase<T>	setDisabled(boolean disabled)	Specifies that this input field should be disabled OR NOT.
UIFormInputBase<T>	setEditable(boolean editable)	Deprecated. Use setReadOnly(boolean) instead
UIFormInputBase<T>	setEnable(boolean enable)	Deprecated. Use setDisabled(boolean) instead
void	setHTMLAttribute(String name, String value)
void	setLabel(String label)
void	setName(String name)
UIFormInputBase<T>	setReadOnly(boolean readonly)	Specifies that this input field should be read-only OR NOT.
UIFormInput<T>	setValue(T value)

Methods inherited from class org.exoplatform.webui.core.UIContainer

addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypes

Methods inherited from class org.exoplatform.webui.core.UIComponent

broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, event, event, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getParent, getTemplate, getTemplateResourceResolver, getUIComponentName, isRendered, loadConfirmMesssage, processAction, processRender, renderEventURL, setComponentConfig, setComponentConfig, setId, setParent, setRendered, setRenderSibling, url, url, url

Methods inherited from class java.lang.Object

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

Field Details

ENABLE

@Deprecated
public static final boolean ENABLE

Deprecated.

According to deprecation of the setEditable(boolean) and setEnable(boolean) methods

See Also:

• Constant Field Values

DISABLE

@Deprecated
public static final boolean DISABLE

Deprecated.

According to deprecation of the setEditable(boolean) and setEnable(boolean) methods

See Also:

• Constant Field Values

name

protected String name

The HTML 'name' attribute of this element

bindingField

protected String bindingField

validators

protected List<Validator> validators

The list of validators for this form element

defaultValue_

protected T defaultValue_

A default value for this field

value_

protected T value_

The current value of this field

typeValue_

protected Class<? extends T> typeValue_

The type of value that is expected

enable_

@Deprecated
protected boolean enable_

Deprecated.

According to the deprecation of the setEnable(boolean) method Whether this field is enabled

disabled

protected boolean disabled

Whether this field is disabled.

readonly_

protected boolean readonly_

Whether this field is in read only mode

Constructor Details

UIFormInputBase

public UIFormInputBase(String name,
 String bindingField,
 Class<T> typeValue)

UIFormInputBase

protected UIFormInputBase()

Method Details

getName

public String getName()

Specified by:

getName in interface UIFormInput<T>

Overrides:

getName in class UIComponent

setName

public void setName(String name)

getBindingField

public String getBindingField()

Specified by:

getBindingField in interface UIFormInput<T>

setBindingField

public void setBindingField(String s)

getDefaultValue

public T getDefaultValue()

setDefaultValue

public void setDefaultValue(T defaultValue)

getValue

public T getValue()

Specified by:

getValue in interface UIFormInput<T>

setValue

public UIFormInput<T> setValue(T value)

Specified by:

setValue in interface UIFormInput<T>

getTypeValue

public Class<? extends T> getTypeValue()

Specified by:

getTypeValue in interface UIFormInput<T>

reset

public void reset()

Specified by:

reset in interface UIFormInput<T>

isEnable

@Deprecated
public boolean isEnable()

Deprecated.

Use isDisabled() instead

Returns:

setEnable

@Deprecated
public UIFormInputBase<T> setEnable(boolean enable)

Deprecated.

Use setDisabled(boolean) instead

Parameters:

enable -

Returns:

isDisabled

public boolean isDisabled()

Return true if this input field is disabled. Otherwise, return false.

Returns:

True if this input field is disabled. Otherwise, return false.

setDisabled

public UIFormInputBase<T> setDisabled(boolean disabled)

Specifies that this input field should be disabled OR NOT.

Parameters:

disabled -

Returns:

isEditable

@Deprecated
public boolean isEditable()

Deprecated.

Use isReadOnly() instead

Returns:

True if the input is read only. Otherwise, return false.

setEditable

@Deprecated
public UIFormInputBase<T> setEditable(boolean editable)

Deprecated.

Use setReadOnly(boolean) instead

Parameters:

editable -

Returns:

isReadOnly

public boolean isReadOnly()

Return true if this input field is read only. Otherwise, return false.

Returns:

True if the input is read only. Otherwise, return false.

setReadOnly

public UIFormInputBase<T> setReadOnly(boolean readonly)

Specifies that this input field should be read-only OR NOT.

Parameters:

readonly -

Returns:

isValid

public boolean isValid()

addValidator

public <E extends Validator> UIFormInputBase<T> addValidator(Class<E> clazz,
 Object... params)
                                                      throws Exception

Specified by:

addValidator in interface UIFormInput<T>

Throws:

Exception

getValidators

public List<Validator> getValidators()

Specified by:

getValidators in interface UIFormInput<T>

processDecode

public final void processDecode(WebuiRequestContext context)
                         throws Exception

Overrides:

processDecode in class UIComponent

Throws:

Exception

isMandatory

public boolean isMandatory()

decode

public abstract void decode(Object input,
 WebuiRequestContext context)

getLabel

public String getLabel()

Specified by:

getLabel in interface UIFormInput<T>

setLabel

public void setLabel(String label)

getHTMLAttribute

public String getHTMLAttribute(String name)

setHTMLAttribute

public void setHTMLAttribute(String name,
 String value)

renderHTMLAttributes

protected void renderHTMLAttributes(Writer w)
                             throws IOException

Throws:

IOException