ilog.views.chart.graphic

Class IlvGraphicDecoration

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

ilog.views.chart.graphic.IlvPositionableDecoration

ilog.views.chart.graphic.IlvGraphicDecoration

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, IlvGraphicBag, IlvComponentOrientationAware, IlvULocaleAware, IlvBaseTextDirectionInterface, Serializable, SwingConstants

public class IlvGraphicDecoration
extends IlvPositionableDecoration
implements IlvGraphicBag, IlvULocaleAware, IlvComponentOrientationAware, IlvBaseTextDirectionInterface

A class that displays an IlvGraphic, a graphic object in the JViews Framework sense, as a chart decoration. The decoration is positioned at an arbitrary fixed position in the chart.

Since:

JViews 8.5

See Also:

IlvChartDecoration, Serialized Form

Field Summary

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
IlvGraphicDecoration() Creates a new IlvGraphicDecoration object for displaying a graphic object.
IlvGraphicDecoration(IlvGraphic graphic) Creates a new IlvGraphicDecoration object displaying the specified graphic object centered within the plot area.
IlvGraphicDecoration(IlvGraphic graphic, int anchor) Creates a new IlvGraphicDecoration object displaying the specified graphic object.

Method Summary

Modifier and Type	Method and Description
void	addObject(IlvGraphic graphic, boolean redraw) Adds a graphic object to the bag.
void	applyToObject(IlvGraphic graphic, IlvApplyObject f, Object arg, boolean redraw) Applies a method to a graphic object of the bag.
protected void	baseTextDirectionChanged() This method is invoked when the effective base text direction of the chart has changed.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the decoration is added to or removed from a chart.
protected void	componentOrientationChanged(ComponentOrientation oldOrientation, ComponentOrientation newOrientation) This method is invoked when the component orientation of the chart has changed.
void	draw(Graphics g) Draws the decoration into the specified Graphics context.
int	getBaseTextDirection() Returns the base text direction of the chart to which this decoration belongs.
Rectangle2D	getBounds(Rectangle2D retBounds) Returns the bounds of this decoration.
ComponentOrientation	getComponentOrientation() Returns the component orientation of the chart to which this decoration belongs.
IlvGraphic	getGraphic() Returns the graphic object wrapped by this decoration.
IlvGraphicBag	getGraphicBag() Returns the IlvGraphicBag that contains this bag or null if it is not contained in any bag.
IlvGraphic	getObject(String name) Returns the graphic object with that name if it exists in the bag, otherwise returns null.
IlvGraphicEnumeration	getObjects() Returns an enumeration of all the objects in this graphic bag.
int	getResolvedBaseTextDirection() Returns the resolved base text direction of the chart to which this decoration belongs.
com.ibm.icu.util.ULocale	getULocale() Returns the locale of the chart to which this decoration belongs.
void	moveObject(IlvGraphic graphic, double x, double y, boolean redraw) Changes the location of a graphic object.
void	reDrawObj(IlvGraphic graphic) Redraws a graphic object located in the bag.
void	reDrawRegion(IlvRegion region) Redraws a region of the bag.
void	removeObject(IlvGraphic graphic, boolean redraw) Removes a graphic object from the bag.
void	reshapeObject(IlvGraphic graphic, IlvRect newrect, boolean redraw) Changes the size of a graphic object.
void	setBaseTextDirection(int btd) This method does nothing.
void	setComponentOrientation(ComponentOrientation orientation) This method does nothing.
void	setGraphic(IlvGraphic graphic) Sets the graphic object wrapped by this decoration.
boolean	setObjectName(IlvGraphic graphic, String name) Changes the name of a graphic object.
void	setULocale(com.ibm.icu.util.ULocale locale) This method does nothing.

Methods inherited from class ilog.views.chart.graphic.IlvPositionableDecoration

computeLocation, getAnchor, getLocation, getOffset, setAnchor, setOffset

Methods inherited from class ilog.views.chart.IlvChartDecoration

afterDraw, beforeDraw, getChart, getDrawOrder, has3DSupport, isVisible, repaint, setDrawOrder, setVisible, updateBoundsCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvGraphicDecoration

public IlvGraphicDecoration()

Creates a new IlvGraphicDecoration object for displaying a graphic object. The graphic object needs to be installed afterwards, using the setGraphic(ilog.views.IlvGraphic) method.

IlvGraphicDecoration

