IlvText (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.IlvGraphic
- - ilog.views.IlvBidiGraphic
  - - ilog.views.graphic.IlvText

All Implemented Interfaces:

IlvFontInterface, IlvLabelInterface, IlvTextInterface, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable
```
public class IlvText
extends IlvBidiGraphic
implements IlvTextInterface, IlvFontInterface
```
IlvText represents a customizable multiline text label.
An IlvText instance supports word wrapping and truncation. You can add a background rectangle with margins around the bounding box of the text label.

The default values for an IlvText instance are as follows:
- size and position: IlvPoint(0, 0)
- anchor position: IlvConstants.LEADING
- font: IlvToolkit.defaultFont
- font color: Color.black
- fractional metrics enabled: true
- fill enabled: false
- fill paint: Color.gray
- stroke enabled: false
- stroke color: Color.black
- outline mode: IlvText.OUTLINE_DISABLED
- outline color: Color.black
- outline thickness: 0
- antialiasing: false
- strikethrough: false
- underline: false
- paint absolute: false
- keeping aspect ratio: false
- auto wrapping resize mode: IlvText.NO_AUTO_WRAPPING
- wrapping mode: IlvText.WRAP_NONE
- wrapping width: 100
- wrapping height: 100
- Interline spacing: -1
- alignment: IlvConstants.LEADING
- rotation alignment angle: 0
- rotation alignment threshold angle: 0
- left margin: 0
- right margin: 0
- top margin: 0
- bottom margin: 0
Example

The following code example shows how to use an IlvText in a simple Java application:
```
  IlvManager manager = new IlvManager();
      
  IlvText myDefaultText = new IlvText(new IlvPoint(10,20), "Default text");    
  IlvText myCustomText = new IlvText(new IlvPoint(60,60), "My Custom\ntext");
  
  myCustomText.setFillOn(true);
  IlvRect textShape = myCustomText.boundingBox();
  myCustomText.setFillPaint(
    new GradientPaint(
      new Point(textShape.xFloor(),
        textShape.yFloor()),
        Color.yellow,
        new Point(textShape.xFloor() + textShape.widthFloor(),
          textShape.yFloor() + textShape.heightFloor()),
        Color.red));
  
  myCustomText.setStrokeOn(true);
  myCustomText.setStrokeColor(Color.blue);
  
  myCustomText.setAlignment(IlvConstants.CENTER);
  myCustomText.setFont(new Font("SansSerif", Font.BOLD, 14));
  myCustomText.setForeground(Color.green);
  myCustomText.setUnderline(true);
  myCustomText.setInterlineSpacing(4);
  
  myCustomText.setLeftMargin(20);
  myCustomText.setRightMargin(20);
  myCustomText.setBottomMargin(20);
  myCustomText.setTopMargin(20);
  
  manager.addObject( myDefaultText, true);
  manager.addObject( myCustomText, true);
 
```
The following image shows the graphic objects created in the code example:

About Graphic Objects

IlvText is a custom graphic object, that is, a subclass of IlvGraphic. Graphic objects are controlled using an IlvManager instance and displayed using one or more IlvManagerView instances in a Java Swing application. For information about generic features for graphic objects, see IlvGraphic.
Since:

JViews 6.0

See Also:

IlvRect, IlvManager, IlvManagerView, IlvConstants, IlvHTMLText, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IlvText.Editor
This is the text editor of IlvText.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvText.Editor` This is the text editor of IlvText.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NO_AUTO_WRAPPING` Auto wrapping resize mode.
`static int`	`OUTLINE_BACK` Outline mode that the text draws first its text and then its outline.
`static int`	`OUTLINE_DISABLED` Outline mode that the text does not draw its outline.
`static int`	`OUTLINE_FRONT` Outline mode that the text draws its outline after drawing its text.
`static int`	`OUTLINE_ONLY` Outline mode that the text draws only its outline.
`static int`	`SIZE_AUTO_WRAPPING` Auto wrapping resize mode.
`static short`	`WRAP_CHARACTER` The text is broken into several lines at line break characters and additional line breaks occur at character boundaries such that the text best fits the `getWrappingWidth()` width.
`static short`	`WRAP_NONE` The text is fully displayed and the lines are broken only where the text explicitly contains line break characters.
`static short`	`WRAP_TRUNCATE` The text is broken into several lines at line break characters and an ellipsis is added to the end of each line such that the text fits the `getWrappingHeight()` height and `getWrappingWidth()` width.
`static short`	`WRAP_WORD` The text is broken into several lines at line break characters and additional line breaks occur at word boundaries such that the text best fits the `getWrappingWidth()` width.
`static int`	`ZOOM_AUTO_WRAPPING` Auto wrapping resize mode.

Constructor Summary

Constructors
Constructor and Description
`IlvText()` Creates a new `IlvText` instance with `(0, 0)` as anchor point and an empty text.
`IlvText(IlvInputStream stream)` r This build an `IlvText` instance from an `IlvInputStream`.
`IlvText(IlvPoint anchor, String text)` Creates a new `IlvText` instance with a specified anchor point.
`IlvText(IlvText source)` This build an `IlvText` instance equivalent to the `source` one.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Paint`	`adaptPaint(Shape shape, Paint paint)` Returns a new `Paint` object that will fit the shape parameter according to the initial paint parameter.
`void`	`addLabelAttribute(AttributedCharacterIterator.Attribute attribute, Object value)` This convenience method allows you to modify a text attribute of the label.
`void`	`addLabelAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)` This convenient method allows you to modify a text attribute of the label.
`void`	`addLabelAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes, int beginIndex, int endIndex)` This convenient method allows you to modify a text attribute of the label.
`void`	`applyTransform(IlvTransformer t)` Applies an additional transformation to the rendering of the `IlvText`.
`void`	`baseTextDirectionChanged(int oldBaseTextDirection, int newBaseTextDirection)` Called when the object is base text direction sensitive and the resolved base text direction has changed.
`IlvRect`	`boundingBox(IlvTransformer t)` Returns the bounding rectangle of the `IlvText`.
`void`	`componentOrientationChanged(ComponentOrientation oldOri, ComponentOrientation newOri)` Called when the object is component orientation sensitive and the component orientation has changed.
`boolean`	`contains(IlvPoint p, IlvPoint tp, IlvTransformer t)` Tests if a point lies within the outline of the object.
`IlvGraphic`	`copy()` Returns a copy of the `IlvText` instance.
`void`	`draw(Graphics dst, IlvTransformer t)` Draws the `IlvText` object.
`int`	`getAlignment()` Return the alignment of the multilines text.
`IlvPoint`	`getAnchorPoint()` Returns the anchor point for the text.
`IlvPoint[]`	`getAnchorPoints(boolean leading, IlvTransformer t)` Returns the array of anchor points for all the lines.
`int`	`getAnchorPosition()` Returns the anchor position for the text.
`AttributedString`	`getAttributedLabel()` Returns the attributed text that will be displayed by the `IlvText`.
`int`	`getAutoWrappingResizeMode()` Returns the auto resize mode.
`double`	`getBottomMargin()` Returns the bottom margin of the box around the text.
`Shape`	`getCaretShape(IlvTextSelection.Range range, IlvTransformer t)` This method is called to get the shape enveloping the characters specified by the `Range`.
`IlvPoint`	`getEffectiveAnchorPoint()` Returns the effective anchor point.
`Paint`	`getFillPaint()` Returns the `Paint` object used to fill the background rectangle.
`Font`	`getFont()` Returns the `Font` used to draw the text.
`Color`	`getForeground()` Returns the foreground color of object, i.e the color used to draw the text itself.
`double`	`getInterlineSpacing()` Returns the interline spacing used when the text is displayed as several lines.
`String`	`getLabel()` Returns the label that will be displayed by the `IlvText`.
`IlvRect`	`getLabelBBox(IlvTransformer t)` Returns the bounding rectangle of the text part of the `IlvText`.
`double`	`getLeftMargin()` Returns the left margin of the box around the text.
`Color`	`getOutlineColor()` Returns the outline color of the text.
`int`	`getOutlineMode()` Returns the outline mode.
`double`	`getOutlineThickness()` Returns the outline thickness of the text.
`double`	`getRightMargin()` Returns the right margin of the box around the text.
`double`	`getRotationAlignmentAngle()` Returns the rotation alignment angle.
`double`	`getRotationAlignmentThresholdAngle()` Returns the threshold angle that decides whether a rotated multiline text object is aligned parallel to the rotation alignment axis, or perpendicular to the rotation alignment axis.
`Color`	`getStrokeColor()` Returns the stroke color of the object, i.e the color used to draw the stroke around the background rectangle.
`double`	`getTopMargin()` Returns the top margin of the box around the text.
`IlvTransformer`	`getTransformer()` Returns the internal transformation used to draw the label in addition to the `IlvManagerView` transformation.
`double`	`getWrappingHeight()` Returns the wrapping height of the text.
`short`	`getWrappingMode()` Returns the wrapping mode of the text.
`double`	`getWrappingWidth()` Returns the wrapping width of the text.
`boolean`	`isAntialiasing()` Returns `true` if the anti-aliasing mode of the text is on.
`boolean`	`isAutoWrappingSizeMode()` Deprecated. Since JViews 8.8, use `getAutoWrappingResizeMode()`.
`boolean`	`isBaseTextDirectionSensitive()` Returns `true` because the bounding box of this object depends on its text direction.
`boolean`	`isFillOn()` Returns `true` if the background rectangle of the text is drawn.
`boolean`	`isFractionalMetrics()` Returns `true` if the fractional metrics mode of the text is on.
`boolean`	`isKeepingAspectRatio()` Returns `true` if the text keeps the aspect ratio; otherwise it returns `false`.
`boolean`	`isLocaleSensitive()` Returns `true` if the bounding box of this object depends on the locale of this object.
`boolean`	`isPaintAbsolute()` Returns `false` if the `TexturePaint` or `GradientPaint` will be adapted to the bounding rectangle of the object.
`boolean`	`isStrikethrough()` Returns `true` if the entire text has strikethrough attribute.
`boolean`	`isStrokeOn()` Returns `true` if the frame of the background rectangle of the text is drawn.
`static boolean`	`IsTransformerDependentRendering()` Returns whether all `IlvText` objects are rendered with a strategy that requires re-rendering when the transformer changes.
`boolean`	`isTruncated()` Returns whether the label is truncated or fully visible.
`boolean`	`isUnderline()` Returns `true` if the entire text has underline attribute.
`int`	`lineCount()` Returns the line count for a multiline text.
`int`	`lineOffset(int index)` For a multiline label, you need to know the start offset for a specified line.
`void`	`localeChanged(com.ibm.icu.util.ULocale oldLocale, com.ibm.icu.util.ULocale newLocale)` Called when the object is locale sensitive and the locale has changed.
`IlvSelection`	`makeSelection()` Create an `IlvTextSelection`.
`void`	`moveResize(IlvRect size)` Resizes the object.
`int`	`pickCharacter(IlvPoint click, IlvTransformer t)` This method is called when a user is clicking on the label to hit-test which character is clicked.
`void`	`resize(double neww, double newh)` Resizes the object.
`void`	`rotate(IlvPoint center, double angle)` Rotates the object.
`void`	`setAlignment(int alignment)` Changes the alignment of the multilines text.
`void`	`setAnchorPoint(IlvPoint anchor)` Sets the anchor point for the text.
`void`	`setAnchorPosition(int position)` Sets the anchor position for the text.
`void`	`setAntialiasing(boolean set)` Changes the anti-aliasing mode of the text.
`void`	`setAttributedLabel(AttributedString label)` Sets the attributed text that will be displayed by the `IlvText`.
`void`	`setAutoWrappingResizeMode(int mode)` Sets the auto wrapping resize mode.
`void`	`setAutoWrappingSizeMode(boolean value)` Deprecated. Since JViews 8.8, use `setAutoWrappingResizeMode(int)`.
`void`	`setBackground(Color c)` Changes the background color of the object, i.e the color used to fill the background rectangle.
`void`	`setBottomMargin(double margin)` Sets the bottom margin of the box around the text.
`void`	`setFillOn(boolean value)` Changes the visibility of the background rectangle of the text.
`void`	`setFillPaint(Paint paint)` Changes the background `Paint` of the object, i.e the paint server used to fill the background rectangle.
`void`	`setFont(Font font)` Sets the `Font` used to draw the entire `IlvText`.
`void`	`setForeground(Color c)` Changes the foreground color of the object, i.e the color used to draw the text itself.
`void`	`setFractionalMetrics(boolean set)` Changes the fractional metrics mode of the text.
`void`	`setInterlineSpacing(double spacing)` Sets the interline spacing used when the text is displayed as several lines.
`void`	`setKeepingAspectRatio(boolean set)` Allows or inhibits the ability to have different zoom factors along the x and y axes.
`void`	`setLabel(String label)` Sets the label that will be displayed by the `IlvText`.
`void`	`setLeftMargin(double margin)` Sets the left margin of the box around the text.
`void`	`setOutlineColor(Color c)` Changes the outline color of the text.
`void`	`setOutlineMode(int mode)` Sets the outline mode.
`void`	`setOutlineThickness(double thickness)` Changes the outline thickness of the text.
`void`	`setPaintAbsolute(boolean set)` When set to `false`, specifies that the `TexturePaint` or `GradientPaint` will be adapted to the bounding rectangle of the object.
`void`	`setRightMargin(double margin)` Sets the right margin of the box around the text.
`void`	`setRotationAlignmentAngle(double angle)` Sets the rotation alignment angle.
`void`	`setRotationAlignmentThresholdAngle(double angle)` Sets the threshold angle that decides whether a rotated multiline text object is aligned parallel to the rotation alignment axis, or perpendicular to the rotation alignment axis.
`void`	`setStrikethrough(boolean set)` Changes the strikethrough attribute of the entire text.
`void`	`setStrokeColor(Color c)` Changes the stroke color of the object, i.e the color used to draw the stroke around the background rectangle.
`void`	`setStrokeOn(boolean value)` Changes the visibility of the stroke of the background rectangle.
`void`	`setTopMargin(double margin)` Sets the top margin of the box around the text.
`static void`	`SetTransformerDependentRendering(boolean flag)` Sets whether all `IlvText` objects are rendered with a strategy that requires re-rendering when the transformer changes.
`void`	`setUnderline(boolean set)` Changes the underline attribute of the entire text.
`void`	`setWrappingHeight(double height)` Sets the wrapping height of the text.
`void`	`setWrappingMode(short value)` Changes the wrapping mode of the text.
`void`	`setWrappingWidth(double width)` Sets the wrapping width of the text.
`boolean`	`supportMultiline()` Always returns `true` for `IlvText`.
`void`	`translate(double dx, double dy)` Translates the object.
`boolean`	`usesBidiMarkers()` Returns `true` if in-place editing implementation uses markers, which should be taken into account in hit-to-point and point-to-hit calculations.
`void`	`write(IlvOutputStream stream)` Writes the contents of the `IlvText` to an IVL file.

Methods inherited from class ilog.views.IlvBidiGraphic
calcResolvedBaseTextDirection, getBaseTextDirection, getComponentOrientation, getResolvedBaseTextDirection, getULocale, invalidateBidiCache, setBaseTextDirection, setBaseTextDirection, setBaseTextDirectionDuringConstruction

Methods inherited from class ilog.views.IlvGraphic
addActionListener, addNamedPropertyListener, allViewsRemoved, blinkingStateOn, boundingBox, callDraw, getAndAssociateObjectInteractor, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isMovable, isPersistent, isSelectable, isVisible, move, move, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, scale, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, updateNeedsViewNotification, viewAddedOrRemoved, zoomable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - OUTLINE_ONLY
```
public static final int OUTLINE_ONLY
```
    Outline mode that the text draws only its outline.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setOutlineMode(int), getOutlineMode(), Constant Field Values
  - OUTLINE_FRONT
```
public static final int OUTLINE_FRONT
```
    Outline mode that the text draws its outline after drawing its text.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setOutlineMode(int), getOutlineMode(), Constant Field Values
  - OUTLINE_BACK
```
public static final int OUTLINE_BACK
```
    Outline mode that the text draws first its text and then its outline.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setOutlineMode(int), getOutlineMode(), Constant Field Values
  - OUTLINE_DISABLED
```
public static final int OUTLINE_DISABLED
```
    Outline mode that the text does not draw its outline.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setOutlineMode(int), getOutlineMode(), Constant Field Values
  - WRAP_NONE
```
public static final short WRAP_NONE
```
    The text is fully displayed and the lines are broken only where the text explicitly contains line break characters.
    
    See Also:
    
    setWrappingMode(short), Constant Field Values
  - WRAP_WORD
```
public static final short WRAP_WORD
```
    The text is broken into several lines at line break characters and additional line breaks occur at word boundaries such that the text best fits the getWrappingWidth() width.
    
    See Also:
    
    setWrappingMode(short), Constant Field Values
  - WRAP_CHARACTER
```
public static final short WRAP_CHARACTER
```
    The text is broken into several lines at line break characters and additional line breaks occur at character boundaries such that the text best fits the getWrappingWidth() width.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setWrappingMode(short), Constant Field Values
  - WRAP_TRUNCATE
```
public static final short WRAP_TRUNCATE
```
    The text is broken into several lines at line break characters and an ellipsis is added to the end of each line such that the text fits the getWrappingHeight() height and getWrappingWidth() width.
    Note: In this mode, the text can be selected but cannot be edited in place by using the new IlvTextSelection introduced since JViews 7.5. However the text can still be edited by the IlvEditLabelInteractor.
    
    See Also:
    
    setWrappingMode(short), Constant Field Values
  - NO_AUTO_WRAPPING
```
public static final int NO_AUTO_WRAPPING
```
    Auto wrapping resize mode. Subsequent calls to moveResize(IlvRect) and resize(double, double). do not change the wrapping, but change the internal zoom of the IlvText to adjust to the new size, by calling applyTransform(IlvTransformer).
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setAutoWrappingResizeMode(int), Constant Field Values
  - SIZE_AUTO_WRAPPING
```
public static final int SIZE_AUTO_WRAPPING
```
    Auto wrapping resize mode. Subsequent calls to moveResize(IlvRect) and resize(double, double). change the wrapping width and height but not the internal zoom of the IlvText. This mode makes only sense when the wrapping mode is not WRAP_NONE. If the wrapping mode is WRAP_NONE, the object cannot be resized.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setAutoWrappingResizeMode(int), Constant Field Values
  - ZOOM_AUTO_WRAPPING
```
public static final int ZOOM_AUTO_WRAPPING
```
    Auto wrapping resize mode. Subsequent calls to moveResize(IlvRect) and resize(double, double). change the wrapping width and height and the internal zoom of the IlvText. The wrapping width and height are changed to match as much as possible the given aspect ratio, then the IlvText is zoomed while keeping the aspect ratio to match as much as possible the given size. This mode is suitable if you want to display an automatically wrapped label in a given area at maximal possible zoom. This mode is relatively slow and does not support rotated labels. This mode makes only sense when the wrapping mode is not WRAP_NONE and does not include the WRAP_TRUNCATE flag. If the wrapping mode is WRAP_NONE, the object is resized by changing the internal zoom while keeping the aspect ratio.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setAutoWrappingResizeMode(int), Constant Field Values
- Constructor Detail
  - IlvText
```
public IlvText()
```
    Creates a new IlvText instance with (0, 0) as anchor point and an empty text.
    
    See Also:
    
    IlvText(IlvPoint, String)
  - IlvText
```
public IlvText(IlvPoint anchor,
               String text)
