ilog.tgo.interactor

Class IltEditLabelInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvEditLabelInteractor

ilog.tgo.interactor.IltEditLabelInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable

public class IltEditLabelInteractor
extends IlvEditLabelInteractor

This interactor lets you create and edit a graphic object containing a label. The edition is only possible if the object being edited contains the business attribute that is used to retrieve the label information.

It can work in three different modes:

• Creation only.
• Edition only.
• Creation and edition.

When this interactor is installed on a view, clicking on an object that implements the IlvLabelInterface opens an editor in which the object can be edited. Clicking on the background of the view also opens an editor, and a graphic object of the class IlvLabel is created when you validate the edition. When the text field opens, validate by pressing RETURN or click somewhere else on the view. The edition is validated when the edition field looses the keyboard focus. Any graphic object displaying a label can be edited with this interactor, provided that it implements the interface IlvLabelInterface. You can also create any type of labeled graphic object by setting a factory of labeled objects.

See Also:

IlvEditLabelInteractor, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltEditLabelInteractor.Gesture This class enumerates the possible gestures recognized by this interactor.

Constructor Summary

Constructors

Constructor and Description
IltEditLabelInteractor() Creates the interactor.
IltEditLabelInteractor(IlpAttribute labelAttribute) Creates the interactor associated with the given business attribute.
IltEditLabelInteractor(String labelAttributeName) Creates the interactor associated with the given business attribute.

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(IlvGraphic obj) Verifies whether editing of the object is allowed.
IlpAttribute	getLabelAttribute() Returns the attribute that is being edited.
String	getLabelAttributeName() Returns the label attribute name used by this interactor
void	setLabelAttributeName(String name) Sets the label attribute name used by this interactor
void	updateLabel(IlpViewsViewInteractor interactor, IlpGraphic graphic, String label) Called when IlvEditLabelInteractor has accepted a new label from the user.

Methods inherited from class ilog.views.interactor.IlvEditLabelInteractor

addObject, attach, createEditComponent, detach, editObject, ensureEditAreaInView, getEditingAreaBBox, getEditionFont, getFont, getForeground, getLabelBBox, getObjectFactory, getObjectLabel, isCreationAllowed, isCreationInSubManagersAllowed, isEditionAllowed, isGrapherMode, isPermanent, makeObject, processMouseEvent, setCreationAllowed, setCreationInSubManagersAllowed, setEditionAllowed, setFont, setForeground, setGrapherMode, setObjectFactory, setObjectLabel, setPermanent, supportMultiline

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, isXORGhost, processEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, setXORGhost

Methods inherited from class java.lang.Object

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

Constructor Detail

IltEditLabelInteractor

public IltEditLabelInteractor(String labelAttributeName)

Creates the interactor associated with the given business attribute.

The label can only be edited if the object contains an attribute that corresponds to the given name.

Parameters:

labelAttributeName - The attribute to be edited.

Since:

JTGO 4.0

IltEditLabelInteractor

public IltEditLabelInteractor(IlpAttribute labelAttribute)

Creates the interactor associated with the given business attribute.

Parameters:

labelAttribute - The attribute to be edited.

IltEditLabelInteractor

public IltEditLabelInteractor()

Creates the interactor.

This interactor edits the value of the attribute "name".

Method Detail

getLabelAttribute

public IlpAttribute getLabelAttribute()

Returns the attribute that is being edited.

setLabelAttributeName

public void setLabelAttributeName(String name)

Sets the label attribute name used by this interactor

Since:

JTGO 4.0

getLabelAttributeName

public String getLabelAttributeName()

Returns the label attribute name used by this interactor

Since:

JTGO 4.0

updateLabel

public void updateLabel(IlpViewsViewInteractor interactor,
                        IlpGraphic graphic,
                        String label)

Called when IlvEditLabelInteractor has accepted a new label from the user.

Internal: do not use!

accept

protected boolean accept(IlvGraphic obj)

Verifies whether editing of the object is allowed. This method is called by the interactor to check whether the object obj can be edited. The current implementation only allows the editing of objects that contain the label attribute and that implement the IlvLabelInterface.

Overrides:

accept in class IlvEditLabelInteractor