com.softwarefx.chartfx.server
Class BorderAttributes

java.lang.Object
  com.softwarefx.chartfx.server.BorderAttributes

public class BorderAttributes
extends Object

Provides access to the BorderAttributes object.

The members of the BorderAttributes Class allow customization of the border for PointAttributes and SeriesAttributes.

Some of the configurable attributes for Borders are setColor(java.awt.Color), setEffect(com.softwarefx.chartfx.server.BorderEffect), setStyle(com.softwarefx.DashStyle), setWidth(short), etc.

The border is the line around the point marker. The following example shows a chart with the series' borders set to a width of 3 and colored red:

The folowing image shows the same settings applied to an Area chart:

Constructor Summary

BorderAttributes()

Method Summary

Color	getColor() Gets the Color.
BorderEffect	getEffect() Gets the Effect.
DashStyle	getStyle() Gets the Style.
short	getWidth() Gets the Width.
boolean	isBetweenSegments() Gets the BetweenSegments.
boolean	isUseForLines() Gets the UseForLines.
boolean	isVisible() Gets the Visible.
void	setBetweenSegments(boolean value) Sets a property which makes the border to be shown between segments.
void	setColor(Color value) Sets the color of the border of a point marker.
void	setEffect(BorderEffect value) Sets the BorderEffect for the border of a point marker.
void	setStyle(DashStyle value) Represents the style of the line for the border of a point marker.
void	setUseForLines(boolean value) Sets a property which applies the Border Attributes to the lines of a Line Chart.
void	setVisible(boolean value) Sets a value making the border visible or not.
void	setWidth(short value) Sets a value in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

BorderAttributes

public BorderAttributes()

Method Detail

getColor

public Color getColor()

Gets the Color. For more detail see setColor(java.awt.Color).

getEffect

public BorderEffect getEffect()

Gets the Effect. For more detail see setEffect(com.softwarefx.chartfx.server.BorderEffect).

getStyle

public DashStyle getStyle()

Gets the Style. For more detail see setStyle(com.softwarefx.DashStyle).

getWidth

public short getWidth()

Gets the Width. For more detail see setWidth(short).

isBetweenSegments

public boolean isBetweenSegments()

Gets the BetweenSegments. For more detail see setBetweenSegments(boolean).

isUseForLines

public boolean isUseForLines()

Gets the UseForLines. For more detail see setUseForLines(boolean).

isVisible

public boolean isVisible()

Gets the Visible. For more detail see setVisible(boolean).

setBetweenSegments

public void setBetweenSegments(boolean value)

Sets a property which makes the border to be shown between segments.

Remarks:

For some gallery types, Area for example, turning the point markers border visible will generate the following efect on a chart:

When BetweenSegments is set to true, this will be the effect:

See Also:

PointAttributes, SeriesAttributes, GlobalAttributes

setColor

public void setColor(Color value)

Sets the color of the border of a point marker.

Remarks:

The setEffect(com.softwarefx.chartfx.server.BorderEffect) property must be set to BorderEffect.None for the Color property to have any effect on the selected item border.

For more information regarding the Color type, please refer to the Chart FX for Java Documentation.

See Also:

setStyle(com.softwarefx.DashStyle), setEffect(com.softwarefx.chartfx.server.BorderEffect), setWidth(short), PointAttributes, SeriesAttributes, GlobalAttributes

setEffect

public void setEffect(BorderEffect value)

Sets the BorderEffect for the border of a point marker.

Remarks:

The Effect property must be set to BorderEffect.NONE for the setColor(java.awt.Color) property to have any effect on the selected item border.

The following image shows the BorderEffect.SHADOW applied to a chart:

See Also:

setStyle(com.softwarefx.DashStyle), setColor(java.awt.Color), PointAttributes, SeriesAttributes, GlobalAttributes

setStyle

public void setStyle(DashStyle value)

Represents the style of the line for the border of a point marker.

Remarks:

The default value is DashStyle.SOLID.

See Also:

setEffect(com.softwarefx.chartfx.server.BorderEffect), PointAttributes, SeriesAttributes, GlobalAttributes

setUseForLines

public void setUseForLines(boolean value)

Sets a property which applies the Border Attributes to the lines of a Line Chart.

Remarks:

When applied to a Line Chart, Border Attributes will affect only the point markers, where the line will remain unchanged.

When setting UseForLines to true, the border attributes are applied to the line too:

See Also:

PointAttributes, SeriesAttributes, GlobalAttributes

setVisible

public void setVisible(boolean value)

Sets a value making the border visible or not.

Remarks:

A point marker Borders are Visible by default.

See Also:

setColor(java.awt.Color), setEffect(com.softwarefx.chartfx.server.BorderEffect), setStyle(com.softwarefx.DashStyle), PointAttributes, SeriesAttributes, GlobalAttributes

setWidth

public void setWidth(short value)

Sets a value in pixels.

Remarks:

This property allows you to configure the width for the border of a point marker.

See Also:

setColor(java.awt.Color), setStyle(com.softwarefx.DashStyle), setEffect(com.softwarefx.chartfx.server.BorderEffect), PointAttributes, SeriesAttributes, GlobalAttributes