org.alfresco.web.bean.generator

Class TextFieldGenerator

java.lang.Object

org.alfresco.web.bean.generator.BaseComponentGenerator

org.alfresco.web.bean.generator.TextFieldGenerator

All Implemented Interfaces:

IComponentGenerator

Direct Known Subclasses:

MultilingualTextFieldGenerator, TextAreaGenerator

public class TextFieldGenerator
extends BaseComponentGenerator

Generates a text field component.

Author:

gavinc

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.web.bean.generator.BaseComponentGenerator

BaseComponentGenerator.ControlType

Field Summary

Fields inherited from class org.alfresco.web.bean.generator.BaseComponentGenerator

dataDictionary

Constructor Summary

Constructors

Constructor and Description
TextFieldGenerator()

Method Summary

Modifier and Type	Method and Description
protected UIComponent	createComponent(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item) Creates the component for the given proerty sheet item.
UIComponent	generate(FacesContext context, String id) Dynamically generates a component in a default state
protected org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint	getListOfValuesConstraint(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item) Retrieves the list of values constraint for the item, if it has one
int	getMaxLength()
int	getSize()
void	setMaxLength(int maxLength)
void	setSize(int size)
protected void	setupConstraints(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem property, org.alfresco.service.cmr.dictionary.PropertyDefinition propertyDef, UIComponent component) Sets up client validation rules for any constraints the property has.
protected void	setupConverter(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem property, org.alfresco.service.cmr.dictionary.PropertyDefinition propertyDef, UIComponent component) Sets up the appropriate converter for the given property
protected void	setupMandatoryValidation(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item, UIComponent component, boolean realTimeChecking, String idSuffix) Sets up a client mandatory validation rule with the property sheet for the given item.

Methods inherited from class org.alfresco.web.bean.generator.BaseComponentGenerator

addStringConstraintParam, createAndSetConverter, createOutputTextComponent, generateAndAdd, getAssociationDefinition, getControlType, getPropertyDefinition, isEnabledInEditMode, setupAssociation, setupConverter, setupMandatoryAssociationIfNecessary, setupMandatoryMarker, setupMandatoryPropertyIfNecessary, setupMultiValuePropertyIfNecessary, setupNumericRangeConstraint, setupProperty, setupRegexConstraint, setupStringLengthConstraint

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldGenerator

public TextFieldGenerator()

Method Detail

getSize

public int getSize()

Returns:

Returns the default size for a text field

setSize

public void setSize(int size)

Parameters:

size - Sets the size of a text field

getMaxLength

public int getMaxLength()

Returns:

Returns the max length for the text field

setMaxLength

public void setMaxLength(int maxLength)

Parameters:

maxLength - Sets the max length of the text field

generate

public UIComponent generate(FacesContext context,
                            String id)

Description copied from interface: IComponentGenerator

Dynamically generates a component in a default state

Parameters:

context - FacesContext

id - Optional id for the newly created component, if null is passed a unique id is generated

Returns:

The component instance

createComponent

protected UIComponent createComponent(FacesContext context,
                                      UIPropertySheet propertySheet,
                                      PropertySheetItem item)

Description copied from class: BaseComponentGenerator

Creates the component for the given proerty sheet item.

Overrides:

createComponent in class BaseComponentGenerator

Parameters:

context - FacesContext

propertySheet - The property sheet being generated

item - The property or association being generated

Returns:

The newly created component

setupMandatoryValidation

protected void setupMandatoryValidation(FacesContext context,
                                        UIPropertySheet propertySheet,
                                        PropertySheetItem item,
                                        UIComponent component,
                                        boolean realTimeChecking,
                                        String idSuffix)

Description copied from class: BaseComponentGenerator

Sets up a client mandatory validation rule with the property sheet for the given item.

Overrides:

setupMandatoryValidation in class BaseComponentGenerator

Parameters:

context - FacesContext

propertySheet - The property sheet to add the validation rule to

item - The item being generated

component - The component representing the item

realTimeChecking - true to make the client validate as the user types

idSuffix - An optional suffix to add to the client id

setupConstraints

protected void setupConstraints(FacesContext context,
                                UIPropertySheet propertySheet,
                                PropertySheetItem property,
                                org.alfresco.service.cmr.dictionary.PropertyDefinition propertyDef,
                                UIComponent component)

Description copied from class: BaseComponentGenerator

Sets up client validation rules for any constraints the property has.

Overrides:

setupConstraints in class BaseComponentGenerator

Parameters:

context - FacesContext propertySheet The property sheet being generated

property - The property being generated

propertyDef - The data dictionary definition of the property

component - The component representing the property

getListOfValuesConstraint

protected org.alfresco.repo.dictionary.constraint.ListOfValuesConstraint getListOfValuesConstraint(FacesContext context,
                                                                                                   UIPropertySheet propertySheet,
                                                                                                   PropertySheetItem item)

Retrieves the list of values constraint for the item, if it has one

Parameters:

context - FacesContext

propertySheet - The property sheet being generated

item - The item being generated

Returns:

The constraint if the item has one, null otherwise

setupConverter

protected void setupConverter(FacesContext context,
                              UIPropertySheet propertySheet,
                              PropertySheetItem property,
                              org.alfresco.service.cmr.dictionary.PropertyDefinition propertyDef,
                              UIComponent component)

Description copied from class: BaseComponentGenerator

Sets up the appropriate converter for the given property

Overrides:

setupConverter in class BaseComponentGenerator

Parameters:

context - FacesContext

propertySheet - The property sheet being generated

property - The property being generated

propertyDef - The data dictionary definition of the property

component - The component representing the property