ilog.cpl.interactor

Interface IlpViewInteractionContext

All Superinterfaces:

IlpInteractionContext

All Known Implementing Classes:

IlpDefaultViewInteractionContext, IlpTableHeaderInteractionContext, IlpTableViewInteractionContext

public interface IlpViewInteractionContext
extends IlpInteractionContext

Describes the context of a user interaction that can occur anywhere in a view. A view interaction context is used to store contextual information about the events that occur over a graphic view.

Since:

JTGO 3.0

See Also:

IlpInteractionContext

Method Summary

Modifier and Type	Method and Description
void	addGraphic(IlpGraphic graphic) Adds a graphic to the collection of graphics involved in a gesture.
void	addRepresentationObject(IlpRepresentationObject object) Adds a representation object to the collection of representation objects involved in a gesture.
Collection<IlpGraphic>	getGraphics() Returns the collection of IlpGraphics involved in a gesture.
IlpObjectInteractionContext	getObjectContext() Returns the object interaction context used when the event management is delegated to an object interactor.
Collection<IlpRepresentationObject>	getRepresentationObjects() Returns the collection of IlpRepresentationObjects involved in a gesture.
boolean	removeGraphic(IlpGraphic graphic) Removes a graphic from the collection of graphics involved in a gesture.
boolean	removeRepresentationObject(IlpRepresentationObject object) Removes a representation object from the collection of representation objects involved in a gesture.
void	setObjectContext(IlpObjectInteractionContext objectContext) Sets the object interaction context used when the event management is delegated to an object interactor.

Methods inherited from interface ilog.cpl.interactor.IlpInteractionContext

getInitialModifiersEx, getPosition, getView, reset, setInitialModifiersEx, setPosition

Method Detail

getRepresentationObjects

Collection<IlpRepresentationObject> getRepresentationObjects()

Returns the collection of IlpRepresentationObjects involved in a gesture. May be empty.

See Also:

addRepresentationObject(ilog.cpl.model.IlpRepresentationObject), removeRepresentationObject(ilog.cpl.model.IlpRepresentationObject)

addRepresentationObject

void addRepresentationObject(IlpRepresentationObject object)

Adds a representation object to the collection of representation objects involved in a gesture.

Parameters:

object - The representation object which has to be added.

Throws:

IllegalArgumentException - if the given representation object is null.

See Also:

getRepresentationObjects(), removeRepresentationObject(ilog.cpl.model.IlpRepresentationObject)

removeRepresentationObject

boolean removeRepresentationObject(IlpRepresentationObject object)

Removes a representation object from the collection of representation objects involved in a gesture.

Parameters:

object - the representation object which has to be removed.

Returns:

true if the given representation object has been removed.

See Also:

getRepresentationObjects(), addRepresentationObject(ilog.cpl.model.IlpRepresentationObject)

getGraphics

Collection<IlpGraphic> getGraphics()

Returns the collection of IlpGraphics involved in a gesture. May be empty.

See Also:

addGraphic(ilog.cpl.graphic.IlpGraphic), removeGraphic(ilog.cpl.graphic.IlpGraphic)

addGraphic

void addGraphic(IlpGraphic graphic)

Adds a graphic to the collection of graphics involved in a gesture. Adding a graphic also adds its representation object.

Parameters:

graphic - The graphic to be added.

Throws:

IllegalArgumentException - if the given graphic is null.

See Also:

getGraphics(), removeGraphic(ilog.cpl.graphic.IlpGraphic)

removeGraphic

boolean removeGraphic(IlpGraphic graphic)

Removes a graphic from the collection of graphics involved in a gesture. Removing a graphic also removes its representation object.

Parameters:

graphic - the graphic which has to be removed

Returns:

true if the given graphic has been removed

See Also:

getGraphics(), addGraphic(ilog.cpl.graphic.IlpGraphic)

getObjectContext

IlpObjectInteractionContext getObjectContext()

Returns the object interaction context used when the event management is delegated to an object interactor. May be null.

See Also:

setObjectContext(ilog.cpl.interactor.IlpObjectInteractionContext)

setObjectContext

void setObjectContext(IlpObjectInteractionContext objectContext)

Sets the object interaction context used when the event management is delegated to an object interactor.

Parameters:

objectContext - The object interaction context used to delegate the event management. May be null.

See Also:

getObjectContext()