```
    Creates a new IlvText instance with a specified anchor point.
    
    Parameters:
    
    anchor - the anchor point in manager coordinates.
    
    text - the text to be displayed.
    
    See Also:
    
    setAnchorPoint(IlvPoint), setAnchorPosition(int), setLabel(String)
  - IlvText
```
public IlvText(IlvText source)
```
    This build an IlvText instance equivalent to the source one.
    
    Parameters:
    
    source - The IlvText to be copied.
  - IlvText
```
public IlvText(IlvInputStream stream)
        throws IlvReadFileException
```
    r This build an IlvText instance from an IlvInputStream.
    
    Parameters:
    
    stream - the input stream
    
    Throws:
    
    IlvReadFileException - if the format is not correct.
- Method Detail
  - copy
```
public IlvGraphic copy()
```
    Returns a copy of the IlvText instance.
    
    Specified by:
    
    copy in class IlvGraphic
    
    Returns:
    
    A copy of this IlvGraphic instance.
    
    See Also:
    
    IlvGraphic
  - draw
```
public void draw(Graphics dst,
                 IlvTransformer t)
```
    Draws the IlvText object.
    
    Specified by:
    
    draw in class IlvGraphic
    
    Parameters:
    
    dst - The destination Graphics.
    
    t - The view transformation used to draw the object.
    
    See Also:
    
    IlvGraphic.callDraw(Graphics,IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvGraphic.zoomable(), IlvGraphic
  - getTransformer
```
public final IlvTransformer getTransformer()
```
    Returns the internal transformation used to draw the label in addition to the IlvManagerView transformation. When applyTransform(IlvTransformer) is called its parameter transformer is concatenated to this transformer. The returned value may be null if no transformer has been applied.
  - boundingBox
```
public IlvRect boundingBox(IlvTransformer t)
```
    Returns the bounding rectangle of the IlvText.
    
    Specified by:
    
    boundingBox in class IlvGraphic
    
    Parameters:
    
    t - The view transformer used to draw the object.
    
    See Also:
    
    IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.zoomable(), IlvGraphic
  - applyTransform
```
public void applyTransform(IlvTransformer t)
```
    Applies an additional transformation to the rendering of the IlvText. This can be used to rotate or scale the text.
    
    Specified by:
    
    applyTransform in class IlvGraphic
    
    Parameters:
    
    t - The transformer to be applied.
    
    See Also:
    
    IlvGraphic
  - moveResize
```
public void moveResize(IlvRect size)
```
    Resizes the object. The behavior depends on the auto wrapping resize mode. The possibilities of getAutoWrappingResizeMode() are:
    - NO_AUTO_WRAPPING - This method calls IlvGraphic.moveResize(IlvRect), which in turn calls applyTransform(IlvTransformer). The wrapping width and height are not changed, but the internal zoom of the IlvText is changed to adjust to the new size.
    - SIZE_AUTO_WRAPPING - This method changes the wrapping width and height to match the given size and then translates the object so that the effective anchor is at the new position. The internal zoom is not changed.
    - ZOOM_AUTO_WRAPPING - This method changes the wrapping width and height to match the aspect ratio of the given size, then zooms the object while keeping the aspect ratio to match the given size. This is suitable if you want to display an automatically wrapped label in a given area at maximal possible zoom.
    Overrides:
    
    moveResize in class IlvGraphic
    
    Parameters:
    
    size - The new bounding rectangle of the object.
    
    See Also:
    
    setAutoWrappingResizeMode(int), setWrappingWidth(double), setWrappingHeight(double), getEffectiveAnchorPoint()
  - translate
```
public void translate(double dx,
                      double dy)
