netcharts.pro.common
Class NFCircularEdgeHighlight

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFGradient
          netcharts.pro.common.NFCircularEdgeHighlight

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

Direct Known Subclasses:

NFPieEdgeHighlight

public class NFCircularEdgeHighlight
extends NFGradient
implements NFCDLGenerator

A class representing a gradient that extends inward from the edge of a circle.

Field Summary

static double	DEFAULT_GAP
static double	DEFAULT_SIZE

Constructor Summary

NFCircularEdgeHighlight()

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this edge highlight
double	getGap() Get the gap between the edge of the circle and the edge highlight.
double	getSize() Set the size of the highlight.
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	setGap(double gap) Set the gap between the edge of the circle and the edge highlight.
void	setSize(double size) Get the size of the highlight.

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

DEFAULT_GAP

public static final double DEFAULT_GAP

DEFAULT_SIZE

public static final double DEFAULT_SIZE

Constructor Detail

NFCircularEdgeHighlight

public NFCircularEdgeHighlight()

Method Detail

getGap

public double getGap()

Get the gap between the edge of the circle and the edge highlight. A fractional value between 0 and 1 represents the percentage of the circle width 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 circle and the edge highlight. A fractional value between 0 and 1 represents the percentage of the circle width 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.

getSize

public double getSize()

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

Parameters:

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

setSize

public void setSize(double size)

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

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this edge highlight

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (start, stop, gap, size)

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: (start, stop, gap, size)