IlvShadowLabel (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.IlvGraphic
- - ilog.views.graphic.IlvRectangle
  - - ilog.views.graphic.IlvShadowRectangle
    - - ilog.views.graphic.IlvShadowLabel

All Implemented Interfaces:

IlvFontInterface, IlvLabelInterface, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable
```
public class IlvShadowLabel
extends IlvShadowRectangle
implements IlvFontInterface, IlvLabelInterface
```
IlvShadowLabel represents a labeled rectangle with a shadow.
The default values for an IlvShadowLabel instance are as follows:
- Foreground: Color.black
- Background: Color.black
- Width and Size: IlvRect(0, 0, 100, 100)
- Shadow thickness: 2
- Shadow position: IlvConstants.BOTTOM_RIGHT
- Font: IlvToolkit.defaultFont
The default foreground and background colors are black. You must change one of these colors for the label to be visible.

Note: calls to the following methods result in a RuntimeException being thrown:
- setCorners(int)
- setFillOn(boolean)
- setRadius(int)
- setStrokeOn(boolean)
Example

The following code example shows how to use an IlvShadowLabel in a simple Java application:
```
   IlvManager manager = new IlvManager();
   IlvShadowLabel myDefaultRect = new IlvShadowLabel();
   
   IlvShadowLabel myCustomRect = new IlvShadowLabel(
                                  new IlvRect(60,90,80,20), 
                                  "My Custom Shadow Label",
                                  6, IlvConstants.TOP_LEFT);
   myCustomRect.setForeground(Color.blue);
   myCustomRect.setBackground(Color.yellow);
   myCustomRect.setFont(new Font("SansSerif", Font.BOLD, 14));
   
   manager.addObject( myDefaultRect, true);
   manager.addObject( myCustomRect, true);
 
```
The following image shows the graphic objects created in the code example:

About Graphic Objects

IlvShadowLabel 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.
See Also:

IlvRect, IlvManager, IlvManagerView, Serialized Form

Field Summary
- Fields inherited from class ilog.views.graphic.IlvRectangle
  BOTTOM_LEFT, BOTTOM_RIGHT, drawrect, TOP_LEFT, TOP_RIGHT

Constructor Summary

Constructors
Constructor and Description
`IlvShadowLabel()` Creates a new `IlvShadowLabel` with a `(0, 0, 100, 100)` definition rectangle, an empty label, a thickness of 2 and a `IlvConstants.BOTTOM_RIGHT` shadow position.
`IlvShadowLabel(IlvInputStream stream)` Reads the object from an `IlvInputStream`.
`IlvShadowLabel(IlvPoint at, String label, double thickness, double hMargin, double vMargin, int shadowPosition)` Creates a new `IlvShadowLabel` at a specified position and with specified label, thickness, margins, and shadow position.
`IlvShadowLabel(IlvRect rect, String label, double thickness, int shadowPosition)` Creates a new `IlvShadowLabel` with a specified definition rectangle, label, thickness, and shadow position.
`IlvShadowLabel(IlvShadowLabel source)` Creates a new `IlvShadowLabel` by copying an existing one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`baseTextDirectionChanged(int oldBaseTextDirection, int newBaseTextDirection)` Called when the object is base text direction sensitive and the resolved base text direction has changed.
`void`	`componentOrientationChanged(ComponentOrientation oldOri, ComponentOrientation newOri)` Called when the object is component orientation sensitive and the component orientation has changed.
`IlvGraphic`	`copy()` Copies the object.
`protected void`	`drawContent(Graphics dst, IlvRect rect, IlvTransformer t)` Draws the inner part of the object.
`void`	`drawLabel(Graphics dst, IlvRect rect, IlvTransformer t)` Draws the label inside the shadow rectangle.
`void`	`fitToLabel(double hMargin, double vMargin)` Recomputes the size of the object according to the current label and using the specified horizontal and vertical margins.
`int`	`getBaseTextDirection()` Returns the base direction of the text.
`ComponentOrientation`	`getComponentOrientation()` Returns the component orientation of this object.
`Font`	`getFont()` Returns the font of the object.
`String`	`getLabel()` Returns the label of the object.
`IlvRect`	`getLabelBBox(IlvTransformer t)` Returns the bounding area within which the label is displayed.
`int`	`getResolvedBaseTextDirection()` Returns the resolved base text direction.
`protected void`	`invalidateBidiCache()` Mark internal caches for locale, component orientation and base text direction invalid.
`boolean`	`isAntialiasing()` Returns `true` if the anti-aliasing mode of the text is on.
`boolean`	`isBaseTextDirectionSensitive()` Returns `true` because the bounding box of this object depends on its text direction.
`void`	`setAntialiasing(boolean set)` Changes the anti-aliasing mode of the text.
`void`	`setBaseTextDirection(int baseTextDirection)` Changes the base direction of the text.
`void`	`setFont(Font font)` Changes the font of the object.
`void`	`setLabel(String label)` Changes the label of the object.
`boolean`	`supportMultiline()` Returns `false` since this object does not support multiline text.
`String`	`toString()` Returns a string representation of the graphic 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 object to an `IlvOutputStream`.

Methods inherited from class ilog.views.graphic.IlvShadowRectangle
draw, getShadowPosition, getThickness, setCorners, setFillOn, setRadius, setShadowPosition, setStrokeOn, setThickness

Methods inherited from class ilog.views.graphic.IlvRectangle
applyTransform, boundingBox, contains, getBackground, getCorners, getDefinitionRect, getForeground, getIntersectionWithOutline, getRadius, isCornersZoomable, isFillOn, isStrokeOn, moveResize, resize, setBackground, setCornersZoomable, setDefinitionRect, setForeground, translate

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

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

- Constructor Detail
  - IlvShadowLabel
```
public IlvShadowLabel()
```
    Creates a new IlvShadowLabel with a (0, 0, 100, 100) definition rectangle, an empty label, a thickness of 2 and a IlvConstants.BOTTOM_RIGHT shadow position.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    IlvShadowLabel(IlvRect, String, double, int)
  - IlvShadowLabel
```
public IlvShadowLabel(IlvRect rect,
                      String label,
                      double thickness,
                      int shadowPosition)
```
    Creates a new IlvShadowLabel with a specified definition rectangle, label, thickness, and shadow position.
    
    Parameters:
    
    rect - The definition rectangle of the object.
    
    label - The label.
    
    thickness - The thickness of the shadow.
    
    shadowPosition - The position of the shadow. Valid values are IlvConstants.TOP_LEFT, IlvConstants.BOTTOM_LEFT, IlvConstants.TOP_RIGHT, and IlvConstants.BOTTOM_RIGHT.
    
    See Also:
    
    setLabel(java.lang.String), IlvShadowRectangle.setThickness(double), IlvShadowRectangle.setShadowPosition(int)
  - IlvShadowLabel
```
public IlvShadowLabel(IlvPoint at,
                      String label,
                      double thickness,
                      double hMargin,
                      double vMargin,
                      int shadowPosition)
```
    Creates a new IlvShadowLabel at a specified position and with specified label, thickness, margins, and shadow position. This constructor computes the definition rectangle of the object using the method fitToLabel(double, double), which preserves the specified margins around the label.
    
    Parameters:
    
    at - The upper-left point of the object.
    
    label - The label.
    
    thickness - The thickness of the shadow.
    
    hMargin - The margin that is preserved on the left and right sides of the label.
    
    vMargin - The margin that is preserved on the top and bottom sides of the label.
    
    shadowPosition - The position of the shadow. Valid values are IlvConstants.TOP_LEFT, IlvConstants.BOTTOM_LEFT, IlvConstants.TOP_RIGHT, and IlvConstants.BOTTOM_RIGHT.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    setLabel(java.lang.String), IlvShadowRectangle.setThickness(double), IlvShadowRectangle.setShadowPosition(int), fitToLabel(double, double)
  - IlvShadowLabel
```
public IlvShadowLabel(IlvShadowLabel source)
```
    Creates a new IlvShadowLabel by copying an existing one.
    
    Parameters:
    
    source - The copied object.
  - IlvShadowLabel
```
public IlvShadowLabel(IlvInputStream stream)
               throws IlvReadFileException
```
    Reads the object from an IlvInputStream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if the format is not correct.
- Method Detail
  - copy
```
public IlvGraphic copy()
```
    Copies the object. This method copies the object by calling the copy constructor.
    
    Overrides:
    
    copy in class IlvShadowRectangle
    
    Returns:
    
    A copy of the object.
    
    See Also:
    
    IlvGraphic
  - getLabel
```
public String getLabel()
```
    Returns the label of the object.
    
    Specified by:
    
    getLabel in interface IlvLabelInterface
  - setLabel
```
public void setLabel(String label)
```
    Changes the label of the object.
    
    Specified by:
    
    setLabel in interface IlvLabelInterface
  - fitToLabel
```
public void fitToLabel(double hMargin,
                       double vMargin)
```
    Recomputes the size of the object according to the current label and using the specified horizontal and vertical margins.
    The width of the definition rectangle of the object is set to the width of the current label plus twice the horizontal margin. The height of the definition rectangle of the object is set to the height of the current label plus twice the vertical margin. The upper-left corner of the definition rectangle is not moved.
    Note that if the object is contained inside a manager, you should call this method using the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean).
    
    Parameters:
    
    hMargin - The margin to be preserved on the left and right sides of the bounding box of the label.
    
    vMargin - The margin to be preserved on the top and bottom sides of the bounding box of the label.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    getLabel()
  - getFont