```
    Translates the object.
    
    Overrides:
    
    translate in class IlvGraphic
    
    Parameters:
    
    dx - The horizontal translation factor.
    
    dy - The vertical translation factor.
    
    See Also:
    
    IlvGraphic, IlvGraphic.applyTransform(IlvTransformer)
  - resize
```
public void resize(double neww,
                   double newh)
```
    Resizes the object. The behavior depends on the auto wrapping resize mode. The possibilities of getAutoWrappingResizeMode() are:
    - NO_AUTO_WRAPPING - This method calls IlvGraphic.resize(double, double), which in turn calls applyTransform(IlvTransformer). The wrapping width and height are not changed, but the internal zoom of the IlvText is changed to adjust to the new size.
    - SIZE_AUTO_WRAPPING - This method changes the wrapping width and height to match the given size. The internal zoom is not changed.
    - ZOOM_AUTO_WRAPPING - This method changes the wrapping width and height to match the aspect ratio of the given size, then zooms the object while keeping the aspect ratio to match the given size. This is suitable if you want to display an automatically wrapped label in a given area at maximal possible zoom.
    Overrides:
    
    resize in class IlvGraphic
    
    Parameters:
    
    neww - The new width
    
    newh - The new height
    
    See Also:
    
    setAutoWrappingResizeMode(int), setWrappingWidth(double), setWrappingHeight(double), getEffectiveAnchorPoint()
  - rotate
```
public void rotate(IlvPoint center,
                   double angle)
