nl.coderight.jazz.form.field.selectable
Class SelectableField<V>

java.lang.Object
  nl.coderight.jazz.form.FormField<V>
      nl.coderight.jazz.form.FormControl<V>
          nl.coderight.jazz.form.field.scrollable.ScrollableField<V>
              nl.coderight.jazz.form.field.selectable.SelectableField<V>

Direct Known Subclasses:

ListSelectableField, TreeSelectableField

public abstract class SelectableField<V>
extends ScrollableField<V>

Base class for Selectable fields.

 - SelectField
 - ComboField
 - ListField
 - TableField
 - TreeField
 - TreeTableField
 - SpinnerField
 

Nested Class Summary

protected class

SelectableField.KeyTypeSearchListener

Nested classes/interfaces inherited from class nl.coderight.jazz.form.field.scrollable.ScrollableField

ScrollableField.ScrollBarCorner, ScrollableField.ScrollBarPolicy

Field Summary

Fields inherited from class nl.coderight.jazz.form.FormField

Config

Constructor Summary

SelectableField(String bindID, String selectID)

Method Summary

void	addFilter(Filter<V> filter)
protected abstract Comparator<V>	createSortComparator()
protected void	dispose() Use this to cleanup any resources.
protected boolean	filter(V value)
String	getBindID() Returns bindID.
protected List<Filter<V>>	getFilters()
abstract int	getIndex(V value)
abstract List<V>	getListOfValues()
String	getRelationID()
abstract int	getSelectedIndex()
String	getSelectID()
Color	getSelectionBackground()
int	getSelectionCount()
Color	getSelectionForeground()
Comparator<V>	getSortComparator()
String	getSortID()
SortOrder	getSortOrder()
V	getValue() Returns field value.
protected abstract V	getValue(int index)
abstract int	getValueCount()
boolean	isSortingEnabled()
abstract int	locationToIndex(Point point)
protected void	onChange()
protected void	onFilterChanged()
protected void	onFocusGained()
protected void	onPopup(Point point)
protected void	onSearchFinished()
protected void	onSearchProgress(int progress)
protected void	onSearchStart()
protected void	onSelect()
SearchResult<V>	search(SearchCriteria<V> criteria, SearchDirection direction)
SearchResult<V>	search(SearchCriteria<V> criteria, SearchDirection direction, int fromIndex)
SearchResult<V>	searchAll(SearchCriteria<V> criteria)
abstract void	setListOfValues(List<V> values)
void	setOnChangeEvent(Event onChangeEvent)
void	setOnSelectAction(Action onSelectAction)
void	setOnSelectCondition(SelectCondition<V> condition)
void	setOnSelectEvent(Event onSelectEvent)
void	setOnSelectGroup(ActionGroup onSelectGroup)
void	setRelationID(String relationID)
abstract void	setSelectedIndex(int index)
protected void	setSelectID(String selectID)
void	setSelectionBackground(Color selectionBackground)
void	setSelectionForeground(Color selectionForeground)
protected void	setSortComparator(Comparator<V> sortComparator)
protected void	setSortID(String sortID)
void	setSortingEnabled(boolean enabled)
protected void	setSortOrder(SortOrder sortOrder)
void	setValue(V value) Sets field value.
abstract void	sort(String sortID, SortOrder sortOrder)

Methods inherited from class nl.coderight.jazz.form.field.scrollable.ScrollableField

getComponent, getFocusComponent, getPreferredSize, getPreferredViewportSize, getViewportSize, isOpaque, isScrollable, onViewportChanged, setBackground, setBackgroundImage, setBorder, setColumnHeader, setComponent, setComponent, setCorner, setEnabled, setForeground, setOpaque, setPreferredSize, setRowHeader, setScrollable, setScrollBarPolicy, setTitle

Methods inherited from class nl.coderight.jazz.form.FormControl

addField, addField, focus, focusField, focusNextField, focusPreviousField, getFields, hasFocus, registerKeyboardAction, setLayout

Methods inherited from class nl.coderight.jazz.form.FormField