```
public Font getFont()
```
    Returns the font of the object.
    
    Specified by:
    
    getFont in interface IlvFontInterface
  - setFont
```
public void setFont(Font font)
```
    Changes the font of the object.
    
    Specified by:
    
    setFont in interface IlvFontInterface
    
    Parameters:
    
    font - The new font.
  - getComponentOrientation
```
public ComponentOrientation getComponentOrientation()
```
    Returns the component orientation of this object. Note that this object may be sensitive to the component orientation if the base text direction depends on the component orientation.
    
    Overrides:
    
    getComponentOrientation in class IlvGraphic
    
    Returns:
    
    The component orientation of this object.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    IlvGraphic.isComponentOrientationSensitive()
  - setBaseTextDirection
```
public void setBaseTextDirection(int baseTextDirection)
```
    Changes the base direction of the text. The possible choices are:
    - IlvBidiUtil.INHERITED_DIRECTION: the base text direction is inherited from the graphic bag that contains this object. If this object is not contained in a graphic bag, the base text direction is calculated from the component orientation.
    - IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is calculated from the component orientation.
    - IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
    - IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
    - IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.
    Specified by:
    
    setBaseTextDirection in interface IlvBaseTextDirectionInterface
    
    Overrides:
    
    setBaseTextDirection in class IlvGraphic
    
    Parameters:
    
    baseTextDirection - The base text direction
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    IlvGraphic.baseTextDirectionChanged(int, int)
  - getBaseTextDirection
