ilog.cpl.util.selection

Interface IlpRepresentationObjectSelectionModel

All Known Subinterfaces:

IlpEquipmentSelectionModel, IlpGraphSelectionModel, IlpNetworkSelectionModel, IlpTableSelectionModel, IlpTreeSelectionModel

All Known Implementing Classes:

IlpAbstractEquipmentSelectionModel, IlpAbstractGraphSelectionModel, IlpAbstractNetworkSelectionModel, IlpDefaultEquipmentSelectionModel, IlpDefaultNetworkSelectionModel, IlpDefaultTableSelectionModel, IlpDefaultTreeSelectionModel

public interface IlpRepresentationObjectSelectionModel

This interface allows the selection of IlpRepresentationObjects.

Since:

JTGO 3.0

Method Summary

Modifier and Type	Method and Description
void	addSelectionRepresentationObject(IlpRepresentationObject object) Adds the given IlpRepresentationObject to the selection.
void	clearSelection() Clears the selection.
IlpRepresentationObject	getSelectedRepresentationObject() Returns the first selected IlpRepresentationObject from the collection of selected representation objects.
Collection	getSelectedRepresentationObjects() Returns the set of selected IlpRepresentationObjects.
boolean	isRepresentationObjectSelected(IlpRepresentationObject object) Returns true if the given IlpRepresentationObject is selected, false otherwise.
void	removeSelectionRepresentationObject(IlpRepresentationObject object) Removes the given IlpRepresentationObject from the selection.
void	removeSelectionRepresentationObjects(Collection ros) Removes the given IlpRepresentationObjects from the selection.
void	setSelectedRepresentationObject(IlpRepresentationObject object) Sets the selected IlpRepresentationObject.
void	setSelectedRepresentationObjects(Collection objects) Sets the set of selected IlpRepresentationObjects.

Method Detail

getSelectedRepresentationObject

IlpRepresentationObject getSelectedRepresentationObject()

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

Returns:

the first selected representation object, or null if the selection is empty.

getSelectedRepresentationObjects

Collection getSelectedRepresentationObjects()

Returns the set of selected IlpRepresentationObjects. 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 IlpRepresentationObjects

setSelectedRepresentationObject

void setSelectedRepresentationObject(IlpRepresentationObject object)

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

Parameters:

object - The object that will become the selection.

Since:

JTGO 4.0

setSelectedRepresentationObjects

void setSelectedRepresentationObjects(Collection objects)

Sets the set of selected IlpRepresentationObjects.

Parameters:

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

Since:

JTGO 4.0

isRepresentationObjectSelected

boolean isRepresentationObjectSelected(IlpRepresentationObject object)

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

Parameters:

object - The representation object that may be selected.

addSelectionRepresentationObject

void addSelectionRepresentationObject(IlpRepresentationObject object)

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

Parameters:

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

removeSelectionRepresentationObject

void removeSelectionRepresentationObject(IlpRepresentationObject object)

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

Parameters:

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

removeSelectionRepresentationObjects

void removeSelectionRepresentationObjects(Collection ros)

Removes the given IlpRepresentationObjects from the selection. This has no effect if the given objects are null or if they are currently unselected.

Parameters:

ros - The collection of representation objects to be removed

Since:

JViews 7.5

clearSelection

void clearSelection()

Clears the selection.