public class ListField extends BasicField
Modifier and Type | Class and Description |
---|---|
static class |
ListField.ColumnsDescription |
Modifier and Type | Field and Description |
---|---|
protected java.lang.String[] |
fButtonLabels |
protected java.util.List<java.lang.Object> |
fElements |
protected org.eclipse.jface.viewers.ILabelProvider |
fLabelProvider |
protected org.eclipse.sphinx.platform.ui.fields.ListField.ListViewerAdapter |
fListViewerAdapter |
protected org.eclipse.jface.viewers.TableViewer |
fTable |
protected org.eclipse.swt.widgets.Control |
fTableControl |
protected org.eclipse.jface.viewers.ViewerComparator |
fViewerComparator |
fLabelControl, fLabelText, fUseFormLayout, fWidgetFactory, MAX_WITDH
Constructor and Description |
---|
ListField(IListAdapter listAdapter,
java.lang.String[] buttonLabels,
org.eclipse.jface.viewers.ILabelProvider labelProvider)
Creates the
ListField . |
ListField(IWidgetFactory widgetFactory,
IListAdapter listAdapter,
java.lang.String[] buttonLabels,
org.eclipse.jface.viewers.ILabelProvider labelProvider) |
Modifier and Type | Method and Description | |||
---|---|---|---|---|
boolean |
addElement(java.lang.Object element)
Adds an element at the end of the list.
|
|||
boolean |
addElement(java.lang.Object element,
int index)
Adds an element at a position.
|
|||
boolean |
addElements(java.util.List<java.lang.Object> elements)
Adds elements at the end of the list.
|
|||
boolean |
addElements(java.util.List<java.lang.Object> elements,
int index)
Adds elements at the given index
|
|||
boolean |
canMoveDown() |
|||
boolean |
canMoveUp() |
|||
protected org.eclipse.swt.widgets.Button |
createButton(org.eclipse.swt.widgets.Composite parent,
java.lang.String label,
org.eclipse.swt.events.SelectionListener listener) |
|||
protected org.eclipse.jface.viewers.TableViewer |
createTableViewer(org.eclipse.swt.widgets.Composite parent) |
|||
void |
dialogFieldChanged()
Programatical invocation of a dialog field change.
|
|||
void |
dispose()
Disposes of the operating system resources associated with the field.
|
|||
protected void |
doDoubleClick(org.eclipse.jface.viewers.DoubleClickEvent event) |
|||
protected org.eclipse.swt.widgets.Control[] |
doFillIntoGrid(org.eclipse.swt.widgets.Composite parent,
int nColumns)
/!\
| To be re-implemented by platform field implementors.
| /!\
|
|
protected void |
doListSelected(org.eclipse.jface.viewers.SelectionChangedEvent event) |
|||
void |
editElement(java.lang.Object element) |
|||
void |
elementChanged(java.lang.Object element)
Notifies clients that the element has changed.
|
|||
void |
enableButton(int index,
boolean enable)
Sets a button enabled or disabled.
|
|||
org.eclipse.swt.widgets.Composite |
getButtonBox(org.eclipse.swt.widgets.Composite parent)
Returns the composite containing the buttons.
|
|||
java.lang.Object |
getElement(int index)
Gets the elements shown at the given index.
|
|||
java.util.List<java.lang.Object> |
getElements()
Gets the elements shown in the list.
|
|||
int |
getIndexOfElement(java.lang.Object elem)
Gets the index of an element in the list or -1 if element is not in list.
|
|||
org.eclipse.swt.widgets.Control |
getListControl() |
|||
org.eclipse.swt.widgets.Control |
getListControl(org.eclipse.swt.widgets.Composite parent)
Returns the list control.
|
|||
protected int |
getListStyle() |
|||
protected boolean |
getManagedButtonState(org.eclipse.jface.viewers.ISelection sel,
int index) |
|||
int |
getNumberOfControls()
Returns the number of columns of the dialog field.
|
|||
java.util.List<java.lang.Object> |
getSelectedElements()
Returns the selected elements.
|
|||
int |
getSize()
Gets the number of elements
|
|||
org.eclipse.jface.viewers.TableViewer |
getTableViewer()
Returns the internally used table viewer.
|
|||
protected void |
handleKeyPressed(org.eclipse.swt.events.KeyEvent event)
Handles key events in the table viewer.
|
|||
protected boolean |
hasButtons()
Returns weather this ListField contains any buttons or not.
|
|||
protected boolean |
managedButtonPressed(int index)
Checks if the button pressed is handled internally
|
|||
void |
postSetSelection(org.eclipse.jface.viewers.ISelection selection) |
|||
void |
refresh()
Refreshes the table.
|
|||
void |
removeAllElements()
Adds an element at a position.
|
|||
void |
removeElement(java.lang.Object element)
Removes an element from the list.
|
|||
void |
removeElements(java.util.List<java.lang.Object> elements)
Removes elements from the list.
|
|||
void |
replaceElement(java.lang.Object oldElement,
java.lang.Object newElement)
Replaces an element.
|
|||
void |
selectElements(org.eclipse.jface.viewers.ISelection selection) |
|||
void |
selectFirstElement() |
|||
void |
setButtonsMinWidth(int minWidth)
Sets the minimal width of the buttons.
|
|||
void |
setDownButtonIndex(int downButtonIndex)
Sets the index of the 'down' button in the button label array passed in the constructor.
|
|||
void |
setElements(java.util.Collection<java.lang.Object> elements)
Sets the elements shown in the list.
|
|||
void |
setRemoveButtonIndex(int removeButtonIndex)
Sets the index of the 'remove' button in the button label array passed in the constructor.
|
|||
void |
setTableColumns(ListField.ColumnsDescription column) |
|||
void |
setUpButtonIndex(int upButtonIndex)
Sets the index of the 'up' button in the button label array passed in the constructor.
|
|||
void |
setViewerComparator(org.eclipse.jface.viewers.ViewerComparator viewerComparator)
Sets the viewer comparator.
|
|||
protected void |
updateButtonState() |
|||
protected void |
updateEnableState()
Called when the enable state changed.
|
addFieldListener, assertCompositeNotNull, createEmptySpace, createEmptySpace, createLabelControl, createSpecificComposite, fillIntoGrid, getLabelControl, getLabelControl, getLabelControl, isEnabled, isOkToUse, removeFieldListener, setEnabled, setFocus, setLabelText, setToolTipText
protected org.eclipse.jface.viewers.TableViewer fTable
protected org.eclipse.swt.widgets.Control fTableControl
protected org.eclipse.jface.viewers.ILabelProvider fLabelProvider
protected org.eclipse.sphinx.platform.ui.fields.ListField.ListViewerAdapter fListViewerAdapter
protected java.util.List<java.lang.Object> fElements
protected org.eclipse.jface.viewers.ViewerComparator fViewerComparator
protected java.lang.String[] fButtonLabels
public ListField(IListAdapter listAdapter, java.lang.String[] buttonLabels, org.eclipse.jface.viewers.ILabelProvider labelProvider)
ListField
.listAdapter
- A listener for button invocation, selection changes. Can be null
.buttonLabels
- The labels of all buttons: null
is a valid array entry and marks a separator.labelProvider
- The label provider to render the table entriespublic ListField(IWidgetFactory widgetFactory, IListAdapter listAdapter, java.lang.String[] buttonLabels, org.eclipse.jface.viewers.ILabelProvider labelProvider)
public void setRemoveButtonIndex(int removeButtonIndex)
public void setUpButtonIndex(int upButtonIndex)
public void setDownButtonIndex(int downButtonIndex)
public void setViewerComparator(org.eclipse.jface.viewers.ViewerComparator viewerComparator)
viewerComparator
- The viewer comparator to setpublic void setTableColumns(ListField.ColumnsDescription column)
protected boolean managedButtonPressed(int index)
protected org.eclipse.swt.widgets.Control[] doFillIntoGrid(org.eclipse.swt.widgets.Composite parent, int nColumns)
BasicField
/!\ | To be re-implemented by platform field implementors. | /!\ |
doFillIntoGrid
in class BasicField
parent
- The parent composite of this dialog field.nColumns
- The number of columns of this dialog field.public int getNumberOfControls()
BasicField
getNumberOfControls
in class BasicField
public void setButtonsMinWidth(int minWidth)
public org.eclipse.swt.widgets.Control getListControl(org.eclipse.swt.widgets.Composite parent)
parent
- The parent composite when called the first time, or null
after.public org.eclipse.swt.widgets.Control getListControl()
public org.eclipse.jface.viewers.TableViewer getTableViewer()
protected int getListStyle()
protected org.eclipse.jface.viewers.TableViewer createTableViewer(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Button createButton(org.eclipse.swt.widgets.Composite parent, java.lang.String label, org.eclipse.swt.events.SelectionListener listener)
protected boolean hasButtons()
public org.eclipse.swt.widgets.Composite getButtonBox(org.eclipse.swt.widgets.Composite parent)
parent
- The parent composite when called the first time, or null
after.protected void handleKeyPressed(org.eclipse.swt.events.KeyEvent event)
public void dialogFieldChanged()
BasicField
dialogFieldChanged
in class BasicField
protected void updateButtonState()
protected boolean getManagedButtonState(org.eclipse.jface.viewers.ISelection sel, int index)
protected void updateEnableState()
BasicField
updateEnableState
in class BasicField
public void enableButton(int index, boolean enable)
public void dispose()
IField
dispose
in interface IField
dispose
in class BasicField
public void setElements(java.util.Collection<java.lang.Object> elements)
public java.util.List<java.lang.Object> getElements()
public java.lang.Object getElement(int index)
public int getIndexOfElement(java.lang.Object elem)
public void replaceElement(java.lang.Object oldElement, java.lang.Object newElement) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public void elementChanged(java.lang.Object element) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public boolean addElement(java.lang.Object element)
public boolean addElement(java.lang.Object element, int index)
public boolean addElements(java.util.List<java.lang.Object> elements, int index)
public boolean addElements(java.util.List<java.lang.Object> elements)
public void removeAllElements()
public void removeElement(java.lang.Object element) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public void removeElements(java.util.List<java.lang.Object> elements)
public int getSize()
public void selectElements(org.eclipse.jface.viewers.ISelection selection)
public void selectFirstElement()
public void editElement(java.lang.Object element)
public void postSetSelection(org.eclipse.jface.viewers.ISelection selection)
public void refresh()
refresh
in class BasicField
public boolean canMoveUp()
public boolean canMoveDown()
public java.util.List<java.lang.Object> getSelectedElements()
protected void doListSelected(org.eclipse.jface.viewers.SelectionChangedEvent event)
protected void doDoubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)