```
public int getBaseTextDirection()
```
    Returns the base direction of the text. The possible return values are:
    - IlvBidiUtil.INHERITED_DIRECTION: the base text direction is inherited from the graphic bag that contains this object. If this object is not contained in a graphic bag, the base text direction is calculated from the component orientation.
    - IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is calculated from the component orientation.
    - IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
    - IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
    - IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.
    Specified by:
    
    getBaseTextDirection in interface IlvBaseTextDirectionInterface
    
    Overrides:
    
    getBaseTextDirection in class IlvGraphic
    
    Returns:
    
    The base text direction.
    
    Since:
    
    JViews 8.8
  - getResolvedBaseTextDirection
```
public int getResolvedBaseTextDirection()
```
    Returns the resolved base text direction.
    This method is similar to getBaseTextDirection() but determines the value when it is inherited from a parent component (IlvBidiUtil.INHERITED_DIRECTION) or dependent on the component orientation (IlvBidiUtil.COMPONENT_DIRECTION). Hence, there are only 3 possible return values:
    - IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
    - IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
    - IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.
    Specified by:
    
    getResolvedBaseTextDirection in interface IlvBaseTextDirectionInterface
    
    Overrides:
    
    getResolvedBaseTextDirection in class IlvGraphic
    
    Returns:
    
    The resolved base text direction.
    
    Since:
    
    JViews 8.8
  - invalidateBidiCache