```
    Rotates the object. Rotates this object by angle degrees around the point center. The center must be given in untransformed coordinates. The default implementation calls applyTransform(ilog.views.IlvTransformer) to rotate the graphic object.
    
    Overrides:
    
    rotate in class IlvGraphic
    
    Parameters:
    
    center - The center of the rotation.
    
    angle - The rotation angle in degrees.
    
    See Also:
    
    IlvGraphic, applyTransform(IlvTransformer)
  - setAnchorPoint
```
public final void setAnchorPoint(IlvPoint anchor)
```
    Sets the anchor point for the text. This specifies to which point in manager coordinate (before applying getTransformer()) the text will be attached to.
    
    Parameters:
    
    anchor - the anchor point.
    
    See Also:
    
    setAnchorPosition(int)
  - getAnchorPoint
```
public final IlvPoint getAnchorPoint()
```
    Returns the anchor point for the text. This is the point in manager coordinate (before applying getTransformer()) the text is attached to.
    
    See Also:
    
    getAnchorPosition()
  - getEffectiveAnchorPoint
```
public final IlvPoint getEffectiveAnchorPoint()
```
    Returns the effective anchor point. The anchor point obtained with getAnchorPoint() is the anchor of the untransformed text object. However as soon as the text object is moved or reshaped, the text object is transformed. This method returns the anchor point while respecting this transformation. The meaning of the anchor point depends on the font and on the string displayed in the text. For instance for Latin based fonts with western European text (English, French, German etc., i.e. text with left-to-right orientation), the effective anchor point specifies:
    - The left corner of the base line of the first lines of text, if the anchor position is IlvConstants.LEFT or IlvConstants.LEADING. If the text is multiline text and the lines have different widths, the maximum width of all lines defines the corners of each line.
    - The right corner of the base line of the first lines of text, if the anchor position is IlvConstants.RIGHT or IlvConstants.TRAILING. If the text is multiline text and the lines have different widths, the maximum width of all lines defines the corners of each line.
    - The center of the text (independent from the base lines), if the anchor position is IlvConstants.CENTER.
    Since:
    
    JViews 8.1
  - setAnchorPosition
```
public final void setAnchorPosition(int position)
```
    Sets the anchor position for the text. This specifies which side of the text is used to attach it to the anchor point.
    Parameters:
    position - the anchor position. One of the following values:
    
    IlvConstants.LEFT: the anchor point is at the left side of the first line of the text.
    IlvConstants.RIGHT: the anchor point is at the right side of the first line of the text.
    IlvConstants.CENTER: the anchor point is at the center of the text.
    IlvConstants.LEADING: the anchor point is at the leading edge of the first line of the text (the default).
    IlvConstants.TRAILING: the anchor points is at the trailing edge of the first line of the text.
    See Also:
    
    setAnchorPoint(IlvPoint)
  - getAnchorPosition
```
public final int getAnchorPosition()
```
    Returns the anchor position for the text. This specifies which side of the text is used to attach it to the anchor point.
    Returns:
    One of the following values:
    
    IlvConstants.LEFT: the anchor point is at the left side of the first line of the text.
    IlvConstants.RIGHT: the anchor point is at the right side of the first line of the text.
    IlvConstants.CENTER: the anchor point is at the center of the text.
    IlvConstants.LEADING: the anchor point is at the leading edge of the first line of the text (the default).
    IlvConstants.TRAILING: the anchor points is at the trailing edge of the first line of the text.
    See Also:
    
    setAnchorPoint(IlvPoint)
  - getAnchorPoints
```
public IlvPoint[] getAnchorPoints(boolean leading,
                                  IlvTransformer t)
```
    Returns the array of anchor points for all the lines. This is useful when calculating a position of rotated aligned multiline text relative to other objects. If this text has no lines, it returns only one point, the anchor point. If this text has 1 line, it returns 3 points: the by the ascent of the line shifted anchor point, the real anchor point, and the by the descent of the line shifted anchor point. If we have n lines, it returns n+2 points, starting with the by the ascent of the first line shifted anchor point, then the real anchor points of each line in the middle, and ending with the by the descent of the last line shifted anchor point.
    Depending on the text alignment, either the leading or the trailing anchor points make more sense. For instance in left-to-right orientation, the leading anchor points are aligned if the text alignment is IlvConstants.LEADING or IlvConstants.LEFT, while the trailing anchor points are not aligned; and it is just the opposite when the text alignment is IlvConstants.TRAILING or IlvConstants.RIGHT.
    One application is for instance to place the middle of the aligned side at a given position: Calculate the middle of the anchor points (this can, according to your taste, either be the middle of the first and last returned point, or the anchor point at the middle position of the returned array). The difference between the calculated middle point and the desired position gives the amount to shift the text.
    
    Parameters:
    
    leading - Whether to calculate the leading or trailing anchors.
    
    t - The transformer to draw this text in the view.
    
    Returns:
    
    The anchor points in view coordinates.
    
    Since:
    
    JViews 8.6
    
    See Also:
    
    setAlignment(int)
  - setLabel
```
public void setLabel(String label)
```
    Sets the label that will be displayed by the IlvText. If the label contains line breaking characters ('\n') it will be displayed on several lines. Depending on the value of getWrappingMode() the text will be drawn differently.
    Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    
    Specified by:
    
    setLabel in interface IlvLabelInterface
    
    Parameters:
    
    label - the new label.
  - getLabel
```
public String getLabel()
```
    Returns the label that will be displayed by the IlvText. This method returns the label even if it was set via setAttributedLabel(java.text.AttributedString).
    
    Specified by:
    
    getLabel in interface IlvLabelInterface
    
    See Also:
    
    setLabel(String)
  - setAttributedLabel
```
public void setAttributedLabel(AttributedString label)
```
    Sets the attributed text that will be displayed by the IlvText. If the text contains line breaking characters ('\n') it will be displayed on several lines. Depending on the value of getWrappingMode() the text will be drawn differently.
    All text attributes can be used. However, the label is assumed to be unidirectional, that is, bidi changes (for example, mixing LTR orientation with RTL orientation) inside the same label are not supported. Partial font attributes (such as TextAttribute.WEIGHT) cannot be specified individually, since the font specification overrides them, but it is possible to specify the full TextAttribute.FONT attribute for selected parts of the string.
    Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    
    Parameters:
    
    label - the new label.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    TextAttribute
  - getAttributedLabel
```
public AttributedString getAttributedLabel()
```
    Returns the attributed text that will be displayed by the IlvText. If you modify the attributes of the returned attributed text, you need to call setAttributedLabel(java.text.AttributedString) again so that the new attributes become valid. A more comfortable way is to modify the text attributes via addLabelAttribute(java.text.AttributedCharacterIterator.Attribute, Object, int, int).
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setAttributedLabel(AttributedString), addLabelAttribute(java.text.AttributedCharacterIterator.Attribute, Object), addLabelAttribute(java.text.AttributedCharacterIterator.Attribute, Object, int, int), addLabelAttributes(Map, int, int)
  - addLabelAttribute
```
public void addLabelAttribute(AttributedCharacterIterator.Attribute attribute,
                              Object value)
