org.springframework.richclient.selection.binding
Class ListSelectionDialogBinder

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.form.binding.support.AbstractBinder
          org.springframework.richclient.selection.binding.ListSelectionDialogBinder

All Implemented Interfaces:

Binder

public class ListSelectionDialogBinder
extends AbstractBinder

Binder for SelectField.

The context can contain the following items:

• SELECTABLE_ITEMS_HOLDER_KEY: The ValueModel holding the collection of selectable items
• LABEL_PROVIDER_KEY: the label provider to provide the text of a given item
• FILTERED_KEY: boolean value indicating whether the selection dialog will contain a filter field. If this value is true and the filter properties are not given, the string representation of the item will be used as filter value.
• FILTER_PROPERTIES_KEY: array of properties that will be used for filtering
• RENDERER_KEY: custom ListCellRenderer that will be used in the selection dialog

Author:

Peter De Bruycker

Field Summary

static String	COMPARATOR_KEY
static String	DESCRIPTION_KEY_KEY
static String	FILTER_PROPERTIES_KEY
static String	FILTERED_KEY
static String	LABEL_PROVIDER_KEY
static String	NULLABLE_KEY
static String	RENDERER_KEY
static String	SELECTABLE_ITEMS_HOLDER_KEY
static String	TITLE_KEY_KEY

Fields inherited from class org.springframework.richclient.form.binding.support.AbstractBinder

BINDING_CLIENT_PROPERTY_KEY, log

Fields inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

logger

Constructor Summary

ListSelectionDialogBinder()

Method Summary

protected void	applyContext(ListSelectionDialogBinding binding, Map context)
protected JComponent	createControl(Map context)
protected Binding	doBind(JComponent notUsed, FormModel formModel, String formPropertyPath, Map context)
Boolean	isNullable() May return null if no value is set!
void	setComparator(Comparator comparator)
void	setDescriptionKey(String descriptionKey)
void	setFiltered(boolean filtered)
void	setFilterProperties(String[] filterProperties)
void	setLabelProvider(LabelProvider labelProvider)
void	setNullable(Boolean nullable)
void	setRenderer(ListCellRenderer renderer)
void	setSelectableItemsHolder(ValueModel selectableItemsHolder)
void	setTitleKey(String titleKey)

Methods inherited from class org.springframework.richclient.form.binding.support.AbstractBinder

bind, bind, getPropertyType, getRequiredSourceClass, validateContextKeys

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

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

Field Detail

SELECTABLE_ITEMS_HOLDER_KEY

public static final String SELECTABLE_ITEMS_HOLDER_KEY

See Also:

Constant Field Values

FILTER_PROPERTIES_KEY

public static final String FILTER_PROPERTIES_KEY

See Also:

Constant Field Values

FILTERED_KEY

public static final String FILTERED_KEY

See Also:

Constant Field Values

RENDERER_KEY

public static final String RENDERER_KEY

See Also:

Constant Field Values

COMPARATOR_KEY

public static final String COMPARATOR_KEY

See Also:

Constant Field Values

LABEL_PROVIDER_KEY

public static final String LABEL_PROVIDER_KEY

See Also:

Constant Field Values

DESCRIPTION_KEY_KEY

public static final String DESCRIPTION_KEY_KEY

See Also:

Constant Field Values

TITLE_KEY_KEY

public static final String TITLE_KEY_KEY

See Also:

Constant Field Values

NULLABLE_KEY

public static final String NULLABLE_KEY

See Also:

Constant Field Values

Constructor Detail

ListSelectionDialogBinder

public ListSelectionDialogBinder()

Method Detail

createControl

protected JComponent createControl(Map context)

Specified by:

createControl in class AbstractBinder

applyContext

protected void applyContext(ListSelectionDialogBinding binding,
                            Map context)

doBind

protected Binding doBind(JComponent notUsed,
                         FormModel formModel,
                         String formPropertyPath,
                         Map context)

Specified by:

doBind in class AbstractBinder

setSelectableItemsHolder

public void setSelectableItemsHolder(ValueModel selectableItemsHolder)

setFilterProperties

public void setFilterProperties(String[] filterProperties)

setFiltered

public void setFiltered(boolean filtered)

setRenderer

public void setRenderer(ListCellRenderer renderer)

setLabelProvider

public void setLabelProvider(LabelProvider labelProvider)

setComparator

public void setComparator(Comparator comparator)

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

setTitleKey

public void setTitleKey(String titleKey)

isNullable

public Boolean isNullable()

May return null if no value is set!

Returns:

whether the field shall be nullable

setNullable

public void setNullable(Boolean nullable)