xal.extension.widgets.swing

Class KeyValueRecordSelector<RecordType>

java.lang.Object

xal.extension.widgets.swing.KeyValueRecordSelector<RecordType>

Direct Known Subclasses:

NodeChannelSelector

public class KeyValueRecordSelector<RecordType>
extends java.lang.Object

display a dialog that allows users to select records from a table

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyValueRecordSelector(KeyValueFilteredTableModel<RecordType> tableModel, javax.swing.JFrame owner, java.lang.String title) Constructor with default filter prompt
protected	KeyValueRecordSelector(KeyValueFilteredTableModel<RecordType> tableModel, javax.swing.JFrame owner, java.lang.String title, java.lang.String filterPrompt) Primary Constructor

Method Summary

Modifier and Type	Method and Description
static <RecordType> KeyValueRecordSelector<RecordType>	getInstance(KeyValueFilteredTableModel<RecordType> tableModel, javax.swing.JFrame owner, java.lang.String title) Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.
static <RecordType> KeyValueRecordSelector<RecordType>	getInstance(java.util.List<RecordType> records, javax.swing.JFrame owner, java.lang.String title, java.lang.String... keyPaths) Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.
static <RecordType> KeyValueRecordSelector<RecordType>	getInstanceWithFilterPrompt(KeyValueFilteredTableModel<RecordType> tableModel, javax.swing.JFrame owner, java.lang.String title, java.lang.String filterPrompt) Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.
static <RecordType> KeyValueRecordSelector<RecordType>	getInstanceWithFilterPrompt(java.util.List<RecordType> records, javax.swing.JFrame owner, java.lang.String title, java.lang.String filterPrompt, java.lang.String... keyPaths) Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.
javax.swing.JTable	getRecordTable() get the table which displays the records from which to select
KeyValueFilteredTableModel<RecordType>	getRecordTableModel() get the table model for displaying the records
protected java.util.List<RecordType>	getSelectedRecords() get the list of selected records
java.util.List<RecordType>	showDialog() Show the dialog with arbitrary record selection allowed and return a list of selected records.
java.util.List<RecordType>	showDialog(int selectionMode) Show the dialog with the specified record selection mode and return a list of selected records.
RecordType	showSingleSelectionDialog() Show the dialog with single record selection allowed and return the selected record if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueRecordSelector

protected KeyValueRecordSelector(KeyValueFilteredTableModel<RecordType> tableModel,
                                 javax.swing.JFrame owner,
                                 java.lang.String title,
                                 java.lang.String filterPrompt)

Primary Constructor

KeyValueRecordSelector

protected KeyValueRecordSelector(KeyValueFilteredTableModel<RecordType> tableModel,
                                 javax.swing.JFrame owner,
                                 java.lang.String title)

Constructor with default filter prompt

Method Detail

getInstance

public static <RecordType> KeyValueRecordSelector<RecordType> getInstance(KeyValueFilteredTableModel<RecordType> tableModel,
                                                                          javax.swing.JFrame owner,
                                                                          java.lang.String title)

Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.

Parameters:

tableModel - table model supplying the records to display

owner - the window that owns the dialog window

title - the title of the dialog window

getInstance

public static <RecordType> KeyValueRecordSelector<RecordType> getInstance(java.util.List<RecordType> records,
                                                                          javax.swing.JFrame owner,
                                                                          java.lang.String title,
                                                                          java.lang.String... keyPaths)

Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.

Parameters:

records - the objects of the specified types to list for selection

owner - the window that owns the dialog window

title - the title of the dialog window

keyPaths - are the key paths applied to each record to supply the table's column data

getInstanceWithFilterPrompt

public static <RecordType> KeyValueRecordSelector<RecordType> getInstanceWithFilterPrompt(KeyValueFilteredTableModel<RecordType> tableModel,
                                                                                          javax.swing.JFrame owner,
                                                                                          java.lang.String title,
                                                                                          java.lang.String filterPrompt)

Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.

Parameters:

tableModel - table model supplying the records to display

owner - the window that owns the dialog window

title - the title of the dialog window

filterPrompt - the prompt to appear as a placeholder in the filter field

getInstanceWithFilterPrompt

public static <RecordType> KeyValueRecordSelector<RecordType> getInstanceWithFilterPrompt(java.util.List<RecordType> records,
                                                                                          javax.swing.JFrame owner,
                                                                                          java.lang.String title,
                                                                                          java.lang.String filterPrompt,
                                                                                          java.lang.String... keyPaths)

Get an instance of a record selector for allowing users to select records (of the specified type) from a list in a table.

Parameters:

records - the objects of the specified types to list for selection

owner - the window that owns the dialog window

title - the title of the dialog window

filterPrompt - the prompt to appear as a placeholder in the filter field

keyPaths - are the key paths applied to each record to supply the table's column data

getRecordTable

public javax.swing.JTable getRecordTable()

get the table which displays the records from which to select

getRecordTableModel

public KeyValueFilteredTableModel<RecordType> getRecordTableModel()

get the table model for displaying the records

showSingleSelectionDialog

public RecordType showSingleSelectionDialog()

Show the dialog with single record selection allowed and return the selected record if any.

Returns:

the selected record or null if no record was selected or the dialog was canceled

showDialog

public java.util.List<RecordType> showDialog()

Show the dialog with arbitrary record selection allowed and return a list of selected records.

Returns:

the selected records or null if the dialog was canceled

showDialog

public java.util.List<RecordType> showDialog(int selectionMode)

Show the dialog with the specified record selection mode and return a list of selected records.

Parameters:

selectionMode - record selection mode: ListSelectionModel.SINGLE_SELECTION, ListSelectionModel.SINGLE_INTERVAL_SELECTION or ListSelectionModel.MULTIPLE_INTERVAL_SELECTION

Returns:

the selected records or null if the dialog was canceled

getSelectedRecords

protected java.util.List<RecordType> getSelectedRecords()

get the list of selected records