| org.osbl.client.wings.form.ObjectList
All known Subclasses: org.osbl.client.wings.form.GenericObjectList, org.osbl.client.wings.form.GenericObjectTreeList,
| ObjectList | | public interface ObjectList (Code) | | An ObjectList displays a list of objects in list manner or table manner.
It supports selection, navigation (link) and allows a user to perform actions on selected objects.
author:
hengels |
| Method Summary | |
| SComponent | getComponent()
Return the SComponent, that shows the list of objects.
Consecutive calls to this method must always return the same component instance. | | Object | getCurrent()
Return the current object. | | Environment | getEnvironment()
The environment provided by the editor. | | Object | getSelectedObject()
Retrieve the currently selected object.
the selected object or null, if nothing is selected. | | List | getSelectedObjects()
Retrieve a list of the currently selected objects. | | Class | getType()
| | boolean | hasNext()
Tell wether there is at least one object behind the current object in the list. | | boolean | hasPrevious()
Tell wether there is at least one object before the current object in the list. | | void | next()
Set cursor to the the next object in the list. | | void | previous()
Set cursor to the previous object in the list. | | void | refresh()
The content of the list is refreshed. | | void | setCurrent(Object object)
| | void | setLinkAction(String name, ObjectAction linkAction)
Expose an ObjectAction visually as a link.
ObjectList implementations should support a link notion. | | void | setSelectedObject(Object object)
Set the selected object. | | void | setSelectedObjects(List objects)
Set the selected object. | | void | setSelectionMode(int selectionMode)
Set the selection mode.
ObjectLists support single selection and multi selection. |
| MULTIPLE_SELECTION | | final public static int MULTIPLE_SELECTION(Code) | | |
| SINGLE_SELECTION | | final public static int SINGLE_SELECTION(Code) | | |
| getComponent | | SComponent getComponent()(Code) | | Return the SComponent, that shows the list of objects.
Consecutive calls to this method must always return the same component instance. The implementor might choose to
create the component lazily on the first call.
the component showing the list |
| getCurrent | | Object getCurrent()(Code) | | Return the current object.
the current object |
| getEnvironment | | Environment getEnvironment()(Code) | | The environment provided by the editor.
|
| getSelectedObject | | Object getSelectedObject()(Code) | | Retrieve the currently selected object.
the selected object or null, if nothing is selected. If there are multiple selected objects, return thefirst one. |
| getSelectedObjects | | List getSelectedObjects()(Code) | | Retrieve a list of the currently selected objects.
a list of selected objects. |
| hasNext | | boolean hasNext()(Code) | | Tell wether there is at least one object behind the current object in the list.
true, if the current object is not the last object, false otherwise |
| hasPrevious | | boolean hasPrevious()(Code) | | Tell wether there is at least one object before the current object in the list.
true, if the current object is not the first object, false otherwise |
| next | | void next()(Code) | | Set cursor to the the next object in the list.
|
| previous | | void previous()(Code) | | Set cursor to the previous object in the list.
|
| refresh | | void refresh()(Code) | | The content of the list is refreshed.
Call this method, if you expect, that the list's content has changed.
This method might perform expensive operations.
|
| setCurrent | | void setCurrent(Object object)(Code) | | Set the currently selected object
Parameters:
object - the current object |
| setLinkAction | | void setLinkAction(String name, ObjectAction linkAction)(Code) | | Expose an ObjectAction visually as a link.
ObjectList implementations should support a link notion. That is, one column (typically the key column) is
rendered in link style (ie. bold and blue). If a user clicks on a link, the ObjectAction will be called on the
object in the respective row.
Parameters:
name - the column name (typically property name)
Parameters:
linkAction - the action to called on click |
| setSelectedObject | | void setSelectedObject(Object object)(Code) | | Set the selected object.
SelectionListeners will be informed of this change!
Parameters:
object - the object to be selected |
| setSelectedObjects | | void setSelectedObjects(List objects)(Code) | | Set the selected object.
SelectionListeners will be informed of this change!
Parameters:
objects - the objects to be selected |
| setSelectionMode | | void setSelectionMode(int selectionMode)(Code) | | Set the selection mode.
ObjectLists support single selection and multi selection. Consult the wingS- or Swing- documentation for further
information on selection models.
Parameters:
selectionMode - either STable.SINGLE_SELECTION or STable.MULTIPLE_SELECTION |
|
|