ilog.views
Interface IlvLabelInterface

All Known Subinterfaces:
IlvComposite, IlvTextInterface
All Known Implementing Classes:
IlvCompositeGraphic, IlvCompositeLink, IlvDefaultCollapsedGraphic, IlvDefaultLaneGraphic, IlvFilledLabel, IlvGeneralLink, IlvGeneralNode, IlvLabel, IlvMapGraphicText, IlvMapLabel, IlvPowerLabel, IlvReliefLabel, IlvSDMCompositeLink, IlvSDMCompositeNode, IlvShadowLabel, IlvSwimLanesRenderer.DefaultSwimLaneGraphic, IlvText, IlvTextPath, IlvZoomableLabel

public interface IlvLabelInterface

An interface to be implemented by objects that display a text. If a graphic object implements this interface, then the text of the object can be edited using the IlvEditLabelInteractor.

See Also:
IlvEditLabelInteractor

Method Summary
 String getLabel()
          Returns the label of the object.
 IlvRect getLabelBBox(IlvTransformer t)
          Returns the area where the label is displayed.
 void setLabel(String label)
          Changes the label of the object.
 boolean supportMultiline()
          Returns true if the label can be a multi-line label; false otherwise.
 

Method Detail

setLabel

void setLabel(String label)
Changes the label of the object.


getLabel

String getLabel()
Returns the label of the object.


supportMultiline

boolean supportMultiline()
Returns true if the label can be a multi-line label; false otherwise.


getLabelBBox

IlvRect getLabelBBox(IlvTransformer t)
Returns the area where the label is displayed. The returned value may be null if no text at all is displayed by the implementation.

Parameters:
t - the transformer used to draw the graphic object.


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.