```
    This convenience method allows you to modify a text attribute of the label. It adds a text attribute to the entire string, like AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, Object).
    Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    
    Parameters:
    
    attribute - The attribute key.
    
    value - The value of the attribute; may be null.
    
    Throws:
    
    IllegalArgumentException - if the AttributedString has length 0. (attributes cannot be applied to a 0-length range).
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    addLabelAttribute(java.text.AttributedCharacterIterator.Attribute, Object, int, int), TextAttribute
  - addLabelAttribute
```
public void addLabelAttribute(AttributedCharacterIterator.Attribute attribute,
                              Object value,
                              int beginIndex,
                              int endIndex)
```
    This convenient method allows you to modify a text attribute of the label. It adds a text attribute to a subrange of the string, like AttributedString.addAttribute(java.text.AttributedCharacterIterator.Attribute, Object, int, int).
    For instance, in order to create a text label and underline the 3th and 4th character of the label, call
```
 IlvText text = new IlvText(new IlvPoint(0,0), "ABCDEFG");
 text.addLabelAttribute(TextAttribute.UNDERLINE,
                        TextAttribute.UNDERLINE_ON,
                        3, 5);
 
```
    All text attributes can be used. However, the label is assumed to be unidirectional, that is, bidi changes (for example, mixing LTR orientation with RTL orientation) inside the same label are not supported. Partial font attributes (such as TextAttribute.WEIGHT) cannot be specified individually, since the font specification overrides them, but it is possible to specify the full TextAttribute.FONT attribute for selected parts of the string.
    Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    Parameters:
    
    attribute - The attribute key.
    
    value - The value of the attribute; may be null.
    
    beginIndex - Index of the first character of the range.
    
    endIndex - Index of the character following the last character of the range.
    
    Throws:
    
    IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    TextAttribute
  - addLabelAttributes
```
public void addLabelAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes,
                               int beginIndex,
                               int endIndex)
```
    This convenient method allows you to modify a text attribute of the label. It adds a set of attributes to a subrange of the string, like AttributedString.addAttributes(Map, int, int).
    All text attributes can be used. However, the label is assumed to be unidirectional, that is bidi changes (for example, mixing LTR orientation with RTL orientation) inside the same label are not supported. Partial font attributes (such as TextAttribute.WEIGHT) cannot be specified individually, since the font specification overrides them, but it is possible to specify the full TextAttribute.FONT attribute for selected parts of the string.
    Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    
    Parameters:
    
    attributes - The attributes to be added to the string.
    
    beginIndex - Index of the first character of the range.
    
    endIndex - Index of the character following the last character of the range.
    
    Throws:
    
    IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    addLabelAttribute(java.text.AttributedCharacterIterator.Attribute, Object, int, int), TextAttribute
  - supportMultiline
```
public boolean supportMultiline()
```
    Always returns true for IlvText.
    
    Specified by:
    
    supportMultiline in interface IlvLabelInterface
  - isTruncated
```
public final boolean isTruncated()
```
    Returns whether the label is truncated or fully visible. If the wrapping mode contains the IlvText.WRAP_TRUNCATE bit, the label might not be fully visible, as it can get truncated and an ellipsis (...) is displayed instead of the remaining parts of the label. This method returns true if the label is truncated, and false if the label is fully visible.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setWrappingMode(short)
  - getLabelBBox
```
public IlvRect getLabelBBox(IlvTransformer t)
```
    Returns the bounding rectangle of the text part of the IlvText. It is equivalent to boundingBox(IlvTransformer) without the margins.
    
    Specified by:
    
    getLabelBBox in interface IlvLabelInterface
    
    Parameters:
    
    t - the transformer used to draw the graphic object.
  - setFont
```
public void setFont(Font font)
```
    Sets the Font used to draw the entire IlvText.
    If an attributed string label is used, the local attributes on the attributed string dominate, i.e. set font is only set to those characters of the attributed string that don't have any local font attribute.
    
    Specified by:
    
    setFont in interface IlvFontInterface
    
    Parameters:
    
    font - The new font.
    
    See Also:
    
    setAttributedLabel(java.text.AttributedString)
  - getFont
```
public Font getFont()
```
    Returns the Font used to draw the text.
    
    Specified by:
    
    getFont in interface IlvFontInterface
  - isAntialiasing
```
public final boolean isAntialiasing()
```
    Returns true if the anti-aliasing mode of the text is on. The default value is false.
  - setAntialiasing
```
public final void setAntialiasing(boolean set)
```
    Changes the anti-aliasing mode of the text. The default value is false. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
  - isStrikethrough
```
public final boolean isStrikethrough()
```
    Returns true if the entire text has strikethrough attribute. The default value is false.
    
    Since:
    
    JViews 7.5
  - setStrikethrough
```
public final void setStrikethrough(boolean set)
```
    Changes the strikethrough attribute of the entire text. The default value is false. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    If an attributed string label is used, the local attributes on the attributed string dominate, that is strikethrough is only performed on those characters of the attributed string that don't have any strikethrough attribute.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setAttributedLabel(java.text.AttributedString)
  - isUnderline
```
public final boolean isUnderline()
```
    Returns true if the entire text has underline attribute. The default value is false.
    
    Since:
    
    JViews 7.5
  - setUnderline
```
public final void setUnderline(boolean set)
```
    Changes the underline attribute of the entire text. The default value is false. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
    If an attributed string label is used, the local attributes on the attributed string dominate, that is underlining is only performed on those characters of the attributed string that don't have any underline attribute.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setAttributedLabel(java.text.AttributedString)
  - getOutlineMode
```
public int getOutlineMode()
```
    Returns the outline mode.
    
    Returns:
    
    One of the following values: OUTLINE_DISABLED, OUTLINE_ONLY, OUTLINE_FRONT, and OUTLINE_BACK.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setOutlineMode(int)
  - setOutlineMode
```
public void setOutlineMode(int mode)
```
    Sets the outline mode.
    
    Parameters:
    
    mode - Must be one of the following values: OUTLINE_DISABLED, OUTLINE_ONLY, OUTLINE_FRONT, and OUTLINE_BACK.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    getOutlineMode()
  - isFractionalMetrics
```
public final boolean isFractionalMetrics()
```
    Returns true if the fractional metrics mode of the text is on. The default value is true, setting it to false will speed up the IlvText but may lead to less precise text positioning.
  - setFractionalMetrics
```
public final void setFractionalMetrics(boolean set)
```
    Changes the fractional metrics mode of the text. The default value is true, setting it to false will speed up the IlvText but may lead to less precise text positioning. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager, you should modify this flag using the applyToObject method of the manager.
  - setForeground
```
public void setForeground(Color c)
```
    Changes the foreground color of the object, i.e the color used to draw the text itself. This property supports IlvBlinkingColor.
    
    Overrides:
    
    setForeground in class IlvGraphic
    
    Parameters:
    
    c - The new color.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic
  - getForeground
```
public Color getForeground()
```
    Returns the foreground color of object, i.e the color used to draw the text itself. The default value is Color.BLACK.
  - setOutlineColor
```
public void setOutlineColor(Color c)
```
    Changes the outline color of the text. This property supports IlvBlinkingColor.
    
    Parameters:
    
    c - The new outline color.
    
    Since:
    
    JViews 8.1
  - getOutlineColor
```
public Color getOutlineColor()
```
    Returns the outline color of the text. The default value is Color.BLACK.
    
    Since:
    
    JViews 8.1
  - setBackground
```
public void setBackground(Color c)
```
    Changes the background color of the object, i.e the color used to fill the background rectangle. It calls setFillPaint(java.awt.Paint).
    
    Overrides:
    
    setBackground in class IlvGraphic
    
    Parameters:
    
    c - The new color.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setForeground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic
  - setFillPaint
```
public void setFillPaint(Paint paint)
```
    Changes the background Paint of the object, i.e the paint server used to fill the background rectangle. This property supports IlvBlinkingPaint.
    
    Parameters:
    
    paint - the new Paint object.
  - getFillPaint
```
public Paint getFillPaint()
```
    Returns the Paint object used to fill the background rectangle. The default value is Color.GRAY.
    
    See Also:
    
    setFillPaint(java.awt.Paint)
  - adaptPaint
```
protected Paint adaptPaint(Shape shape,
                           Paint paint)
