ilog.views.chart

Class IlvLegendSeparator

java.lang.Object

ilog.views.chart.IlvLegendSeparator

All Implemented Interfaces:

Serializable, Border

public class IlvLegendSeparator
extends Object
implements Border, Serializable

A border that draws a separator line between a chart legend and the chart area.

Since:

JViews 5.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvLegendSeparator() Creates a legend separator with a thickness equal to 1, a null color, and no margin.
IlvLegendSeparator(Color color, int thickness) Creates a legend separator with the specified color and thickness
IlvLegendSeparator(Color color, int thickness, int insideMargin, int outsideMargin) Creates a new legend separator.
IlvLegendSeparator(int thickness) Creates a legend separator with the specified thickness, a null color, and no margin.
IlvLegendSeparator(int thickness, int insideMargin, int outsideMargin) Creates a legend separator with a null color.

Method Summary

Modifier and Type	Method and Description
Insets	getBorderInsets(Component c) Returns the insets of the border.
Color	getColor() Returns the color of the separator.
int	getInsideMargin() Returns the inside margin.
int	getOutsideMargin() Returns the outside margin.
int	getThickness() Returns the thickness of the separator.
boolean	isBorderOpaque() Returns whether or not the border is opaque.
void	paintBorder(Component c, Graphics g, int x, int y, int width, int height) Paints the border for the specified component with the specified position and size.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvLegendSeparator

public IlvLegendSeparator()

Creates a legend separator with a thickness equal to 1, a null color, and no margin.

IlvLegendSeparator

public IlvLegendSeparator(int thickness)

Creates a legend separator with the specified thickness, a null color, and no margin.

Parameters:

thickness - The thickness of the separator.

IlvLegendSeparator

public IlvLegendSeparator(Color color,
                          int thickness)

Creates a legend separator with the specified color and thickness

Parameters:

color - The color of the separator. If null, the foreground of the legend is used.

thickness - The thickness of the separator.

IlvLegendSeparator

public IlvLegendSeparator(int thickness,
                          int insideMargin,
                          int outsideMargin)

Creates a legend separator with a null color.

Parameters:

thickness - The thickness of the separator.

insideMargin - The margin between the legend and the separator.

outsideMargin - The margin between the separator and the chart area. This margin is only taken into account if the legend is docked to the chart (that is, the position is not absolute).

IlvLegendSeparator

public IlvLegendSeparator(Color color,
                          int thickness,
                          int insideMargin,
                          int outsideMargin)

Creates a new legend separator.

Parameters:

color - The color of the separator. If null, the foreground of the legend is used.

thickness - The thickness of the separator.

insideMargin - The margin between the legend and the separator.

outsideMargin - The margin between the separator and the chart area. This margin is only taken into account if the legend is docked to the chart (that is, the position is not absolute).

Method Detail

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)

Paints the border for the specified component with the specified position and size.

Specified by:

paintBorder in interface Border

Parameters:

c - the component for which this border is being painted

g - the paint graphics

x - the x position of the painted border

y - the y position of the painted border

width - the width of the painted border

height - the height of the painted border

getBorderInsets

public Insets getBorderInsets(Component c)

Returns the insets of the border.

Specified by:

getBorderInsets in interface Border

Parameters:

c - The component for which this border insets value applies.

Returns:

The insets of the border.

isBorderOpaque

public boolean isBorderOpaque()

Returns whether or not the border is opaque.

Specified by:

isBorderOpaque in interface Border

getOutsideMargin

public int getOutsideMargin()

Returns the outside margin.

Returns:

The margin between the separator and the chart area. This margin is only taken into account if the legend is docked to the chart (that is, the position is not absolute).

getInsideMargin

public int getInsideMargin()

Returns the inside margin.

Returns:

The margin between the legend and the separator.

getColor

public Color getColor()

Returns the color of the separator.

Returns:

The color of the separator. If null, the foreground of the legend is used.

getThickness

public int getThickness()

Returns the thickness of the separator.

Returns:

The thickness of the separator.