public IlvGraphicDecoration(IlvGraphic graphic)

Creates a new IlvGraphicDecoration object displaying the specified graphic object centered within the plot area.

Parameters:

graphic - The graphic object to display.

IlvGraphicDecoration

public IlvGraphicDecoration(IlvGraphic graphic,
                            int anchor)

Creates a new IlvGraphicDecoration object displaying the specified graphic object.

Parameters:

graphic - The graphic object to display.

anchor - The decoration's position within the plot area. One of the SwingConstants.CENTER, SwingConstants.NORTH, SwingConstants.NORTH_WEST, SwingConstants.WEST, SwingConstants.SOUTH_WEST, SwingConstants.SOUTH, SwingConstants.SOUTH_EAST, SwingConstants.EAST, SwingConstants.NORTH_EAST constants.

Method Detail

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when the decoration is added to or removed from a chart.

Overrides:

chartConnected in class IlvPositionableDecoration

Parameters:

oldChart - The chart with which the decoration was associated, or null if the decoration is added to a new chart.

newChart - The chart to which the decoration is added, or null if the decoration is removed from its current chart.

See Also:

IlvChartOwnedDrawable.getChart()

getGraphic

public final IlvGraphic getGraphic()

Returns the graphic object wrapped by this decoration.

See Also:

setGraphic(ilog.views.IlvGraphic)

setGraphic

public void setGraphic(IlvGraphic graphic)

Sets the graphic object wrapped by this decoration.

draw

public void draw(Graphics g)

Draws the decoration into the specified Graphics context.

Specified by:

draw in interface IlvChartDrawable

Specified by:

draw in class IlvChartDecoration

getBounds

public Rectangle2D getBounds(Rectangle2D retBounds)

Returns the bounds of this decoration.

Specified by:

getBounds in interface IlvChartDrawable

Specified by:

getBounds in class IlvPositionableDecoration

Parameters:

retBounds - A rectangle used to store the result. If this parameter is null, a new Rectangle2D is allocated.

Returns:

The bounds of this decoration.

addObject

public void addObject(IlvGraphic graphic,
                      boolean redraw)

Adds a graphic object to the bag.

Specified by:

addObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

removeObject

public void removeObject(IlvGraphic graphic,
                         boolean redraw)

Removes a graphic object from the bag.

Specified by:

removeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

getObjects

public IlvGraphicEnumeration getObjects()

Returns an enumeration of all the objects in this graphic bag. Note that, while using this enumeration, you must not add or remove any object in the bag; otherwise, going through this enumeration may return incorrect values or throw a ConcurrentModificationException. For multithread safety, it is useful to lock the manager's tree lock for the duration of the use of this enumeration.

Specified by:

getObjects in interface IlvGraphicBag

Returns:

An enumeration of IlvGraphic objects, or null.

reDrawObj

public void reDrawObj(IlvGraphic graphic)

Redraws a graphic object located in the bag.

Specified by:

reDrawObj in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

reDrawRegion

public void reDrawRegion(IlvRegion region)

Redraws a region of the bag.

Specified by:

reDrawRegion in interface IlvGraphicBag

Parameters:

region - The region to redraw.

reshapeObject

public void reshapeObject(IlvGraphic graphic,
                          IlvRect newrect,
                          boolean redraw)

Changes the size of a graphic object.

Specified by:

reshapeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

newrect - The new desired bounding rectangle.

redraw - If true the object is redrawn.

moveObject

public void moveObject(IlvGraphic graphic,
                       double x,
                       double y,
                       boolean redraw)

Changes the location of a graphic object.

Specified by:

moveObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

x - The new desired x position.

y - The new desired y position.

redraw - If true the object is redrawn.

applyToObject

public void applyToObject(IlvGraphic graphic,
                          IlvApplyObject f,
                          Object arg,
                          boolean redraw)

Applies a method to a graphic object of the bag. Every implementation of IlvGraphicBag.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) must call IlvGraphic.setInApplyToObject(boolean) in the following way:

 public void applyToObject(IlvGraphic obj,
                           IlvApplyObject f, Object arg,
                           boolean redraw)
 {
   obj.setInApplyToObject(true);
   try {
     ...
   } finally {
     obj.setInApplyToObject(false);
   }
 }
 