```
    Returns a new Paint object that will fit the shape parameter according to the initial paint parameter. This method is called only if isPaintAbsolute() returns false. By default, it deals with GradientPaint and TexturePaint instances to adapt them correctly because they do not automatically fit the shape of the object on which they are drawn. You can override this method to manage your own Paint subclasses if they do not take the shape of the object into account. You will generally call the superclass method for GradientPaint and TexturePaint instances. Other Paint objects deriving from IlvMultipleGradientPaint automatically take into account the shape of the object if their IlvMultipleGradientPaint.isAdapting() method returns true and thus are not modified by this method.
    
    Parameters:
    
    shape - The shape parameter that the returned Paint should fit.
    
    paint - The initial Paint object.
    
    See Also:
    
    isPaintAbsolute()
  - isPaintAbsolute
```
public final boolean isPaintAbsolute()
```
    Returns false if the TexturePaint or GradientPaint will be adapted to the bounding rectangle of the object. The default value is false. This value does not affect automatically adjusted Paint such as ilog.views.util.java2d.IlvLinearGradientPaint.
    
    See Also:
    
    setPaintAbsolute(boolean), setFillPaint(java.awt.Paint), adaptPaint(java.awt.Shape, java.awt.Paint)
  - setPaintAbsolute
```
public final void setPaintAbsolute(boolean set)
```
    When set to false, specifies that the TexturePaint or GradientPaint will be adapted to the bounding rectangle of the object. The default value is false. This value does not affect automatically adjusted Paint such as ilog.views.util.java2d.IlvLinearGradientPaint.
    
    See Also:
    
    isPaintAbsolute(), setFillPaint(java.awt.Paint), adaptPaint(java.awt.Shape, java.awt.Paint)
  - setFillOn
```
public final void setFillOn(boolean value)
```
    Changes the visibility of the background rectangle of the text.
    
    Overrides:
    
    setFillOn in class IlvGraphic
    
    Parameters:
    
    value - true if fill is on.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setForeground(Color), IlvGraphic.setStrokeOn(boolean), IlvGraphic
  - isFillOn
```
public final boolean isFillOn()
```
    Returns true if the background rectangle of the text is drawn.
    
    See Also:
    
    setFillPaint(java.awt.Paint), setFillOn(boolean)
  - setStrokeOn
```
public final void setStrokeOn(boolean value)
```
    Changes the visibility of the stroke of the background rectangle.
    
    Overrides:
    
    setStrokeOn in class IlvGraphic
    
    Parameters:
    
    value - true if stroke is on.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setForeground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic
  - isStrokeOn
```
public final boolean isStrokeOn()
```
    Returns true if the frame of the background rectangle of the text is drawn.
    
    See Also:
    
    setStrokeColor(Color), setStrokeOn(boolean)
  - setStrokeColor
```
public final void setStrokeColor(Color c)
```
    Changes the stroke color of the object, i.e the color used to draw the stroke around the background rectangle. This property supports IlvBlinkingColor.
    
    Parameters:
    
    c - The new color.
    
    See Also:
    
    getStrokeColor()
  - getStrokeColor
```
public final Color getStrokeColor()
```
    Returns the stroke color of the object, i.e the color used to draw the stroke around the background rectangle. The default value is the color returned by getForeground().
  - isKeepingAspectRatio
```
public final boolean isKeepingAspectRatio()
```
    Returns true if the text keeps the aspect ratio; otherwise it returns false. When resizing the text while the auto wrapping mode is off, the text changes the zoom level according to the desired size. This can cause different zoom levels along the x and y axes. This causes a distorted label. When KeepingAspectRatio is true, the text will verify each modification of its internal transformer so that the zoom factor remains the same along the x axis and the y axis. The default value is false.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setKeepingAspectRatio(boolean), setAutoWrappingResizeMode(int)
  - setKeepingAspectRatio
```
public final void setKeepingAspectRatio(boolean set)
```
    Allows or inhibits the ability to have different zoom factors along the x and y axes. When resizing the text while the auto wrapping mode is off, the text changes the zoom level according to the desired size. This can cause different zoom levels along the x and y axes. This causes a distorted label. When KeepingAspectRatio is true, the text will verify each modification of its internal transformer so that the zoom factor remains the same along the x axis and the y axis. The default value is false.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    isKeepingAspectRatio(), setAutoWrappingResizeMode(int)
  - setAutoWrappingSizeMode
```
@Deprecated
public final void setAutoWrappingSizeMode(boolean value)
```
    Deprecated. Since JViews 8.8, use setAutoWrappingResizeMode(int).
    
    Sets the auto wrapping size mode. The default value is false.
    
    Parameters:
    
    value - true if the auto wrapping size mode is needed.
    
    See Also:
    
    getWrappingWidth(), getWrappingHeight(), getAnchorPoint()
  - isAutoWrappingSizeMode
```
@Deprecated
public final boolean isAutoWrappingSizeMode()
```
    Deprecated. Since JViews 8.8, use getAutoWrappingResizeMode().
    
    Returns the auto resize mode. The default value is false.
  - setAutoWrappingResizeMode
```
public final void setAutoWrappingResizeMode(int mode)
```
    Sets the auto wrapping resize mode. This defines the behavior on subsequent calls to moveResize(IlvRect) and resize(double, double). The options are:
    - NO_AUTO_WRAPPING - The wrapping is not changed, but the internal zoom of the IlvText is changed to adjust to the new size, by calling applyTransform(IlvTransformer). This is the default value.
    - SIZE_AUTO_WRAPPING - The wrapping width and height are changed to match as much as possible the given size. In that case the resulting size of the IlvText may not exactly be the given size if the text doesn't require that much size to be displayed or margins require more room. The internal zoom is not changed.
      This mode makes only sense when the wrapping mode is not WRAP_NONE. If the wrapping mode is WRAP_NONE, the object cannot be resized.
    - ZOOM_AUTO_WRAPPING - The wrapping width and height are changed to match as much as possible the given aspect ratio, then the IlvText is zoomed while keeping the aspect ratio to match as much as possible the given size. This mode is suitable if you want to display an automatically wrapped label in a given area at maximal possible zoom. This mode is relatively slow and does not support rotated labels. The resulting size of the IlvText may not exactly be the given size if the text doesn't require that much size to be displayed or margins require more room.
      This mode makes only sense when the wrapping mode is not WRAP_NONE and does not include the WRAP_TRUNCATE flag. If the wrapping mode is WRAP_NONE, the object is resized by changing the internal zoom while keeping the aspect ratio.
    Parameters:
    
    mode - The auto wrapping resize mode
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getAutoWrappingResizeMode(), getWrappingMode(), getWrappingWidth(), getWrappingHeight()
  - getAutoWrappingResizeMode
```
public final int getAutoWrappingResizeMode()
```
    Returns the auto resize mode. The default value is NO_AUTO_WRAPPING.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setAutoWrappingResizeMode(int)
  - setWrappingMode
```
public final void setWrappingMode(short value)
```
    Changes the wrapping mode of the text. The default value is IlvText.WRAP_NONE.
    Parameters:
    value - One of the following values or a combination:
    
    IlvText.WRAP_NONE : the text is displayed as-is.
    IlvText.WRAP_WORD : the text is automatically broken into lines using a line instance java.text.BreakIterator which will break the text where appropriate to best fit the getWrappingWidth() width. For example, in Latin languages this will break the text at white spaces. To prevent the text from being broken at a particular white space you should use the Unicode non-breaking white space (' ').
    IlvText.WRAP_CHARACTER : the text is automatically broken into characters using a character instance java.text.BreakIterator which will break the text where appropriate to best fit the getWrappingWidth() width. It will break the text at character boundaries.
    IlvText.WRAP_TRUNCATE : the text is automatically truncated such that it fits the getWrappingHeight() height and the getWrappingWidth() width. An ellipsis is added at the end of the truncated line.
  - getWrappingMode
```
public final short getWrappingMode()
```
    Returns the wrapping mode of the text. The default value is IlvText.WRAP_NONE.
    
    See Also:
    
    setWrappingMode(short)
  - setWrappingWidth
```
public final void setWrappingWidth(double width)
```
    Sets the wrapping width of the text. This value is used when getWrappingMode() is set to WRAP_WORD, WRAP_CHARACTER, WRAP_TRUNCATE or a combination of the these. The default value is 100. The value must be positive.
    
    Parameters:
    
    width - the new wrapping width
  - getWrappingWidth
```
public final double getWrappingWidth()
```
    Returns the wrapping width of the text. This value is used when getWrappingMode() is set to WRAP_WORD, WRAP_CHARACTER, WRAP_TRUNCATE or a combination of the these. The default value is 100.
  - setWrappingHeight
```
public final void setWrappingHeight(double height)
```
    Sets the wrapping height of the text. This value is used when getWrappingMode() is set to WRAP_WORD, WRAP_CHARACTER, WRAP_TRUNCATE or a combination of the these. The default value is 100. The value must be positive.
    
    Parameters:
    
    height - the new wrapping height
  - getWrappingHeight
```
public final double getWrappingHeight()
```
    Returns the wrapping height of the text. This value is used when getWrappingMode() is set to WRAP_WORD, WRAP_CHARACTER, WRAP_TRUNCATE or a combination of the these. The default value is 100.
  - setOutlineThickness
```
public void setOutlineThickness(double thickness)
```
    Changes the outline thickness of the text. The default value is 0.
    
    Parameters:
    
    thickness - The new outline thickness.
    
    Since:
    
    JViews 8.1
  - getOutlineThickness
```
public double getOutlineThickness()
```
    Returns the outline thickness of the text. The default value is 0.
    
    Since:
    
    JViews 8.1
  - setLeftMargin
```
public final void setLeftMargin(double margin)
```
    Sets the left margin of the box around the text. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager you should modify the parameter using the applyToObject method of the manager. The default value is 0.
  - getLeftMargin
```
public final double getLeftMargin()
```
    Returns the left margin of the box around the text. The default value is 0.
    
    See Also:
    
    setLeftMargin(double)
  - setRightMargin
```
public final void setRightMargin(double margin)
```
    Sets the right margin of the box around the text. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager you should modify the parameter using the applyToObject method of the manager. The default value is 0.
  - getRightMargin
```
public final double getRightMargin()
```
    Returns the right margin of the box around the text. The default value is 0.
    
    See Also:
    
    setRightMargin(double)
  - setTopMargin
```
public final void setTopMargin(double margin)
```
    Sets the top margin of the box around the text. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager you should modify the parameter using the applyToObject method of the manager. The default value is 0.
  - getTopMargin
```
public final double getTopMargin()
```
    Returns the top margin of the box around the text. The default value is 0.
    
    See Also:
    
    setTopMargin(double)
  - setBottomMargin
```
public final void setBottomMargin(double margin)
```
    Sets the bottom margin of the box around the text. Note that this may change its bounding rectangle. For this reason, if the object is contained inside a manager you should modify the parameter using the applyToObject method of the manager. The default value is 0.
  - getBottomMargin
```
public final double getBottomMargin()
```
    Returns the bottom margin of the box around the text. The default value is 0.
    
    See Also:
    
    setTopMargin(double)
  - setAlignment
```
public final void setAlignment(int alignment)
```
    Changes the alignment of the multilines text.
    Parameters:
    alignment - One of the following values:
    
    IlvConstants.LEFT: left aligned text
    IlvConstants.RIGHT: right aligned text.
    IlvConstants.CENTER: centered text.
    IlvConstants.LEADING: leading edge aligned text (the default).
    IlvConstants.TRAILING: trailing edge aligned text.
  - getAlignment
```
public final int getAlignment()
```
    Return the alignment of the multilines text.
    Returns:
    One of the following values:
    
    IlvConstants.LEFT: left aligned text
    IlvConstants.RIGHT: right aligned text.
    IlvConstants.CENTER: centered text.
    IlvConstants.LEADING: leading edge aligned text (the default).
    IlvConstants.TRAILING: trailing edge aligned text.
  - setRotationAlignmentThresholdAngle
```
public void setRotationAlignmentThresholdAngle(double angle)
```
    Sets the threshold angle that decides whether a rotated multiline text object is aligned parallel to the rotation alignment axis, or perpendicular to the rotation alignment axis. If the text object contains only a single line text, or if the text object is not rotated relative the rotation alignment axis, the threshold angle has no effect. Valid values are 0 (inclusive) to 90 degree (exclusive). If the threshold angle is set to 0, the rotation alignment axes are ignored and the multiline label is aligned canonically.
    An example explains the effect:
    Assume the rotation alignment angle is 0. An unrotated text object is by default aligned to the y axis. If the text object is rotated by 45 degree, its alignment axis is by default also rotated, that is, it is aligned to the axis obtained by rotating the y axis also by 45 degree. This is the canonical alignment. By setting the rotation alignment threshold to 40 degree, the text object is now aligned to the (unrotated) x axis (because 40 < 45). By setting the rotation alignment threshold to 50 degree, the text object is now aligned to the (unrotated) y axis (because 50 > 45).
    Now set the rotation alignment angle to 45. A text object that is rotated by 45 degree is now drawn exactly as in the canonical alignment, because it appears unrotated relatively to the rotation axes. However, an unrotated text object appears now rotated by 45 degree relative to the rotation axes. Hence it is now aligned to the x axis rotated by 45 degree if the threshold is larger than 45 degree, and to the y axis rotated by 45 degree if the threshold is smaller than 45 degree.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setRotationAlignmentAngle(double), getRotationAlignmentThresholdAngle()
  - getRotationAlignmentThresholdAngle
```
public final double getRotationAlignmentThresholdAngle()
```
    Returns the threshold angle that decides whether a rotated multiline text object is aligned parallel to the rotation alignment axis, or perpendicular to the rotation alignment axis. The angle is measured in degree (range 0 - 90).
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setRotationAlignmentThresholdAngle(double)
  - setRotationAlignmentAngle
```
public void setRotationAlignmentAngle(double angle)
```
    Sets the rotation alignment angle. It defines how the alignment option affects rotated multiline text. Basically, the rotation alignment angle specifies two axes, one parallel to this angle, and one perpendicular (orthogonal) to the angle. A multiline text object can be aligned to these axes. The rotation alignment threshold angle (see setRotationAlignmentThresholdAngle(double)) specified whether and which of both axes is used to align the multiple lines of text. Valid values are 0 (inclusive) to 180 degree (exclusive). If the rotation alignment threshold angle is 0, or if the text object contains only a single line text, or if the text object is not rotated relative to the rotation alignment axis, the rotation alignment angle has no effect.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setRotationAlignmentThresholdAngle(double), getRotationAlignmentAngle()
  - getRotationAlignmentAngle
```
public final double getRotationAlignmentAngle()
```
    Returns the rotation alignment angle. It defines how the alignment option affects rotated multiline text. The angle is measured in degree (range 0 - 360).
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setRotationAlignmentAngle(double)
  - setInterlineSpacing
```
public final void setInterlineSpacing(double spacing)
```
    Sets the interline spacing used when the text is displayed as several lines. The default and recommended value is -1 which means that the IlvText will let each line decide (IlvTextLayout.getLeading) what is the best interline spacing. It means you should use this method only if you want to override that behavior.
    
    Parameters:
    
    spacing - the new interline spacing or -1 for default behavior.
  - getInterlineSpacing
```
public final double getInterlineSpacing()
```
    Returns the interline spacing used when the text is displayed as several lines. By default the value is -1 which means that the IlvText will let each line decide (IlvTextLayout.getLeading) what is the best interline spacing.
    
    See Also:
    
    setInterlineSpacing(double)
  - contains
```
public boolean contains(IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer t)
```
    Tests if a point lies within the outline of the object.
    
    Overrides:
    
    contains in class IlvGraphic
    
    Parameters:
    
    p - The point to be tested.
    
    tp - The point p transformed by the transformer t.
    
    t - The transformation used to draw the object.
    
    Returns:
    
    true if the point lies inside this graphic object.
    
    See Also:
    
    IlvGraphic
  - getCaretShape
```
public Shape getCaretShape(IlvTextSelection.Range range,
                           IlvTransformer t)
