ilog.cpl.util.selection

Interface IlpObjectSelectionModel

All Known Subinterfaces:

IlpEquipmentSelectionModel, IlpGraphicComponent, IlpGraphSelectionModel, IlpInteractiveGraphicComponent, IlpNetworkSelectionModel, IlpTableSelectionModel, IlpTreeSelectionModel

All Known Implementing Classes:

IlpAbstractEquipmentSelectionModel, IlpAbstractGraphSelectionModel, IlpAbstractNetworkSelectionModel, IlpDefaultEquipmentSelectionModel, IlpDefaultNetworkSelectionModel, IlpDefaultTableSelectionModel, IlpDefaultTreeSelectionModel, IlpEquipment, IlpNetwork, IlpTable, IlpTree

public interface IlpObjectSelectionModel

This interface allows the selection of IlpObjects.

Since:

JTGO 3.0

Method Summary

Modifier and Type	Method and Description
void	addSelectionObject(IlpObject object) Adds the given IlpObject to the selection.
void	clearSelection() Clears the selection.
IlpObject	getSelectedObject() Returns the first selected IlpObject from the collection of selected objects.
Collection	getSelectedObjects() Returns the set of selected IlpObjects.
boolean	isObjectSelected(IlpObject object) Returns true if the given IlpObject is selected, false otherwise.
void	removeSelectionObject(IlpObject object) Removes the given IlpObject from the selection.
void	setSelectedObject(IlpObject object) Sets the selected IlpObject.
void	setSelectedObjects(Collection objects) Sets the set of selected IlpObjects.

Method Detail

getSelectedObject

IlpObject getSelectedObject()

Returns the first selected IlpObject from the collection of selected objects. Returns null if there is no selected object.

getSelectedObjects

Collection getSelectedObjects()

Returns the set of selected IlpObjects. The set should be ordered if the component implementing this interface supports an ordered selection. Returns an empty set if there is no selected object.

Returns:

An unmodifiable Collection of IlpObjects.

setSelectedObject

void setSelectedObject(IlpObject object)

Sets the selected IlpObject. This has no effect if the given object is already selected.

Parameters:

object - The object that will become the selection.

Since:

JTGO 4.0

setSelectedObjects

void setSelectedObjects(Collection objects)

Sets the set of selected IlpObjects.

Parameters:

objects - The collection of objects that will become the selection.

Since:

JTGO 4.0

isObjectSelected

boolean isObjectSelected(IlpObject object)

Returns true if the given IlpObject is selected, false otherwise.

Parameters:

object - The object that may be selected.

addSelectionObject

void addSelectionObject(IlpObject object)

Adds the given IlpObject to the selection. This has no effect if the given object is null or if it is already selected.

Parameters:

object - The object that will be added to the selection.

removeSelectionObject

void removeSelectionObject(IlpObject object)

Removes the given IlpObject from the selection. This has no effect if the given object is null or if it is currently unselected.

Parameters:

object - The object that will be removed from the selection.

clearSelection

void clearSelection()

Clears the selection.