ilog.views.graphic.composite

Class IlvEventMap

java.lang.Object

ilog.views.graphic.composite.IlvEventMap

All Implemented Interfaces:

IlvPersistentObject, Cloneable

public class IlvEventMap
extends Object
implements Cloneable, IlvPersistentObject

This class defines a collection of bindings of KeyStrokes and mouse gestures to actions.

Since:

JViews 6.0

See Also:

IlvCompositeInteractor, IlvMouseGesture

Constructor Summary

Constructors

Constructor and Description
IlvEventMap() Beans default constructor
IlvEventMap(IlvInputStream stream) Reads the object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
Object	clone()
Action	getAction(IlvMouseGesture gesture) Returns the Swing action associated with the supplied gesture.
Object[]	getActions() Returns the actions for this IlvEventMap instance or null if none.
Object	getActions(int index) Returns either a Action instance or a String which is the class name of a Swing action.
String[]	getEvents() Gets the events associated with the actions.
String	getEvents(int index) Returns the gesture at the supplied position.
boolean	isEmpty() Returns true when this IlvEventMap instance is empty.
void	setActions(int index, Object action) Sets an action at the given position.
void	setActions(Object[] actions) Sets the actions for this IlvEventMap instance.
void	setEvents(int index, String event) Associates the action at the given position with the supplied gesture.
void	setEvents(String[] events) Sets the events associated with the actions.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvEventMap

public IlvEventMap()

Beans default constructor

IlvEventMap

public IlvEventMap(IlvInputStream stream)
            throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

setEvents

public void setEvents(String[] events)

Sets the events associated with the actions.

Parameters:

events - The events that will cause the actions to be performed.

getEvents

public String[] getEvents()

Gets the events associated with the actions.

setEvents

public void setEvents(int index,
                      String event)

Associates the action at the given position with the supplied gesture.

Parameters:

index - Position of the action.

event - The event that will cause the action to be performed. This event is either a String defining a key stroke as described in KeyStroke or a String corresponding to a mouse gesture.

See Also:

IlvMouseGesture, KeyStroke

getEvents

public String getEvents(int index)

Returns the gesture at the supplied position.

See Also:

IlvMouseGesture

setActions

public void setActions(int index,
                       Object action)

Sets an action at the given position. This action should be associated with a gesture or a key stroke.

Parameters:

index - The position of the action.

action - Can be either a Action or a String which is the class name of a Swing action.

See Also:

setEvents(java.lang.String[])

getActions

public Object getActions(int index)

Returns either a Action instance or a String which is the class name of a Swing action.

Parameters:

index - The position of the required action.

getActions

public Object[] getActions()

Returns the actions for this IlvEventMap instance or null if none.

setActions

public void setActions(Object[] actions)

Sets the actions for this IlvEventMap instance.

Parameters:

actions - Array of either a Action or a String which is the class name of a Swing action.

getAction

public Action getAction(IlvMouseGesture gesture)

Returns the Swing action associated with the supplied gesture.

Parameters:

gesture - The gesture for which the action is required.

Returns:

Returns a Swing action.

See Also:

IlvMouseGesture, Action

clone

public Object clone()

Overrides:

clone in class Object

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

isEmpty

public boolean isEmpty()

Returns true when this IlvEventMap instance is empty.

Since:

JViews 8.1