```
    This method is called to get the shape enveloping the characters specified by the Range. The returned shape is used to draw the background of the selected characters. Therefore, users can see which characters are selected.
    In case the range is collapsed, this method will return a shape used to render the insertion caret.
    
    Specified by:
    
    getCaretShape in interface IlvTextInterface
    
    Parameters:
    
    range - The range indicates the selected characters.
    
    t - The transformer used while drawing the graphic object being edited.
    
    Returns:
    
    The shape used to highlight the selected characters.
    
    Since:
    
    JViews 7.5
  - pickCharacter
```
public int pickCharacter(IlvPoint click,
                         IlvTransformer t)
```
    This method is called when a user is clicking on the label to hit-test which character is clicked.
    
    Specified by:
    
    pickCharacter in interface IlvTextInterface
    
    Parameters:
    
    click - The position where the mouse is clicked, already transformed by the specified IlvTransformer.
    
    t - The transformer used while drawing the label.
    
    Returns:
    
    The index of the character on which the mouse is clicked. Returns -1, if there is no character there.
    
    Since:
    
    JViews 7.5
  - lineCount
```
public int lineCount()
```
    Returns the line count for a multiline text.
    
    Specified by:
    
    lineCount in interface IlvTextInterface
    
    Returns:
    
    The line count for multi-line text. For a single line text, the value 1 is returned.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    lineOffset(int)
  - lineOffset
```
public int lineOffset(int index)
```
    For a multiline label, you need to know the start offset for a specified line. This method helps to determine the line number for a given character. You need this method when you do navigation in the label with arrow keys. It tells you when you need to jump to the previous or next line.
    Single line label just returns 0.
    
    Specified by:
    
    lineOffset in interface IlvTextInterface
    
    Parameters:
    
    index - Specifies the line. The first line has index 0.
    
    Returns:
    
    The offset in that label. Returns 0 for single line label. Returns -1 if the specified index is out of range.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    lineCount()
  - makeSelection
```
public IlvSelection makeSelection()
```
    Create an IlvTextSelection.
    
    Overrides:
    
    makeSelection in class IlvGraphic
    
    Returns:
    
    An IlvTextSelection.
    
    See Also:
    
    IlvDrawSelection
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the contents of the IlvText to an IVL file.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Overrides:
    
    write in class IlvGraphic
    
    Parameters:
    
    stream - The output stream to write this graphic object to.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
  - SetTransformerDependentRendering
```
public static void SetTransformerDependentRendering(boolean flag)
```
    Sets whether all IlvText objects are rendered with a strategy that requires re-rendering when the transformer changes. This is slower and uses nearly twice as much memory per text object, but some Chinese and Japanese fonts cannot be rendered with the faster default strategy where the rendering is pre-calculated independent from the transformer. In JDK 1.4, the slow transformer dependent mode was not required. In JDK 1.5 and later, the slow mode might be required. This depends on the operating system, on the available fonts, and on the status of the Sun bug list related to Chinese and Japanese rendering.
    The default value is false.
    
    Since:
    
    JViews 8.1
  - IsTransformerDependentRendering
```
public static boolean IsTransformerDependentRendering()
```
    Returns whether all IlvText objects are rendered with a strategy that requires re-rendering when the transformer changes. This is slower and uses nearly twice as much memory per text object, but some Chinese and Japanese fonts cannot be rendered with the faster default strategy where the rendering is pre-calculated independent from the transformer.
    
    Since:
    
    JViews 8.1
  - usesBidiMarkers
```
public boolean usesBidiMarkers()
```
    Returns true if in-place editing implementation uses markers, which should be taken into account in hit-to-point and point-to-hit calculations.
    
    Overrides:
    
    usesBidiMarkers in class IlvGraphic
    
    Returns:
    
    Whether the in-place editing implementation uses markers.
    
    Since:
    
    JViews 8.8
  - isBaseTextDirectionSensitive
```
public boolean isBaseTextDirectionSensitive()
```
    Returns true because the bounding box of this object depends on its text direction.
    
    Overrides:
    
    isBaseTextDirectionSensitive in class IlvGraphic
    
    Returns:
    
    true
    
    Since:
    
    JViews 8.8
  - baseTextDirectionChanged
```
public void baseTextDirectionChanged(int oldBaseTextDirection,
                                     int newBaseTextDirection)
