netcharts.pro.common.barset
Class NFBarHighlight

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFGradient
          netcharts.pro.common.NFHighlight
              netcharts.pro.common.barset.NFBarHighlight

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFBarHighlight
extends NFHighlight
implements NFCDLGenerator

A class representing a highlight applied to a bar.

Field Summary

static double	DEFAULT_BOTTOM_GAP
static double	DEFAULT_HEIGHT
static double	DEFAULT_LEFT_GAP
static double	DEFAULT_RIGHT_GAP
static double	DEFAULT_TOP_GAP
static int	DEFAULT_TYPE
static double	DEFAULT_WIDTH

Fields inherited from class netcharts.pro.common.NFHighlight

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

Constructor Summary

NFBarHighlight()

Method Summary

double	getBottomGap() Get the gap between the bottom of the highlighted object and the highlight.
java.lang.String	getCDL() Generate CDL parameters representing this bar highlight
NFCorners	getCorners() Get the corners of the bar highlight
double	getHeight() Get the height of the highlight.
double	getLeftGap() Get the gap between the left of the highlighted object and the highlight.
double	getRightGap() Get the gap between the right of the highlighted object and the highlight.
double	getTopGap() Get the gap between the top of the highlighted object and the highlight.
double	getWidth() Get the width of the highlight.
void	setBottomGap(double bottomGap) Set the gap between the bottom of the highlighted object and 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	setCorners(NFCorners corners) Set the corners of the bar highlight
void	setHeight(double height) Set the height of the highlight.
void	setLeftGap(double leftGap) Set the gap between the left of the highlighted object and the highlight.
void	setRightGap(double rightGap) Set the gap between the right of the highlighted object and the highlight.
void	setTopGap(double topGap) Set the gap between the top of the highlighted object and the highlight.
void	setWidth(double width) Set the width of 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

DEFAULT_TYPE

public static final int DEFAULT_TYPE

DEFAULT_TOP_GAP

public static final double DEFAULT_TOP_GAP

DEFAULT_BOTTOM_GAP

public static final double DEFAULT_BOTTOM_GAP

DEFAULT_LEFT_GAP

public static final double DEFAULT_LEFT_GAP

DEFAULT_RIGHT_GAP

public static final double DEFAULT_RIGHT_GAP

DEFAULT_WIDTH

public static final double DEFAULT_WIDTH

DEFAULT_HEIGHT

public static final double DEFAULT_HEIGHT

Constructor Detail

NFBarHighlight

public NFBarHighlight()

Method Detail

getTopGap

public double getTopGap()

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

Returns:

The top gap as a percentage or number of pixels.

setTopGap

public void setTopGap(double topGap)

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

Parameters:

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

getBottomGap

public double getBottomGap()

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

Returns:

The bottom gap as a percentage or number of pixels.

setBottomGap

public void setBottomGap(double bottomGap)

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

Parameters:

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

getLeftGap

public double getLeftGap()

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

Returns:

The left gap as a percentage or number of pixels.

setLeftGap

public void setLeftGap(double leftGap)

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

Parameters:

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

getRightGap

public double getRightGap()

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

Returns:

The right gap as a percentage or number of pixels.

setRightGap

public void setRightGap(double rightGap)

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

Parameters:

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

getWidth

public double getWidth()

Get the width of the highlight. A fractional value between 0 and 1 represents the percentage of the width of the highlighted object to use as the width. A non fractional value greater than or equal to 1 represents the number of pixels to use for the width. A value of -1 means use all the available width.

Returns:

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

setWidth

public void setWidth(double width)

Set the width of the highlight. A fractional value between 0 and 1 represents the percentage of the width of the highlighted object to use as the width. A non fractional value greater than or equal to 1 represents the number of pixels to use for the width. A value of -1 means use all the available width.

Parameters:

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

getHeight

public double getHeight()

Get the height of the highlight. A fractional value between 0 and 1 represents the percentage of the height of the highlighted object to use as the height. A non fractional value greater than or equal to 1 represents the number of pixels to use for the height. A value of -1 means use all the available height.

Returns:

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

setHeight

public void setHeight(double height)

Set the height of the highlight. A fractional value between 0 and 1 represents the percentage of the height of the highlighted object to use as the height. A non fractional value greater than or equal to 1 represents the number of pixels to use for the height. A value of -1 means use all the available height.

Parameters:

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

setCorners

public void setCorners(NFCorners corners)

Set the corners of the bar highlight

Parameters:

corners - The corners of the bar highlight

getCorners

public NFCorners getCorners()

Get the corners of the bar highlight

Returns:

The corners of the bar highlight

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this bar highlight

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (type, start, stop, topGap, rightGap, bottomGap, leftGap, width, height, topLeftCorner, topRightCorner, bottomRightCorner, bottomLeftCorner)

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, topGap, rightGap, bottomGap, leftGap, width, height, topLeftCorner, topRightCorner, bottomRightCorner, bottomLeftCorner)