netcharts.pro.charts.pie
Class NFPieHighlight

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFGradient
          netcharts.pro.common.NFHighlight
              netcharts.pro.charts.pie.NFPieHighlight

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFPieHighlight
extends NFHighlight
implements NFCDLGenerator

A class representing a highlight applied to the pie.

Field Summary

static double	DEFAULT_ANGLE
static double	DEFAULT_EXTENT
static double	DEFAULT_GAP
static int	DEFAULT_TYPE
static int	GRADIENTANGLED

Fields inherited from class netcharts.pro.common.NFHighlight

GRADIENTBDIAG, GRADIENTCENTERHORIZONTAL, GRADIENTCENTERVERTICAL, GRADIENTFDIAG, GRADIENTHORIZONTAL, GRADIENTRADIAL, GRADIENTVERTICAL, NONE

Constructor Summary

NFPieHighlight()

Method Summary

double	getAngle() Get the angle to center the highlight on as it extends across the pie.
java.lang.String	getCDL() Generate CDL parameters representing this pie highlight
double	getExtent() Get the extent of the highlight.
double	getGap() Get the gap between the edge of the pie and the highlight.
void	setAngle(double angle) Set the angle to center the highlight on as it extends across the pie.
void	setCDL(java.lang.Object cdlObject) Configures this object from a CDL parameter object.
void	setCDL(java.lang.String cdl) Configures this object from a CDL parameter representation.
void	setExtent(double extent) Set the extent of the highlight.
void	setGap(double gap) Set the gap between the edge of the pie and the highlight.

Methods inherited from class netcharts.pro.common.NFHighlight

getType, setType

Methods inherited from class netcharts.pro.common.NFGradient

getStart, getStop, setStart, setStop

Methods inherited from class netcharts.pro.common.NFBaseClass

clone, getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface netcharts.pro.common.NFCDLGenerator

toString

Field Detail

GRADIENTANGLED

public static final int GRADIENTANGLED

DEFAULT_TYPE

public static final int DEFAULT_TYPE

DEFAULT_ANGLE

public static final double DEFAULT_ANGLE

DEFAULT_GAP

public static final double DEFAULT_GAP

DEFAULT_EXTENT

public static final double DEFAULT_EXTENT

Constructor Detail

NFPieHighlight

public NFPieHighlight()

Method Detail

getAngle

public double getAngle()

Get the angle to center the highlight on as it extends across the pie.

Returns:

The angle in degrees.

setAngle

public void setAngle(double angle)

Set the angle to center the highlight on as it extends across the pie.

Parameters:

angle - The angle in degrees.

getGap

public double getGap()

Get the gap between the edge of the pie and the highlight. A fractional value between 0 and 1 represents the percentage of the width of the pie to use as the gap. A non fractional value greater than or equal to 1 represents the number of pixels to use for the gap.

Returns:

The gap as a percentage or number of pixels.

setGap

public void setGap(double gap)

Set the gap between the edge of the pie and the highlight. A fractional value between 0 and 1 represents the percentage of the width of the pie to use as the gap. A non fractional value greater than or equal to 1 represents the number of pixels to use for the gap.

Parameters:

gap - The gap as a percentage or number of pixels.

getExtent

public double getExtent()

Get the extent of the highlight. This is the distance from the start of the highlight on one side of the pie to the end of the highlight. A fractional value between 0 and 1 represents the percentage of the width of the pie to use as the extent. A non fractional value greater than or equal to 1 represents the number of pixels to use for the extent. A value of -1 means use the available diameter of the pie (after the gap is applied) for the extent.

Returns:

The extent as a percentage or number of pixels or -1.

setExtent

public void setExtent(double extent)

Set the extent of the highlight. This is the distance from the start of the highlight on one side of the pie to the end of the highlight. A fractional value between 0 and 1 represents the percentage of the width of the pie to use as the extent. A non fractional value greater than or equal to 1 represents the number of pixels to use for the extent. A value of -1 means use the available diameter of the pie (after the gap is applied) for the extent.

Parameters:

extent - The extent as a percentage or number of pixels or -1.

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this pie highlight

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (type, start, stop, angle, gap, extent)

setCDL

public void setCDL(java.lang.Object cdlObject)

Configures this object from a CDL parameter object.

Parameters:

cdlObject - CDL in a String form or in a user object.

setCDL

public void setCDL(java.lang.String cdl)

Configures this object from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in the form: (type, start, stop, angle, gap, extent)