If an IlvGraphic implements the IlvGraphicBag interface, the implementation can be done in the following way:

 public void applyToObject(IlvGraphic obj,
                           IlvApplyObject f, Object arg,
                           boolean redraw)
 {
   boolean needsRecursion = obj.setInApplyToObject(true);
   try {
     if (needsRecursion && getGraphicBag() != null) {
       final IlvGraphic fobj = obj;
       final IlvApplyObject ff = f;
       getGraphicBag().applyToObject(this, new IlvApplyObject() {
          public void apply(IlvGraphic thisObj, Object arg) {
            doSomething(fobj, ff, arg, false);
          }
       }, arg, redraw);
     } else {
       doSomething(obj, f, arg, redraw);
     }
   } finally {
     obj.setInApplyToObject(false);
   }
 }
 

Specified by:

applyToObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

f - The method to apply.

arg - The arguments passed to the method f.

redraw - If true the object is redrawn.

setObjectName

public boolean setObjectName(IlvGraphic graphic,
                             String name)

Changes the name of a graphic object.

Specified by:

setObjectName in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

name - The new name.

Returns:

true if the name can be changed.

getObject

public IlvGraphic getObject(String name)

Returns the graphic object with that name if it exists in the bag, otherwise returns null.

Specified by:

getObject in interface IlvGraphicBag

Parameters:

name - The graphic object name.

getGraphicBag

public IlvGraphicBag getGraphicBag()

Returns the IlvGraphicBag that contains this bag or null if it is not contained in any bag.

Specified by:

getGraphicBag in interface IlvGraphicBag

getULocale

public com.ibm.icu.util.ULocale getULocale()

Returns the locale of the chart to which this decoration belongs.

Specified by:

getULocale in interface IlvULocaleAware

Since:

JViews 8.8

See Also:

IlvULocaleAware.setULocale(com.ibm.icu.util.ULocale)

setULocale

public void setULocale(com.ibm.icu.util.ULocale locale)

This method does nothing.

Specified by:

setULocale in interface IlvULocaleAware

Parameters:

locale - The new locale.

Since:

JViews 8.8

See Also:

getULocale()

getComponentOrientation

public ComponentOrientation getComponentOrientation()

Returns the component orientation of the chart to which this decoration belongs.

Specified by:

getComponentOrientation in interface IlvComponentOrientationAware

Since:

JViews 8.8

See Also:

IlvComponentOrientationAware.setComponentOrientation(java.awt.ComponentOrientation)

setComponentOrientation

public void setComponentOrientation(ComponentOrientation orientation)

This method does nothing.

Specified by:

setComponentOrientation in interface IlvComponentOrientationAware

Parameters:

orientation - The new component orientation.

Since:

JViews 8.8

See Also:

getComponentOrientation()

getBaseTextDirection

public int getBaseTextDirection()

Returns the base text direction of the chart to which this decoration belongs.

This implementation always throws an UnsupportedOperationException.

Specified by:

getBaseTextDirection in interface IlvBaseTextDirectionInterface

Returns:

The base text direction.

Since:

JViews 8.8

setBaseTextDirection

public void setBaseTextDirection(int btd)

This method does nothing.

Specified by:

setBaseTextDirection in interface IlvBaseTextDirectionInterface

Parameters:

btd - The base text direction.

Since:

JViews 8.8

See Also:

getBaseTextDirection()

getResolvedBaseTextDirection

public int getResolvedBaseTextDirection()

Returns the resolved base text direction of the chart to which this decoration belongs.

Specified by:

getResolvedBaseTextDirection in interface IlvBaseTextDirectionInterface

Returns:

The resolved base text direction.

Since:

JViews 8.8

See Also:

getBaseTextDirection()

componentOrientationChanged

protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)

This method is invoked when the component orientation of the chart has changed.

Overrides:

componentOrientationChanged in class IlvChartDecoration

Parameters:

oldOrientation - The component orientation before the change.

newOrientation - The component orientation after the change.

See Also:

Component.getComponentOrientation()

baseTextDirectionChanged

protected void baseTextDirectionChanged()

This method is invoked when the effective base text direction of the chart has changed. That is, it is invoked

1. when the value of chart.getResolvedBaseTextDirection() has changed, or
2. when the value of chart.getComponentOrientation() has changed and the value of chart.getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.

Overrides:

baseTextDirectionChanged in class IlvChartDecoration

See Also:

IlvChart.getResolvedBaseTextDirection(), Component.getComponentOrientation()