info.magnolia.ui.form.field.factory

Class SelectFieldFactory<D extends SelectFieldDefinition>

java.lang.Object

info.magnolia.ui.form.AbstractFormItem

info.magnolia.ui.form.field.factory.AbstractFieldFactory<D,Object>

info.magnolia.ui.form.field.factory.SelectFieldFactory<D>

Type Parameters:

D - type of definition

All Implemented Interfaces:

FieldFactory, FormItem

Direct Known Subclasses:

NodeTypeSelectFieldFactory, OptionGroupFieldFactory, SystemLanguagesFieldFactory, TimeZoneFieldFactory, TwinColSelectFieldFactory

Deprecated.

since 6.2 - use AbstractSelectFieldFactory instead.

@Deprecated
public class SelectFieldFactory<D extends SelectFieldDefinition>
extends AbstractFieldFactory<D,Object>

Creates and initializes a selection field based on a field definition.

See Also:

Upgrading to Magnolia 6.2.x

Property Summary

Properties inherited from class info.magnolia.ui.form.field.factory.AbstractFieldFactory

initializeProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectFieldFactory.DefaultOptionComparator Deprecated. A null safe comparator based on the label.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.v7.ui.AbstractSelect	select Deprecated.

Fields inherited from class info.magnolia.ui.form.field.factory.AbstractFieldFactory

definition, field, item

Constructor Summary

Constructors

Constructor and Description
SelectFieldFactory(D definition, com.vaadin.v7.data.Item relatedFieldItem) Deprecated. since 5.4.7 - use SelectFieldFactory(SelectFieldDefinition, Item, UiContext, I18NAuthoringSupport) instead.
SelectFieldFactory(D definition, com.vaadin.v7.data.Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected Object	createDefaultValue(com.vaadin.v7.data.Property property) Deprecated. If value is null but single-select field mandates a non-null value, then pick the first value as default.
protected com.vaadin.v7.ui.AbstractSelect	createFieldComponent() Deprecated. Implemented by subclasses to create and initialize the Vaadin Field instance to use.
protected org.apache.jackrabbit.commons.predicate.Predicate	createRemoteOptionFilterPredicate() Deprecated.
protected com.vaadin.v7.ui.AbstractSelect	createSelectionField() Deprecated. Used to initialize the desired subclass of AbstractSelect field component.
protected Object	getConfiguredDefaultValue() Deprecated. Resolve the default value from configuration.
com.vaadin.server.Resource	getIconResource(SelectFieldOptionDefinition option) Deprecated. Default Implementation to retrieve an Icon.
List<SelectFieldOptionDefinition>	getOptions() Deprecated. Get the list of SelectFieldOptionDefinition.
protected String	getRemoteOptionsName(javax.jcr.Node option, String propertyName) Deprecated. Get the specific node property.
protected String	getRemoteOptionsValue(javax.jcr.Node option, String propertyName) Deprecated. Get the specific node property.
List<SelectFieldOptionDefinition>	getSelectFieldOptionDefinition() Deprecated.
protected Comparator<SelectFieldOptionDefinition>	initializeComparator(Class<? extends Comparator<SelectFieldOptionDefinition>> comparatorClass) Deprecated.

Methods inherited from class info.magnolia.ui.form.field.factory.AbstractFieldFactory

createField, createTypedValue, getComponentProvider, getDefaultFieldType, getDefinitionType, getFieldDefinition, getFieldType, getI18nBasename, getLocale, getView, initializeConverter, initializeProperty, initializeTransformer, isMessageKey, setComponentProvider, setFieldValidatorFactoryFactory, setI18nContentSupport, setLocale, setPropertyDataSourceAndDefaultValue, setPropertyDataSourceDefaultValue

Methods inherited from class info.magnolia.ui.form.AbstractFormItem

getMessage, getMessages, getParent, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.form.FormItem

getMessages, getParent, setParent

Field Detail

select

protected com.vaadin.v7.ui.AbstractSelect select

Deprecated.

Constructor Detail

SelectFieldFactory

@Inject
public SelectFieldFactory(D definition,
                                  com.vaadin.v7.data.Item relatedFieldItem,
                                  UiContext uiContext,
                                  I18NAuthoringSupport i18nAuthoringSupport)

Deprecated.

SelectFieldFactory

@Deprecated
public SelectFieldFactory(D definition,
                                      com.vaadin.v7.data.Item relatedFieldItem)

Deprecated. since 5.4.7 - use SelectFieldFactory(SelectFieldDefinition, Item, UiContext, I18NAuthoringSupport) instead.

Method Detail

createFieldComponent

protected com.vaadin.v7.ui.AbstractSelect createFieldComponent()

Deprecated.

Description copied from class: AbstractFieldFactory

Implemented by subclasses to create and initialize the Vaadin Field instance to use.

Specified by:

createFieldComponent in class AbstractFieldFactory<D extends SelectFieldDefinition,Object>

createSelectionField

protected com.vaadin.v7.ui.AbstractSelect createSelectionField()

Deprecated.

Used to initialize the desired subclass of AbstractSelect field component. Subclasses can override this method.

initializeComparator

protected Comparator<SelectFieldOptionDefinition> initializeComparator(Class<? extends Comparator<SelectFieldOptionDefinition>> comparatorClass)

Deprecated.

getOptions

public List<SelectFieldOptionDefinition> getOptions()

Deprecated.

Get the list of SelectFieldOptionDefinition. If there is an explicitly configured option list in the definition - use it. Else, if path is not empty, build an option list based on the node referred to the path and property value. Else, if nothing is defined, return an empty list. Default value and i18n of the Label is also part of the responsibility of this method.

getSelectFieldOptionDefinition

@Deprecated
public List<SelectFieldOptionDefinition> getSelectFieldOptionDefinition()

Deprecated.

Since:

5.4.9 renamed to getOptions()

getIconResource

public com.vaadin.server.Resource getIconResource(SelectFieldOptionDefinition option)

Deprecated.

Default Implementation to retrieve an Icon. Sub class should override this method in order to retrieve others Resource.

createDefaultValue

protected Object createDefaultValue(com.vaadin.v7.data.Property property)

Deprecated.

If value is null but single-select field mandates a non-null value, then pick the first value as default.

Overrides:

createDefaultValue in class AbstractFieldFactory<D extends SelectFieldDefinition,Object>

getConfiguredDefaultValue

protected Object getConfiguredDefaultValue()

Deprecated.

Description copied from class: AbstractFieldFactory

Resolve the default value from configuration.

Overrides:

getConfiguredDefaultValue in class AbstractFieldFactory<D extends SelectFieldDefinition,Object>

Returns:

the set of configured selected options if the field supports multi-selection, otherwise just the first occurrence of such configured selected option.

createRemoteOptionFilterPredicate

protected org.apache.jackrabbit.commons.predicate.Predicate createRemoteOptionFilterPredicate()

Deprecated.

Returns:

Predicate used to filter the remote children option nodes.

getRemoteOptionsName

protected String getRemoteOptionsName(javax.jcr.Node option,
                                      String propertyName)
                               throws javax.jcr.RepositoryException

Deprecated.

Get the specific node property.
If this property is not defined, return the node name. Expose this method in order to let subclass define their own implementation.

Throws:

javax.jcr.RepositoryException

getRemoteOptionsValue

protected String getRemoteOptionsValue(javax.jcr.Node option,
                                       String propertyName)
                                throws javax.jcr.RepositoryException

Deprecated.

Get the specific node property.
If this property is not defined, return the node name. Expose this method in order to let subclass define their own implementation.

Throws:

javax.jcr.RepositoryException