dispatchEvent, focusNextField, focusPreviousField, getBackground, getBorder, getCursor, getDataBinding, getForeground, getForm, getLabel, getParent, getToolTipText, isBindable, isChanged, isEnabled, isFocusable, isReadonly, isShowing, isValueChanged, isVisible, onClick, onDoubleClick, onFocusLost, onMouseEnter, onMouseLeave, setBindID, setChanged, setCursor, setDataBinding, setFocusable, setOnFocusGainedEvent, setOnFocusLostEvent, setPopupMenu, setReadonly, setToolTipText, setVisible, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectableField

public SelectableField(String bindID,
                       String selectID)

Method Detail

createSortComparator

protected abstract Comparator<V> createSortComparator()

getBindID

public final String getBindID()

Description copied from class: FormField

Returns bindID.

Overrides:

getBindID in class FormControl<V>

getSelectID

public final String getSelectID()

setSelectID

protected final void setSelectID(String selectID)

getRelationID

public final String getRelationID()

setRelationID

public final void setRelationID(String relationID)

getIndex

public abstract int getIndex(V value)

getValue

protected abstract V getValue(int index)

getValueCount

public abstract int getValueCount()

getListOfValues

public abstract List<V> getListOfValues()

setListOfValues

public abstract void setListOfValues(List<V> values)

getValue

public V getValue()

Description copied from class: FormField

Returns field value.

Overrides:

getValue in class FormField<V>

setValue

public void setValue(V value)

Description copied from class: FormField

Sets field value.

Overrides:

setValue in class FormField<V>

getSelectionCount

public int getSelectionCount()

getSelectedIndex

public abstract int getSelectedIndex()

setSelectedIndex

public abstract void setSelectedIndex(int index)

getSelectionBackground

public Color getSelectionBackground()

setSelectionBackground

public void setSelectionBackground(Color selectionBackground)

getSelectionForeground

public Color getSelectionForeground()

setSelectionForeground

public void setSelectionForeground(Color selectionForeground)

setOnChangeEvent

public void setOnChangeEvent(Event onChangeEvent)

Since:

1.3

setOnSelectEvent

public void setOnSelectEvent(Event onSelectEvent)

setOnSelectAction

public void setOnSelectAction(Action onSelectAction)

Since:

1.1

setOnSelectGroup

public void setOnSelectGroup(ActionGroup onSelectGroup)

Since:

1.3

setOnSelectCondition

public void setOnSelectCondition(SelectCondition<V> condition)

Since:

1.4

onSelect

protected void onSelect()

onChange

protected void onChange()

Overrides:

onChange in class FormField<V>

onFocusGained

protected void onFocusGained()

Overrides:

onFocusGained in class FormField<V>

locationToIndex

public abstract int locationToIndex(Point point)

onPopup

protected void onPopup(Point point)

Overrides:

onPopup in class FormField<V>

search

public SearchResult<V> search(SearchCriteria<V> criteria,
                              SearchDirection direction)

Since:

1.3

search

public SearchResult<V> search(SearchCriteria<V> criteria,
                              SearchDirection direction,
                              int fromIndex)

Since:

1.3

searchAll

public SearchResult<V> searchAll(SearchCriteria<V> criteria)

Since:

1.3

onSearchStart

protected void onSearchStart()

onSearchProgress

protected void onSearchProgress(int progress)

onSearchFinished

protected void onSearchFinished()

isSortingEnabled

public boolean isSortingEnabled()

setSortingEnabled

public void setSortingEnabled(boolean enabled)

sort

public abstract void sort(String sortID,
                          SortOrder sortOrder)

getSortID

public String getSortID()

setSortID

protected void setSortID(String sortID)

getSortOrder

public SortOrder getSortOrder()

setSortOrder

protected void setSortOrder(SortOrder sortOrder)

getSortComparator

public Comparator<V> getSortComparator()

setSortComparator

protected void setSortComparator(Comparator<V> sortComparator)

dispose

protected void dispose()

Description copied from class: FormField

Use this to cleanup any resources.

Overrides:

dispose in class FormField<V>

addFilter

public void addFilter(Filter<V> filter)

getFilters

protected List<Filter<V>> getFilters()

filter

protected boolean filter(V value)

onFilterChanged

protected void onFilterChanged()