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

java.lang.Object
  extended by nl.coderight.jazz.form.FormField<V>
      extended by nl.coderight.jazz.form.FormControl<V>
          extended by nl.coderight.jazz.form.field.scrollable.ScrollableField<V>
              extended by nl.coderight.jazz.form.field.selectable.SelectableField<V>
All Implemented Interfaces:
DataBindable<V>, DataSelectable<V>
Direct Known Subclasses:
ListSelectableField, TreeSelectableField

public abstract class SelectableField<V>
extends ScrollableField<V>
implements DataSelectable<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)
           
 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)
           
 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, getViewportSize, isOpaque, isScrollable, onViewportChanged, setBackground, setBackgroundImage, setBorder, setColumnHeader, 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, setComponent, setLayout
 
Methods inherited from class nl.coderight.jazz.form.FormField
dispatchEvent, focusNextField, focusPreviousField, getBackground, getBorder, getCursor, getDataBinding, getForeground, getForm, getLabel, getParent, getToolTip, isBindable, isChanged, isEnabled, isFocusable, isReadonly, isShowing, isValueChanged, isVisible, onClick, onDoubleClick, onFocusLost, onMouseEnter, onMouseLeave, setBindID, setChanged, setCursor, setDataBinding, setFocusable, setOnFocusGainedEvent, setOnFocusLostEvent, setPopupMenu, setReadonly, setToolTip, setVisible, translate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface nl.coderight.jazz.form.field.bindable.DataBindable
delete, getData, insert, isReadonly, setData, update
 

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.

Specified by:
getBindID in interface DataBindable<V>
Overrides:
getBindID in class FormControl<V>

getSelectID

public final String getSelectID()
Specified by:
getSelectID in interface DataSelectable<V>

setSelectID

protected final void setSelectID(String selectID)

getRelationID

public final String getRelationID()
Specified by:
getRelationID in interface DataSelectable<V>

setRelationID

public final void setRelationID(String relationID)

getValue

protected abstract V getValue(int index)

getValueCount

public abstract int getValueCount()

getIndex

public abstract int getIndex(V value)

getValue

public V getValue()
Description copied from class: FormField
Returns field value.

Specified by:
getValue in interface DataSelectable<V>
Overrides:
getValue in class FormField<V>

setValue

public void setValue(V value)
Description copied from class: FormField
Sets field value.

Specified by:
setValue in interface DataSelectable<V>
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)

setOnSelectEvent

public void setOnSelectEvent(Event onSelectEvent)

setOnSelectAction

public void setOnSelectAction(Action onSelectAction)

setOnSelectGroup

public void setOnSelectGroup(ActionGroup onSelectGroup)

setOnSelectCondition

public void setOnSelectCondition(SelectCondition<V> condition)

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)

search

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

searchAll

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

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()


Copyright 2010 CodeRight, All rights reserved.