```
protected void invalidateBidiCache()
```
    Mark internal caches for locale, component orientation and base text direction invalid.
    
    Overrides:
    
    invalidateBidiCache in class IlvGraphic
    
    Since:
    
    JViews 8.8
  - 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()
  - isAntialiasing
```
public final boolean isAntialiasing()
```
    Returns true if the anti-aliasing mode of the text is on.
  - setAntialiasing
```
public final void setAntialiasing(boolean set)
```
    Changes the anti-aliasing mode of the text. Changing this mode may change the bounding box of the object.
  - supportMultiline
```
public boolean supportMultiline()
```
    Returns false since this object does not support multiline text.
    
    Specified by:
    
    supportMultiline in interface IlvLabelInterface
  - getLabelBBox
```
public IlvRect getLabelBBox(IlvTransformer t)
```
    Returns the bounding area within which the label is displayed.
    
    Specified by:
    
    getLabelBBox in interface IlvLabelInterface
    
    Parameters:
    
    t - The transformer used to draw the object.
  - drawLabel
```
public void drawLabel(Graphics dst,
                      IlvRect rect,
                      IlvTransformer t)
```
    Draws the label inside the shadow rectangle.
    
    Parameters:
    
    dst - The destination Graphics.
    
    rect - The rectangle defining the inner part of the shadow rectangle (that is, the bounding box with the relief shadow removed). Note that this rectangle is already transformed by the transformer used to draw the object.
    
    t - The transformation used to draw the object.
  - drawContent
```
protected void drawContent(Graphics dst,
                           IlvRect rect,
                           IlvTransformer t)
```
    Draws the inner part of the object. It overrides the method drawContent of the class IlvShadowRectangle to draw the label of the object.
    
    Overrides:
    
    drawContent in class IlvShadowRectangle
    
    Parameters:
    
    dst - The Graphics to perform the drawing.
    
    rect - The rectangle defining the inner part of the shadow rectangle (that is, the bounding box with the relief shadow removed). Note that this rectangle is already transformed by the transformer used to draw the object.
    
    t - The transformer used to draw the object.
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Overrides:
    
    write in class IlvShadowRectangle
    
    Parameters:
    
    stream - The output stream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
  - toString
```
public String toString()
```
    Returns a string representation of the graphic object. The method returns a string which is the concatenation of the string returned by IlvGraphic.toString() with the label (see getLabel()).
    
    Overrides:
    
    toString in class IlvGraphic
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    IlvGraphic.getName()

Class IlvShadowLabel

Example

About Graphic Objects

Field Summary

Fields inherited from class ilog.views.graphic.IlvRectangle

Constructor Summary

Method Summary

Methods inherited from class ilog.views.graphic.IlvShadowRectangle

Methods inherited from class ilog.views.graphic.IlvRectangle

Methods inherited from class ilog.views.IlvGraphic

Methods inherited from class java.lang.Object

Constructor Detail

IlvShadowLabel

IlvShadowLabel

IlvShadowLabel

IlvShadowLabel

IlvShadowLabel

Method Detail

copy

getLabel

setLabel

fitToLabel

getFont

setFont

getComponentOrientation

setBaseTextDirection

getBaseTextDirection

getResolvedBaseTextDirection

invalidateBidiCache

usesBidiMarkers

isBaseTextDirectionSensitive

baseTextDirectionChanged

componentOrientationChanged

isAntialiasing

setAntialiasing

supportMultiline

getLabelBBox

drawLabel

drawContent

write

toString