oracle.javatools.ui.builders

Interface BuiltList<T>

public interface BuiltList<T>

An object containing a JList and surrounding support components e.g. JScrollPane and ReorderableBar. These components are retrieved via getGUI()

A BuiltList is built by a ListBuilder.

T is the type of objects in the list.

Method Summary

Modifier and Type	Method and Description
ComponentWithTitlebar	getComponentWithTitlebar() The component can be optionally contained in a ComponentWithTitlebar
TextLayer	getEmptyTextLayer()
javax.swing.JComponent	getGUI()
javax.swing.JList	getJList()
java.util.List<T>	getListModel() Return the model used in the JList as a java.util.List.
javax.swing.JScrollPane	getScrollPane()
T	getSelectedValue()
java.util.List<T>	getSelectedValues()
void	setEnabled(boolean enabled) Enable or disable all components in the BuiltList

Method Detail

getJList

javax.swing.JList getJList()

Returns:

a reference to the list contained within the BuiltList. Do not add the list directly to a container, instead add the component returned by getGUI()

getListModel

java.util.List<T> getListModel()

Return the model used in the JList as a java.util.List. The returned list is 'live', meaning that it represents the current set of items in the on screen list and in the visible order. Also later changes to this returned list will result in changes to the contents of the JList on screen.

Returns:

a List which is effectively the model used in the JList

setEnabled

void setEnabled(boolean enabled)

Enable or disable all components in the BuiltList

Parameters:

enabled -

getScrollPane

javax.swing.JScrollPane getScrollPane()

Returns:

the scrollpane used within the BuiltBasic. Do not add the scrollpane directly to a container, instead add the component returned by getGUI()

getGUI

javax.swing.JComponent getGUI()

Returns:

the main component containing all of the ui to add to a container.

getEmptyTextLayer

TextLayer getEmptyTextLayer()

Returns:

the TextLayer sued to display text when the component is empty

getComponentWithTitlebar

ComponentWithTitlebar getComponentWithTitlebar()

The component can be optionally contained in a ComponentWithTitlebar

Returns:

the ComponentWithTitlebar containing the component (or null)

getSelectedValue

T getSelectedValue()

Returns:

the selected item in the component. For multi select it returns the 'lead selection'.

getSelectedValues

java.util.List<T> getSelectedValues()

Returns:

a java.util.List of items selected in the component.