ilog.views.chart

Class IlvChartAreaSynchronizer

java.lang.Object

ilog.views.chart.IlvChartAreaSynchronizer

All Implemented Interfaces:

Serializable

public class IlvChartAreaSynchronizer
extends Object
implements Serializable

A class to synchronize a chart area with another component. When a chart is synchronized, the chart area internal margins will be automatically computed so that the plotting rectangle is perfectly aligned with the target component in a specified direction.

Since:

JViews 5.0

See Also:

IlvChart.synchronizeAxis(IlvChart, int, boolean), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HORIZONTAL The type to synchronize horizontal margins
static int	VERTICAL The type to synchronize vertical margins

Constructor Summary

Constructors

Constructor and Description
IlvChartAreaSynchronizer(int type) Creates a new IlvChartAreaSynchronizer object of the specified type.

Method Summary

Modifier and Type	Method and Description
IlvChart	getChart() Returns the synchronized chart.
Component	getTargetComponent() Returns the target component.
void	plug(IlvChart chart, Component targetComp) Synchronizes the specified chart with the specified target component.
static void	synchronize(IlvChart chart, Component targetComponent) Synchronizes the horizontal margins of the chart area of the specified chart with the specified component.
static void	synchronize(IlvChart chart, Component targetComponent, IlvChartAreaSynchronizer sync) Synchronizes the specified chart with the specified component, using the provided synchronizer.
void	unplug() Ends the current synchronization.
static IlvChartAreaSynchronizer	unSynchronize(IlvChart chart) Unsynchronizes the specified chart.

Methods inherited from class java.lang.Object

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

Field Detail

HORIZONTAL

public static final int HORIZONTAL

The type to synchronize horizontal margins

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

The type to synchronize vertical margins

See Also:

Constant Field Values

Constructor Detail

IlvChartAreaSynchronizer

public IlvChartAreaSynchronizer(int type)

Creates a new IlvChartAreaSynchronizer object of the specified type.

Parameters:

type - The margins to synchronize.

See Also:

VERTICAL, HORIZONTAL

Method Detail

getChart

public final IlvChart getChart()

Returns the synchronized chart.

getTargetComponent

public final Component getTargetComponent()

Returns the target component.

plug

public void plug(IlvChart chart,
                 Component targetComp)

Synchronizes the specified chart with the specified target component. The synchronized margins are determined according to the type of this synchronizer.

unplug

public void unplug()

Ends the current synchronization.

synchronize

public static void synchronize(IlvChart chart,
                               Component targetComponent)

Synchronizes the horizontal margins of the chart area of the specified chart with the specified component. This method creates a new IlvChartAreaSynchronizer instance of the HORIZONTAL type.

See Also:

synchronize(IlvChart, Component, IlvChartAreaSynchronizer)

synchronize

public static void synchronize(IlvChart chart,
                               Component targetComponent,
                               IlvChartAreaSynchronizer sync)

Synchronizes the specified chart with the specified component, using the provided synchronizer.

unSynchronize

public static IlvChartAreaSynchronizer unSynchronize(IlvChart chart)

Unsynchronizes the specified chart.

See Also:

synchronize(IlvChart, Component)