netcharts.pro.common.rectangular
Class NFGridBackground

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFRegion
          netcharts.pro.common.rectangular.NFGridBackground

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFGridBackground
extends NFRegion
implements NFCDLGenerator

This object is used to define a grid's background color or image properties. It extends NFRegion although Grid's ignore border type and width attributes.

Field Summary

Fields inherited from class netcharts.pro.common.NFRegion

borderTypeMap, BOX, CENTER, CORNER_ROUND, CORNER_SNIP, CORNER_SQUARE, cornerTypeMap, imageLayoutMap, NONE, RAISED, RECESS, SHADOW, SIZE, TILE

Constructor Summary

NFGridBackground()

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this region
void	getCDL(java.lang.StringBuffer sb, boolean includeParens) Append CDL parameters representing this grid background to the given StringBuffer.
java.awt.Color	getLineColor() Return the line color
java.util.Vector	getObjects() Returns object vector of region elements
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	setCDL(java.lang.String[] elements, int offset) Configures this object from a CDL parameter representation.
void	setLineColor(java.awt.Color color) Set the line color
java.lang.String	toString() Returns a new String object representing this grid background.

Methods inherited from class netcharts.pro.common.NFRegion

getBorderColor, getBorderType, getBorderWidth, getBottomLeftCornerType, getBottomRightCornerType, getCornerOverhangColor, getFillColor, getImage, getImageFormat, getImageURL, getTopLeftCornerType, getTopRightCornerType, setBorderColor, setBorderType, setBorderWidth, setBottomLeftCornerType, setBottomRightCornerType, setCornerOverhangColor, setFillColor, setImage, setImageFormat, setImageURL, setTopLeftCornerType, setTopRightCornerType

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, wait, wait, wait

Constructor Detail

NFGridBackground

public NFGridBackground()

Method Detail

setLineColor

public void setLineColor(java.awt.Color color)

Set the line color

Parameters:

color - Color object

getLineColor

public java.awt.Color getLineColor()

Return the line color

Returns:

the line color or null if not defined.

setCDL

public void setCDL(java.lang.Object cdlObject)

Configures this object from a CDL parameter object.

Overrides:

setCDL in class NFRegion

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

Overrides:

setCDL in class NFRegion

Parameters:

cdl - CDL in the form: (lineColor, fillColor, borderColor, "imageURL", imageFormat)

setCDL

public void setCDL(java.lang.String[] elements,
                   int offset)

Configures this object from a CDL parameter representation.

Overrides:

setCDL in class NFRegion

Parameters:

elements - Array of parameter elements. This array is expected to contain consecutive elements containing lineColor, fillColor, borderColor, imageURL, and imageFormat information.

offset - Offset into the elements array.

toString

public java.lang.String toString()

Returns a new String object representing this grid background.

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class NFRegion

Returns:

A new String object in the same form as that given by getCDL().

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this region

Specified by:

getCDL in interface NFCDLGenerator

Overrides:

getCDL in class NFRegion

Returns:

CDL in the form: (lineColor, fillColor, borderColor, "imageURL", imageFormat)

getCDL

public void getCDL(java.lang.StringBuffer sb,
                   boolean includeParens)

Append CDL parameters representing this grid background to the given StringBuffer.

Overrides:

getCDL in class NFRegion

Parameters:

sb - Target buffer to append the CDL parameters

includeParens - If true, this will cause the parameters to be delimited with parenthesis.

getObjects

public java.util.Vector getObjects()

Description copied from class: NFRegion

Returns object vector of region elements

Overrides:

getObjects in class NFRegion

Returns:

objects