IlvHTMLText (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.IlvGraphic
- - ilog.views.graphic.IlvHTMLText

All Implemented Interfaces:

IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable
```
public class IlvHTMLText
extends IlvGraphic
```
IlvHTMLText represents a piece of text specified as a HTML string.
Note: The setForeground method has no effect in this class. In order to set the text color, you can use
- Either the color style attribute of the <body> element. Example: <body style="color: #FF5010;">
- Or the text attribute of the <body> tag. Example: <body text="#FF5010">. (Deprecated.)
The default text color is black.
Note: The setBackground method has no effect in this class. In order to set the background color, you can use
- Either the background-color style attribute of the <body> element. Example: <body style="background-color: #663333;">
- Or the bgcolor attribute of the <body> tag. Example: <body bgcolor="#663333">. (Deprecated.)
The default background color is none, that is, transparent.
Limitations:
- This class does not support input elements (forms).
- The only transforms that it supports are zooms and translations. No shearing, no rotation.
- HTML constructs that are not supported by the Swing HTML renderer are not supported by this class either. For example:
  - Blinking through the CSS declaration text-decoration: blink is unsupported.
  - Changing the bidi base text direction of a piece of text through the attributes dir="rtl" or dir="ltr" is unsupported. Instead, you have to use the Unicode control characters LRE (‪), RLE (‫), and PDF (‬).
  - JavaScript, Flash, and applets are unsupported.
  - HTML 5 features (video, audio, and more) are unsupported.
Since:

JViews 8.8

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvHTMLText()` Creates an initially empty HTML text.
`IlvHTMLText(IlvInputStream stream)` Creates an `IlvHTMLText` instance from the contents of an `IlvInputStream`.
`IlvHTMLText(String htmlText)` Creates a HTML text that displays a given HTML string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHTMLInteractionListener(HTMLInteractionListener listener)` Adds an interaction listener to this object.
`void`	`applyTransform(IlvTransformer t)` Applies an additional transformation to the rendering of the `IlvHTMLText`.
`IlvRect`	`boundingBox(IlvTransformer t)` Returns the bounding rectangle of this `IlvHTMLText`.
`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 this `IlvHTMLText` instance.
`void`	`draw(Graphics g, IlvTransformer t)` Draws this `IlvHTMLText` object.
`double`	`getBottomMargin()` Returns the bottom margin of the box around the text.
`Font`	`getDefaultFont()` Returns the default font used for rendering text.
`String`	`getHTMLText()` Returns the HTML string that is displayed by this `IlvHTMLText` object.
`double`	`getLeftMargin()` Returns the left margin of the box around the text.
`double`	`getPageWidth()` Returns the page width.
`double`	`getRightMargin()` Returns the right margin of the box around the text.
`double`	`getTopMargin()` Returns the top margin of the box around the text.
`boolean`	`isAntiAliasing()` Returns `true` if the anti-aliasing mode of the text is on.
`boolean`	`isFractionalMetrics()` Returns `true` if the fractional metrics mode of the text is on.
`void`	`processMouseClicked(MouseEvent event, IlvTransformer transformToView)` This method is invoked when a mouse click on this object happened.
`void`	`removeHTMLInteractionListener(HTMLInteractionListener listener)` Removes an interaction listener from this object.
`void`	`setAntiAliasing(boolean set)` Changes the anti-aliasing mode of the text.
`void`	`setBottomMargin(double margin)` Sets the bottom margin of the box around the text.
`void`	`setDefaultFont(Font font)` Changes the default font used for rendering text.
`void`	`setFractionalMetrics(boolean set)` Changes the fractional metrics mode of the text.
`void`	`setHTMLText(String text)` Sets the HTML string that is displayed by this `IlvHTMLText` object.
`void`	`setLeftMargin(double margin)` Sets the left margin of the box around the text.
`void`	`setPageWidth(double pageWidth)` Sets the page width.
`void`	`setRightMargin(double margin)` Sets the right margin of the box around the text.
`void`	`setTopMargin(double margin)` Sets the top margin of the box around the text.
`void`	`write(IlvOutputStream stream)` Writes the contents of this `IlvHTMLText` to an IVL file.

Methods inherited from class ilog.views.IlvGraphic
addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, makeSelection, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setForeground, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved, zoomable

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

- Constructor Detail
  - IlvHTMLText
```
public IlvHTMLText()
```
    Creates an initially empty HTML text.
  - IlvHTMLText
```
public IlvHTMLText(String htmlText)
```
    Creates a HTML text that displays a given HTML string.
    
    Parameters:
    
    htmlText - A string in HTML syntax. The <html> and <body> tags are optional.
  - IlvHTMLText
```
public IlvHTMLText(IlvInputStream stream)
            throws IlvReadFileException
```
    Creates an IlvHTMLText instance from the contents of an IlvInputStream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if the format is not correct.
- Method Detail
  - getHTMLText
```
public String getHTMLText()
```
    Returns the HTML string that is displayed by this IlvHTMLText object.
    
    Returns:
    
    A string.
  - setHTMLText
```
public void setHTMLText(String text)
```
    Sets the HTML string that is displayed by this IlvHTMLText object.
    
    Parameters:
    
    text - A string in HTML syntax. The <html> and <body> tags are optional.
  - 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 IlvHTMLText but may lead to less precise text positioning.
  - setFractionalMetrics
```
public 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 IlvHTMLText but may lead to less precise text positioning.
    Note that this method call may change the 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.
  - isAntiAliasing
```
public final boolean isAntiAliasing()
```
    Returns true if the anti-aliasing mode of the text is on. The default value is false.
  - setAntiAliasing
```
public void setAntiAliasing(boolean set)
```
    Changes the anti-aliasing mode of the text. The default value is false.
    Note that this method call may change the 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.
  - getDefaultFont
```
public Font getDefaultFont()
```
    Returns the default font used for rendering text.
  - setDefaultFont
```
public void setDefaultFont(Font font)
```
    Changes the default font used for rendering text. The default value is a 12-point font.
    Note that this method call may change the 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.
  - getPageWidth
```
public double getPageWidth()
```
    Returns the page width. This is the maximum desired width of this object (in manager coordinates). Line breaking is used to enforce this page width. A width of 0 is interpreted as no limitation on width; it triggers no line breaking.
  - setPageWidth
```
public void setPageWidth(double pageWidth)
```
    Sets the page width. This is the maximum desired width of this object (in manager coordinates). Line breaking is used to enforce this page width. A width of 0 is interpreted as no limitation on width; it triggers no line breaking.
    The default value is 800.
    Note that this method call may change the 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.
  - getLeftMargin
```
public final double getLeftMargin()
```
    Returns the left margin of the box around the text. The default value is 0.
    
    See Also:
    
    setLeftMargin(double)
  - setLeftMargin
```
public void setLeftMargin(double margin)
```
    Sets the left margin of the box around the text. The default value is 0.
    Note that this margin is not filled with the background color. If you want a margin that is filled with the background color, use the margin-left and background-color style attributes of the <body> element. Example: <body style="background-color: #663333; margin-left:10px;">
    Note that this method call may change the 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.
  - getRightMargin
```
public final double getRightMargin()
```
    Returns the right margin of the box around the text. The default value is 0.
    
    See Also:
    
    setRightMargin(double)
  - setRightMargin
```
public void setRightMargin(double margin)
```
    Sets the right margin of the box around the text. The default value is 0.
    Note that this margin is not filled with the background color. If you want a margin that is filled with the background color, use the margin-right and background-color style attributes of the <body> element. Example: <body style="background-color: #663333; margin-right:10px;">
    Note that this method call may change the 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.
  - getTopMargin
```
public final double getTopMargin()
```
    Returns the top margin of the box around the text. The default value is 0.
    
    See Also:
    
    setTopMargin(double)
  - setTopMargin
```
public void setTopMargin(double margin)
```
    Sets the top margin of the box around the text. The default value is 0.
    Note that this margin is not filled with the background color. If you want a margin that is filled with the background color, use the margin-top and background-color style attributes of the <body> element. Example: <body style="background-color: #663333; margin-top:10px;">
    Note that this method call may change the 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.
  - getBottomMargin
```
public final double getBottomMargin()
```
    Returns the bottom margin of the box around the text. The default value is 0.
    
    See Also:
    
    setTopMargin(double)
  - setBottomMargin
```
public void setBottomMargin(double margin)
```
    Sets the bottom margin of the box around the text. The default value is 0.
    Note that this margin is not filled with the background color. If you want a margin that is filled with the background color, use the margin-bottom and background-color style attributes of the <body> element. Example: <body style="background-color: #663333; margin-bottom:10px;">
    Note that this method call may change the 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.
  - copy
```
public IlvGraphic copy()
```
    Returns a copy of this IlvHTMLText instance.
    
    Specified by:
    
    copy in class IlvGraphic
    
    Returns:
    
    A copy of this IlvGraphic instance.
    
    See Also:
    
    IlvGraphic
  - draw
```
public void draw(Graphics g,
                 IlvTransformer t)
```
    Draws this IlvHTMLText object.
    
    Specified by:
    
    draw in class IlvGraphic
    
    Parameters:
    
    g - The destination Graphics.
    
    t - The view transformation used to draw the object.
    
    See Also:
    
    IlvGraphic.callDraw(Graphics,IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvGraphic.zoomable(), IlvGraphic
  - boundingBox
```
public IlvRect boundingBox(IlvTransformer t)
```
    Returns the bounding rectangle of this IlvHTMLText.
    
    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
  - 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
  - applyTransform
```
public void applyTransform(IlvTransformer t)
```
    Applies an additional transformation to the rendering of the IlvHTMLText. 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
  - processMouseClicked
```
public void processMouseClicked(MouseEvent event,
                                IlvTransformer transformToView)
```
    This method is invoked when a mouse click on this object happened.
    You should normally not call this method.
  - addHTMLInteractionListener
```
public void addHTMLInteractionListener(HTMLInteractionListener listener)
```
    Adds an interaction listener to this object.
  - removeHTMLInteractionListener
```
public void removeHTMLInteractionListener(HTMLInteractionListener listener)
```
    Removes an interaction listener from this object.
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the contents of this IlvHTMLText 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.

Class IlvHTMLText

Constructor Summary

Method Summary

Methods inherited from class ilog.views.IlvGraphic

Methods inherited from class java.lang.Object

Constructor Detail

IlvHTMLText

IlvHTMLText

IlvHTMLText

Method Detail

getHTMLText

setHTMLText

isFractionalMetrics

setFractionalMetrics

isAntiAliasing

setAntiAliasing

getDefaultFont

setDefaultFont

getPageWidth

setPageWidth

getLeftMargin

setLeftMargin

getRightMargin

setRightMargin

getTopMargin

setTopMargin

getBottomMargin

setBottomMargin

copy

draw

boundingBox

contains

applyTransform

processMouseClicked

addHTMLInteractionListener

removeHTMLInteractionListener

write