```
    Called when the object is base text direction sensitive and the resolved base text direction has changed.
    
    Overrides:
    
    baseTextDirectionChanged in class IlvGraphic
    
    Parameters:
    
    oldBaseTextDirection - Resolved base text direction of this object before the change.
    
    newBaseTextDirection - Resolved base text direction of this object after the change.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    isBaseTextDirectionSensitive()
  - componentOrientationChanged
```
public void componentOrientationChanged(ComponentOrientation oldOri,
                                        ComponentOrientation newOri)
```
    Called when the object is component orientation sensitive and the component orientation has changed.
    
    Overrides:
    
    componentOrientationChanged in class IlvGraphic
    
    Parameters:
    
    oldOri - Orientation of this object before the orientation change.
    
    newOri - Orientation of this object after the orientation change.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    IlvGraphic.isComponentOrientationSensitive()
  - isLocaleSensitive
```
public boolean isLocaleSensitive()
```
    Returns true if the bounding box of this object depends on the locale of this object.
    
    Overrides:
    
    isLocaleSensitive in class IlvGraphic
    
    Returns:
    
    Whether the bounding box of this object depends on the locale.
    
    Since:
    
    JViews 8.8
  - localeChanged
```
public void localeChanged(com.ibm.icu.util.ULocale oldLocale,
                          com.ibm.icu.util.ULocale newLocale)
```
    Called when the object is locale sensitive and the locale has changed.
    
    Overrides:
    
    localeChanged in class IlvGraphic
    
    Parameters:
    
    oldLocale - Locale of this object before the locale change.
    
    newLocale - Locale of this object after the locale change.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    isLocaleSensitive()

Class IlvText

Example

About Graphic Objects

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ilog.views.IlvBidiGraphic

Methods inherited from class ilog.views.IlvGraphic

Methods inherited from class java.lang.Object

Field Detail

OUTLINE_ONLY

OUTLINE_FRONT

OUTLINE_BACK

OUTLINE_DISABLED

WRAP_NONE

WRAP_WORD

WRAP_CHARACTER

WRAP_TRUNCATE

NO_AUTO_WRAPPING

SIZE_AUTO_WRAPPING

ZOOM_AUTO_WRAPPING

Constructor Detail

IlvText

IlvText

IlvText

IlvText

Method Detail

copy

draw

getTransformer

boundingBox

applyTransform

moveResize

translate

resize

rotate

setAnchorPoint

getAnchorPoint

getEffectiveAnchorPoint

setAnchorPosition

getAnchorPosition

getAnchorPoints

setLabel

getLabel

setAttributedLabel

getAttributedLabel

addLabelAttribute

addLabelAttribute

addLabelAttributes

supportMultiline

isTruncated

getLabelBBox

setFont

getFont

isAntialiasing

setAntialiasing

isStrikethrough

setStrikethrough

isUnderline

setUnderline

getOutlineMode

setOutlineMode

isFractionalMetrics

setFractionalMetrics

setForeground

getForeground

setOutlineColor

getOutlineColor

setBackground

setFillPaint

getFillPaint

adaptPaint

isPaintAbsolute

setPaintAbsolute

setFillOn

isFillOn

setStrokeOn

isStrokeOn

setStrokeColor