ilog.views.sdm.interactor

Class IlvEditSDMLabelInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvEditLabelInteractor

ilog.views.sdm.interactor.IlvEditSDMLabelInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable

public class IlvEditSDMLabelInteractor
extends IlvEditLabelInteractor

The IlvEditSDMLabelInteractor lets the user edit the label of a node created by an SDM engine.

By default, this interactor sets the label property of the underlying data object. You can specify another property by calling the setLabelProperty(java.lang.String) method of the interactor.

Since:

JViews 4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvEditSDMLabelInteractor() Creates a new interactor that edits the labels of the nodes created by an SDM engine.

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(IlvGraphic obj) Returns true if the graphic object or the object that it encapsulates implements IlvLabelInterface.
protected void	attach(IlvManagerView v) This method is called when the interactor is attached to the specified manager view.
protected void	detach() This method is called when the interactor is detached from the specified manager view.
String	getBtdProperty() Gets the name of the property used to set the base text direction of a data object.
protected IlvRect	getLabelBBox(IlvGraphic obj, IlvTransformer t) Returns the bounding rectangle of the label of the graphic object or the object that it encapsulates.
String	getLabelProperty() Gets the name of the property used to set the label of a data object.
protected String	getObjectLabel(IlvGraphic obj) Returns the label of the graphic object or the object that it encapsulates.
void	setBtdProperty(String btdProperty) Changes the name of the property used to set the base text direction of a data object.
void	setLabelProperty(String labelProperty) Changes the name of the property used to set the label of a data object.
protected void	setObjectLabel(IlvGraphic graphic, String label) This method changes the label of the object directly in the SDM data model.
protected boolean	supportMultiline(IlvGraphic obj) Returns true if the graphic object or the object that it encapsulates implements IlvLabelInterface, and supports multiline labels.

Methods inherited from class ilog.views.interactor.IlvEditLabelInteractor

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

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

IlvEditSDMLabelInteractor

public IlvEditSDMLabelInteractor()

Creates a new interactor that edits the labels of the nodes created by an SDM engine.

Method Detail

setLabelProperty

public void setLabelProperty(String labelProperty)

Changes the name of the property used to set the label of a data object. By default, the property name is label.

Parameters:

labelProperty - The name of the property used to set an object label.

getLabelProperty

public String getLabelProperty()

Gets the name of the property used to set the label of a data object.

See Also:

setLabelProperty(java.lang.String)

setBtdProperty

public void setBtdProperty(String btdProperty)

Changes the name of the property used to set the base text direction of a data object. By default, the property name is baseTextDirection.

Parameters:

btdProperty - The name of the property used to set an object base text direction.

Since:

JViews 8.8

getBtdProperty

public String getBtdProperty()

Gets the name of the property used to set the base text direction of a data object.

Since:

JViews 8.8

See Also:

setBtdProperty(java.lang.String)

accept

protected boolean accept(IlvGraphic obj)

Returns true if the graphic object or the object that it encapsulates implements IlvLabelInterface.

Overrides:

accept in class IlvEditLabelInteractor

Parameters:

obj - The graphic object.

getObjectLabel

protected String getObjectLabel(IlvGraphic obj)

Returns the label of the graphic object or the object that it encapsulates.

Overrides:

getObjectLabel in class IlvEditLabelInteractor

Parameters:

obj - The graphic object.

supportMultiline

protected boolean supportMultiline(IlvGraphic obj)

Returns true if the graphic object or the object that it encapsulates implements IlvLabelInterface, and supports multiline labels.

Overrides:

supportMultiline in class IlvEditLabelInteractor

Parameters:

obj - The graphic object.

getLabelBBox

protected IlvRect getLabelBBox(IlvGraphic obj,
                               IlvTransformer t)

Returns the bounding rectangle of the label of the graphic object or the object that it encapsulates.

Overrides:

getLabelBBox in class IlvEditLabelInteractor

Parameters:

obj - The graphic object.

t - The transformer used to compute the bounding rectangle.

See Also:

IlvEditLabelInteractor.editObject(IlvGraphic, IlvPoint), IlvEditLabelInteractor.getEditingAreaBBox(IlvGraphic, IlvPoint, int, int, int, int, IlvTransformer)

setObjectLabel

protected void setObjectLabel(IlvGraphic graphic,
                              String label)

This method changes the label of the object directly in the SDM data model. The graphic object will be updated automatically by SDM to display the new label.

Overrides:

setObjectLabel in class IlvEditLabelInteractor

Parameters:

graphic - The graphic object whose label is being edited.

label - The new label.

attach

protected void attach(IlvManagerView v)

This method is called when the interactor is attached to the specified manager view.

Overrides:

attach in class IlvEditLabelInteractor

Parameters:

v - The manager view.

See Also:

IlvManagerViewInteractor.detach()

detach

protected void detach()

This method is called when the interactor is detached from the specified manager view.

Overrides:

detach in class IlvEditLabelInteractor

See Also:

IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)