info.magnolia.ui.admincentral.field.builder
Class SelectFieldBuilder<D extends info.magnolia.ui.model.field.definition.SelectFieldDefinition>
java.lang.Object
info.magnolia.ui.admincentral.form.AbstractFormItem
info.magnolia.ui.admincentral.field.builder.AbstractFieldBuilder<D,Object>
info.magnolia.ui.admincentral.field.builder.SelectFieldBuilder<D>
- Type Parameters:
D
- type of definition
- All Implemented Interfaces:
- FieldBuilder, FormItem
- Direct Known Subclasses:
- OptionGroupFieldBuilder, TwinColSelectFieldBuilder
public class SelectFieldBuilder<D extends info.magnolia.ui.model.field.definition.SelectFieldDefinition>
- extends AbstractFieldBuilder<D,Object>
Creates and initializes a selection field based on a field definition.
Field Summary |
protected com.vaadin.ui.AbstractSelect |
select
|
Method Summary |
protected com.vaadin.ui.AbstractSelect |
buildField()
Implemented by subclasses to create and initialize the Vaadin Field instance to use. |
protected com.vaadin.ui.AbstractSelect |
createSelectionField()
Used to initialize the desired subclass of AbstractSelect field component. |
com.vaadin.server.Resource |
getIconResource(info.magnolia.ui.model.field.definition.SelectFieldOptionDefinition option)
Default Implementation to retrieve an Icon. |
List<info.magnolia.ui.model.field.definition.SelectFieldOptionDefinition> |
getSelectFieldOptionDefinition()
Get the list of SelectFieldOptionDefinition. |
void |
setPropertyDataSource(com.vaadin.data.Property dataSource)
Set the selected item if the DataSource is not empty. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
select
protected com.vaadin.ui.AbstractSelect select
SelectFieldBuilder
public SelectFieldBuilder(D definition,
com.vaadin.data.Item relatedFieldItem)
buildField
protected com.vaadin.ui.AbstractSelect buildField()
- Description copied from class:
AbstractFieldBuilder
- Implemented by subclasses to create and initialize the Vaadin Field instance to use.
- Specified by:
buildField
in class AbstractFieldBuilder<D extends info.magnolia.ui.model.field.definition.SelectFieldDefinition,Object>
createSelectionField
protected com.vaadin.ui.AbstractSelect createSelectionField()
- Used to initialize the desired subclass of AbstractSelect field component. Subclasses can override this method.
getSelectFieldOptionDefinition
public List<info.magnolia.ui.model.field.definition.SelectFieldOptionDefinition> getSelectFieldOptionDefinition()
- Get the list of SelectFieldOptionDefinition.
If options is not empty, took the options defined in this field definition.
Else, if path is not empty, build an options list based on the node refereed by
the path and property value.
Else nothing is define, return an empty option.
Default value and i18n of the Label is also part of the responsibility of this method.
getIconResource
public com.vaadin.server.Resource getIconResource(info.magnolia.ui.model.field.definition.SelectFieldOptionDefinition option)
- Default Implementation to retrieve an Icon.
Sub class should override this method in order to retrieve
others Resource.
setPropertyDataSource
public void setPropertyDataSource(com.vaadin.data.Property dataSource)
- Set the selected item if the DataSource is not empty.
- Overrides:
setPropertyDataSource
in class AbstractFieldBuilder<D extends info.magnolia.ui.model.field.definition.SelectFieldDefinition,Object>
Copyright © 2013 Magnolia International Ltd.. All Rights Reserved.