org.alfresco.web.bean.generator

Interface IComponentGenerator

All Known Implementing Classes:

AjaxTagPickerGenerator, AssociationGenerator, BaseComponentGenerator, CategorySelectorGenerator, CharsetSelectorGenerator, CheckboxGenerator, ChildAssociationGenerator, DatePickerGenerator, DateTimePickerGenerator, HeaderSeparatorGenerator, HtmlSeparatorGenerator, LabelGenerator, LabelSeparatorGenerator, LanguageSelectorGenerator, LinkGenerator, MimeTypeSelectorGenerator, MlContainerLanguageSelectorGenerator, MultilingualTextAreaGenerator, MultilingualTextFieldGenerator, SeparatorGenerator, SpaceIconPickerGenerator, StoreSelectorGenerator, TextAreaGenerator, TextFieldGenerator

public interface IComponentGenerator

Interface definition for objects that dynamically generate components.

Author:

gavinc

Method Summary

Modifier and Type	Method and Description
UIComponent	generate(FacesContext context, String id) Dynamically generates a component in a default state
UIComponent	generateAndAdd(FacesContext context, UIPropertySheet propertySheet, PropertySheetItem item) Dynamically generates a component for the given property sheet item.
boolean	isEnabledInEditMode(FacesContext context, UIComponent control, org.alfresco.service.cmr.dictionary.PropertyDefinition propDef) Determines whether the component will be enabled when rendered.

Method Detail

generate

UIComponent generate(FacesContext context,
                     String id)

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

generateAndAdd

UIComponent generateAndAdd(FacesContext context,
                           UIPropertySheet propertySheet,
                           PropertySheetItem item)

Dynamically generates a component for the given property sheet item. The generated component is also setup appropriately for it's model definition and added to the given property sheet.

Parameters:

context - FacesContext

propertySheet - The property sheet component

item - The wrappper component representing the item to generate, either a property, association or child association

Returns:

The component instance

isEnabledInEditMode

boolean isEnabledInEditMode(FacesContext context,
                            UIComponent control,
                            org.alfresco.service.cmr.dictionary.PropertyDefinition propDef)

Determines whether the component will be enabled when rendered.

Parameters:

context - FacesContext

control - The control being rendered

propDef - The definition of the property

Returns:

true if the component should be enabled