public abstract class ListOfValuesModel extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ListOfValuesModel.ListType |
Constructor and Description |
---|
ListOfValuesModel() |
Modifier and Type | Method and Description |
---|---|
abstract List<Object> |
autoCompleteValue(Object value)
Called by the framework during Apply Request values phase.
This method is called only when autoSubmit is set to true on the component and user either presses enter key or tab key on the input field. |
List<ColumnDescriptor> |
getItemDescriptors()
Return a list of columns that should be displayed in the drop down.
|
abstract List<? extends Object> |
getItems()
Returns a list of items used within the searchable list in an inputComboxListOfValues.
|
ListOfValuesModel.ListType |
getListType()
Returns the type of list configured for the LOV component.
|
abstract QueryDescriptor |
getQueryDescriptor()
Gets a QueryDescriptor required to render the criteria part of a query component.
|
abstract QueryModel |
getQueryModel()
Returns a QueryModel required by a query component.
|
abstract List<? extends Object> |
getRecentItems()
Returns a list of recently selected items (or MRU items) used within the searchable list in an inputComboxListOfValues
|
abstract TableModel |
getTableModel()
Returns a TableModel object that is in turn used to retrieve a CollectionModel which supplies a list of values to select from.
|
Object |
getValueFromSelection(Object selectedRow)
This method is called during the Apply Request Values phase, to get the value associated with the selectedRow in the list of values.
Returns the value (for the LOV component) given the selectedRow, where the selectedRow is either - a List< Object> of size 1, where Object belongs to list returned by the call to getItems() (or getRecentItems()) or, - a RowKeySet, containing the rowKeys of the selected rows belonging to the getTableModel().getCollectionModel(). |
abstract boolean |
isAutoCompleteEnabled()
Whether the autoComplete feature is enabled for the LOV component.
|
abstract void |
performQuery(QueryDescriptor qd)
Called when a query is to be performed on a QueryDescriptor.
|
void |
searchCancelled()
This method is called by the framework after the search window is cancelled and the control is returned to the form.
|
abstract void |
valueSelected(Object value)
This method is called by the framework at the end of the Invoke Application phase, to set parameter 'value' as the selected value in the list.
|
public abstract QueryDescriptor getQueryDescriptor()
public abstract QueryModel getQueryModel()
public abstract TableModel getTableModel()
public abstract List<? extends Object> getItems()
getRecentItems()
public abstract List<? extends Object> getRecentItems()
public abstract boolean isAutoCompleteEnabled()
public abstract void performQuery(QueryDescriptor qd)
qd
- the QueryDescriptor for which the query is to be performed.public abstract List<Object> autoCompleteValue(Object value)
value
- the user entered value in the input fieldpublic abstract void valueSelected(Object value)
value
- the value can be - a List< Object> of size 1, where Object belongs to list returned by the call to getItems() (or getRecentItems()) or,public Object getValueFromSelection(Object selectedRow)
This method simply returns the value without pushing the selected value into the model. To indicate that a row has been selected, the method valueSelected() will be called.
NOTE: Only single selections are supported at this point.
selectedRow
-public List<ColumnDescriptor> getItemDescriptors()
public void searchCancelled()
public ListOfValuesModel.ListType getListType()