netcharts.pro.common
Class NFDropShadow

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFDropShadow

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFDropShadow
extends NFBaseClass
implements NFCDLGenerator

A class representing a drop shadow.

Field Summary

static double	DEFAULT_OFFSET_X
static double	DEFAULT_OFFSET_Y
static double	DEFAULT_SIZE

Constructor Summary

NFDropShadow()

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this drop shadow
java.awt.Color	getColor() Get the color of the drop shadow.
double	getOffsetX() Get the offset of the x coordinate of the drop shadow.
double	getOffsetY() Get the offset of the y coordinate of the drop shadow.
double	getSize() Get the size of the drop shadow blur.
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	setColor(java.awt.Color color) Set the color of the drop shadow.
void	setOffsetX(double offsetX) Set the offset of the x coordinate of the drop shadow.
void	setOffsetY(double offsetY) Set the offset of the y coordinate of the drop shadow.
void	setSize(double size) Set the size of the drop shadow blur.

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_OFFSET_X

public static final double DEFAULT_OFFSET_X

DEFAULT_OFFSET_Y

public static final double DEFAULT_OFFSET_Y

DEFAULT_SIZE

public static final double DEFAULT_SIZE

Constructor Detail

NFDropShadow

public NFDropShadow()

Method Detail

getColor

public java.awt.Color getColor()

Get the color of the drop shadow.

Returns:

The color of the drop shadow

setColor

public void setColor(java.awt.Color color)

Set the color of the drop shadow.

Parameters:

color - The color of the drop shadow

getOffsetX

public double getOffsetX()

Get the offset of the x coordinate of the drop shadow. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the x offset.

Returns:

The x offset as a percentage or number of pixels.

setOffsetX

public void setOffsetX(double offsetX)

Set the offset of the x coordinate of the drop shadow. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the x offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the x offset.

Parameters:

offsetX - The x offset as a percentage or number of pixels.

getOffsetY

public double getOffsetY()

Get the offset of the y coordinate of the drop shadow. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the y offset.

Returns:

The y offset as a percentage or number of pixels.

setOffsetY

public void setOffsetY(double offsetY)

Set the offset of the y coordinate of the drop shadow. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the y offset. A non fractional value greater than or equal to 1 represents the number of pixels to use for the y offset.

Parameters:

offsetY - The y offset as a percentage or number of pixels.

getSize

public double getSize()

Get the size of the drop shadow blur. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the blur size. A non fractional value greater than or equal to 1 represents the number of pixels to use for the blur size.

Returns:

The blur size as a percentage or number of pixels.

setSize

public void setSize(double size)

Set the size of the drop shadow blur. A fractional value between 0 and 1 represents the percentage of the width of the shadowed object to use as the blur size. A non fractional value greater than or equal to 1 represents the number of pixels to use for the blur size.

Parameters:

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

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this drop shadow

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (color, offsetX, offsetY, 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: (color, offsetX, offsetY, size)